<back to all web services

ContactPropertiesRequestDto

The following routes are available for this service:
GET/RestApi/sitefinity/data-intelligence/contact-properties
"use strict";
export class ContactPropertiesRequestDto {
    /** @param {{Filter?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Filter;
}
/** @typedef {number} */
export var ContactPropertyState;
(function (ContactPropertyState) {
    ContactPropertyState[ContactPropertyState["Initialized"] = 1] = "Initialized"
    ContactPropertyState[ContactPropertyState["Processing"] = 2] = "Processing"
    ContactPropertyState[ContactPropertyState["Active"] = 3] = "Active"
    ContactPropertyState[ContactPropertyState["Updated"] = 4] = "Updated"
    ContactPropertyState[ContactPropertyState["Deleted"] = 5] = "Deleted"
    ContactPropertyState[ContactPropertyState["Error"] = 6] = "Error"
    ContactPropertyState[ContactPropertyState["HiddenInUI"] = 7] = "HiddenInUI"
})(ContactPropertyState || (ContactPropertyState = {}));
export class ContactPropertyAlias {
    /** @param {{Id?:string,PropId?:string,Name?:string,Priority?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Id;
    /** @type {string} */
    PropId;
    /** @type {string} */
    Name;
    /** @type {number} */
    Priority;
}
export class ContactProperty {
    /** @param {{Id?:string,DatacenterId?:string,IsIdentifier?:boolean,IsIndexed?:boolean,DataVolumeRank?:number,Order?:number,Name?:string,ColumnName?:string,TableName?:string,State?:ContactPropertyState,DataType?:number,Aliases?:IList<ContactPropertyAlias>}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Id;
    /** @type {string} */
    DatacenterId;
    /** @type {boolean} */
    IsIdentifier;
    /** @type {boolean} */
    IsIndexed;
    /** @type {?number} */
    DataVolumeRank;
    /** @type {number} */
    Order;
    /** @type {string} */
    Name;
    /** @type {string} */
    ColumnName;
    /** @type {string} */
    TableName;
    /** @type {ContactPropertyState} */
    State;
    /** @type {number} */
    DataType;
    /** @type {IList<ContactPropertyAlias>} */
    Aliases;
}
export class ContactPropertiesViewModel {
    /** @param {{ContactProperties?:IList<ContactProperty>,DecAppUrl?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {IList<ContactProperty>} */
    ContactProperties;
    /** @type {string} */
    DecAppUrl;
}

JavaScript ContactPropertiesRequestDto DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /RestApi/sitefinity/data-intelligence/contact-properties HTTP/1.1 
Host: www.asg.com.au 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	DecAppUrl: String
}