digitaluapi

LookupCampaignCustomers

The following routes are available for this service:
GET	/campaign/customers/	Get Campaign Customers


// @DataContract
export class QueryBase
{
    // @DataMember(Order=1)
    public Skip?: number;

    // @DataMember(Order=2)
    public Take?: number;

    // @DataMember(Order=3)
    public OrderBy: string;

    // @DataMember(Order=4)
    public OrderByDesc: string;

    // @DataMember(Order=5)
    public Include: string;

    // @DataMember(Order=6)
    public Fields: string;

    // @DataMember(Order=7)
    public Meta: { [index:string]: string; };

    public constructor(init?: Partial<QueryBase>) { (Object as any).assign(this, init); }
}

export class QueryDb<T> extends QueryBase
{

    public constructor(init?: Partial<QueryDb<T>>) { super(init); (Object as any).assign(this, init); }
}

export class CampaignCustomersView
{
    // @DataMember(Order=1)
    public Id?: number;

    // @DataMember(Order=2)
    public Name: string;

    // @DataMember(Order=3)
    public Description: string;

    // @DataMember(Order=4)
    public CustomersId?: number;

    // @DataMember(Order=5)
    public FirstName: string;

    // @DataMember(Order=6)
    public LastName: string;

    // @DataMember(Order=7)
    public IdNumber: string;

    // @DataMember(Order=8)
    public PassportNumber: string;

    // @DataMember(Order=9)
    public Email: string;

    // @DataMember(Order=10)
    public MobileNumber: string;

    // @DataMember(Order=11)
    public CustomerUniqueIdentifier: string;

    // @DataMember(Order=12)
    public CustomerPublicAccessGuid?: string;

    // @DataMember(Order=13)
    public CampaignPublicAccessGuid?: string;

    // @DataMember(Order=14)
    public TenantsId?: number;

    public constructor(init?: Partial<CampaignCustomersView>) { (Object as any).assign(this, init); }
}

export class LookupCampaignCustomers extends QueryDb<CampaignCustomersView>
{

    public constructor(init?: Partial<LookupCampaignCustomers>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class QueryResponse<T>
{
    // @DataMember(Order=1)
    public Offset: number;

    // @DataMember(Order=2)
    public Total: number;

    // @DataMember(Order=3)
    public Results: CampaignCustomersView[];

    // @DataMember(Order=4)
    public Meta: { [index:string]: string; };

    // @DataMember(Order=5)
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<QueryResponse<T>>) { (Object as any).assign(this, init); }
}

TypeScript LookupCampaignCustomers 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 /campaign/customers/ 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,"Name":"String","Description":"String","CustomersId":0,"FirstName":"String","LastName":"String","IdNumber":"String","PassportNumber":"String","Email":"String","MobileNumber":"String","CustomerUniqueIdentifier":"String","CustomerPublicAccessGuid":"00000000000000000000000000000000","CampaignPublicAccessGuid":"00000000000000000000000000000000","TenantsId":0}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}