digitaluapi

<back to all web services

CustomersSegmentsAutoQueryLookup

The following routes are available for this service:
GET/auto/customerssegments/{Id}
GET/auto/customerssegments
"use strict";
export class QueryBase {
    /** @param {{Skip?:number,Take?:number,OrderBy?:string,OrderByDesc?:string,Include?:string,Fields?:string,Meta?:{ [index:string]: string; }}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?number} */
    Skip;
    /** @type {?number} */
    Take;
    /** @type {string} */
    OrderBy;
    /** @type {string} */
    OrderByDesc;
    /** @type {string} */
    Include;
    /** @type {string} */
    Fields;
    /** @type {{ [index:string]: string; }} */
    Meta;
}
/** @typedef T {any} */
export class QueryDb extends QueryBase {
    /** @param {{Skip?:number,Take?:number,OrderBy?:string,OrderByDesc?:string,Include?:string,Fields?:string,Meta?:{ [index:string]: string; }}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}
export class CustomersSegments {
    /** @param {{Id?:number,TenantsId?:number,CustomersId?:number,SegmentsId?:number,PublicAccessGuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {number} */
    TenantsId;
    /** @type {number} */
    CustomersId;
    /** @type {number} */
    SegmentsId;
    /** @type {string} */
    PublicAccessGuid;
}
export class CustomersSegmentsAutoQueryLookup extends QueryDb {
    /** @param {{Skip?:number,Take?:number,OrderBy?:string,OrderByDesc?:string,Include?:string,Fields?:string,Meta?:{ [index:string]: string; }}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}
export class CampaignCustomersView {
    /** @param {{Id?:number,Name?:string,Description?:string,CustomersId?:number,FirstName?:string,LastName?:string,IdNumber?:string,PassportNumber?:string,Email?:string,MobileNumber?:string,CustomerUniqueIdentifier?:string,CustomerPublicAccessGuid?:string,CampaignPublicAccessGuid?:string,TenantsId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?number} */
    Id;
    /** @type {string} */
    Name;
    /** @type {string} */
    Description;
    /** @type {?number} */
    CustomersId;
    /** @type {string} */
    FirstName;
    /** @type {string} */
    LastName;
    /** @type {string} */
    IdNumber;
    /** @type {string} */
    PassportNumber;
    /** @type {string} */
    Email;
    /** @type {string} */
    MobileNumber;
    /** @type {string} */
    CustomerUniqueIdentifier;
    /** @type {?string} */
    CustomerPublicAccessGuid;
    /** @type {?string} */
    CampaignPublicAccessGuid;
    /** @type {?number} */
    TenantsId;
}
/** @typedef T {any} */
export class QueryResponse {
    /** @param {{Offset?:number,Total?:number,Results?:T[],Meta?:{ [index:string]: string; },ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Offset;
    /** @type {number} */
    Total;
    /** @type {T[]} */
    Results;
    /** @type {{ [index:string]: string; }} */
    Meta;
    /** @type {ResponseStatus} */
    ResponseStatus;
}

JavaScript CustomersSegmentsAutoQueryLookup DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /auto/customerssegments/{Id} HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Offset":0,"Total":0,"Results":[{"Id":0,"TenantsId":0,"CustomersId":0,"SegmentsId":0,"PublicAccessGuid":"00000000000000000000000000000000"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}