digitaluapi

SegmentsAutoQueryLookup

**Requires Authentication**
Requires the role:	Client

The following routes are available for this service:
GET	/auto/segments/{Id}
GET	/auto/segments

"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 Segments {
    /** @param {{Id?:number,TenantsId?:number,Name?:string,IsCustom?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {number} */
    TenantsId;
    /** @type {string} */
    Name;
    /** @type {?boolean} */
    IsCustom;
}
export class SegmentsAutoQueryLookup extends QueryDb {
    /** @param {{Id?:number,TenantsId?:number,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) }
    /** @type {?number} */
    Id;
    /** @type {number} */
    TenantsId;
}
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 SegmentsAutoQueryLookup DTOs

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

HTTP + CSV

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

GET /auto/segments/{Id} HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Offset":0,"Total":0,"Results":[{"Id":0,"TenantsId":0,"Name":"String","IsCustom":false}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}