digitaluapi

<back to all web services

LookupCampaignCustomers

// @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

GET /campaign/customers/ HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml

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

<QueryResponseOfCampaignCustomersViewqTGWvAI3 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Offset>0</Offset>
  <Total>0</Total>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel.Types">
    <d2p1:CampaignCustomersView>
      <d2p1:CampaignPublicAccessGuid>00000000-0000-0000-0000-000000000000</d2p1:CampaignPublicAccessGuid>
      <d2p1:CustomerPublicAccessGuid>00000000-0000-0000-0000-000000000000</d2p1:CustomerPublicAccessGuid>
      <d2p1:CustomerUniqueIdentifier>String</d2p1:CustomerUniqueIdentifier>
      <d2p1:CustomersId>0</d2p1:CustomersId>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:Email>String</d2p1:Email>
      <d2p1:FirstName>String</d2p1:FirstName>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:IdNumber>String</d2p1:IdNumber>
      <d2p1:LastName>String</d2p1:LastName>
      <d2p1:MobileNumber>String</d2p1:MobileNumber>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:PassportNumber>String</d2p1:PassportNumber>
      <d2p1:TenantsId>0</d2p1:TenantsId>
    </d2p1:CampaignCustomersView>
  </Results>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </ResponseError>
    </Errors>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
  </ResponseStatus>
</QueryResponseOfCampaignCustomersViewqTGWvAI3>