digitaluapi

<back to all web services

CampaignCustomerVerificationsRequest

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
GET/campaign/verifications/{PublicAccessGuid}/Campaign Verification Responses
"use strict";
export class CampaignCustomerVerificationsDetailView {
    /** @param {{Id?:number,CurrenciesId?:number,CurrencyName?:string,Address?:string,Age?:number,City?:string,ContactNumber?:string,Email?:string,EthnicGroup?:string,FirstName?:string,Gender?:string,HomeLanguage?:string,IdNumber?:string,LastName?:string,PostalCode?:string,Region?:string,Suburb?:string,UniqueIdentifier?:string,BirthDate?:string,Country?:string,PassportNumber?:string,UpdatedAddress?:string,UpdatedAge?:number,UpdatedCity?:string,UpdatedContactNumber?:string,UpdatedEmail?:string,UpdatedEthnicGroup?:string,UpdatedFirstName?:string,UpdatedGender?:string,UpdatedHomeLanguage?:string,UpdatedIdNumber?:string,UpdatedLastName?:string,UpdatedPostalCode?:string,UpdatedRegion?:string,UpdatedSuburb?:string,UpdatedUniqueIdentifier?:string,UpdatedBirthDate?:string,UpdatedCountry?:string,UpdatedPassportNumber?:string,StatusCodesId?:number,StatusCodesDescription?:string,Reason?:string,CustomersId?:number,CampaignsId?:number,CapturedDate?:string,UpdatedIdUrl?:string,UpdatedPassportUrl?:string,UpdatedAddressUrl?:string,CampaignPublicAccessGuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?number} */
    Id;
    /** @type {?number} */
    CurrenciesId;
    /** @type {string} */
    CurrencyName;
    /** @type {string} */
    Address;
    /** @type {?number} */
    Age;
    /** @type {string} */
    City;
    /** @type {string} */
    ContactNumber;
    /** @type {string} */
    Email;
    /** @type {string} */
    EthnicGroup;
    /** @type {string} */
    FirstName;
    /** @type {string} */
    Gender;
    /** @type {string} */
    HomeLanguage;
    /** @type {string} */
    IdNumber;
    /** @type {string} */
    LastName;
    /** @type {string} */
    PostalCode;
    /** @type {string} */
    Region;
    /** @type {string} */
    Suburb;
    /** @type {string} */
    UniqueIdentifier;
    /** @type {?string} */
    BirthDate;
    /** @type {string} */
    Country;
    /** @type {string} */
    PassportNumber;
    /** @type {string} */
    UpdatedAddress;
    /** @type {?number} */
    UpdatedAge;
    /** @type {string} */
    UpdatedCity;
    /** @type {string} */
    UpdatedContactNumber;
    /** @type {string} */
    UpdatedEmail;
    /** @type {string} */
    UpdatedEthnicGroup;
    /** @type {string} */
    UpdatedFirstName;
    /** @type {string} */
    UpdatedGender;
    /** @type {string} */
    UpdatedHomeLanguage;
    /** @type {string} */
    UpdatedIdNumber;
    /** @type {string} */
    UpdatedLastName;
    /** @type {string} */
    UpdatedPostalCode;
    /** @type {string} */
    UpdatedRegion;
    /** @type {string} */
    UpdatedSuburb;
    /** @type {string} */
    UpdatedUniqueIdentifier;
    /** @type {?string} */
    UpdatedBirthDate;
    /** @type {string} */
    UpdatedCountry;
    /** @type {string} */
    UpdatedPassportNumber;
    /** @type {?number} */
    StatusCodesId;
    /** @type {string} */
    StatusCodesDescription;
    /** @type {string} */
    Reason;
    /** @type {?number} */
    CustomersId;
    /** @type {?number} */
    CampaignsId;
    /** @type {?string} */
    CapturedDate;
    /** @type {string} */
    UpdatedIdUrl;
    /** @type {string} */
    UpdatedPassportUrl;
    /** @type {string} */
    UpdatedAddressUrl;
    /** @type {?string} */
    CampaignPublicAccessGuid;
}
export class CampaignCustomerVerificationsResponse {
    /** @param {{campaignCustomerVerificationsDetailView?:CampaignCustomerVerificationsDetailView[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {CampaignCustomerVerificationsDetailView[]} */
    campaignCustomerVerificationsDetailView;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class CampaignCustomerVerificationsRequest {
    /** @param {{PublicAccessGuid?:string,PageNumber?:number,PageSize?:number,UniqueIdentifier?:string,FirstName?:string,LastName?:string,ContactNumber?:string,Email?:string,StatusCodesId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    PublicAccessGuid;
    /** @type {number} */
    PageNumber;
    /** @type {number} */
    PageSize;
    /** @type {string} */
    UniqueIdentifier;
    /** @type {string} */
    FirstName;
    /** @type {string} */
    LastName;
    /** @type {string} */
    ContactNumber;
    /** @type {string} */
    Email;
    /** @type {?number} */
    StatusCodesId;
}

JavaScript CampaignCustomerVerificationsRequest DTOs

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

HTTP + XML

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

GET /campaign/verifications/{PublicAccessGuid}/ HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CampaignCustomerVerificationsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1: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>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1: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>
    </d2p1:Meta>
  </ResponseStatus>
  <campaignCustomerVerificationsDetailView xmlns:d2p1="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel.Types">
    <d2p1:CampaignCustomerVerificationsDetailView>
      <d2p1:Address>String</d2p1:Address>
      <d2p1:Age>0</d2p1:Age>
      <d2p1:BirthDate>0001-01-01T00:00:00</d2p1:BirthDate>
      <d2p1:CampaignPublicAccessGuid>00000000-0000-0000-0000-000000000000</d2p1:CampaignPublicAccessGuid>
      <d2p1:CampaignsId>0</d2p1:CampaignsId>
      <d2p1:CapturedDate xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>0001-01-01T00:00:00Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </d2p1:CapturedDate>
      <d2p1:City>String</d2p1:City>
      <d2p1:ContactNumber>String</d2p1:ContactNumber>
      <d2p1:Country>String</d2p1:Country>
      <d2p1:CurrenciesId>0</d2p1:CurrenciesId>
      <d2p1:CurrencyName>String</d2p1:CurrencyName>
      <d2p1:CustomersId>0</d2p1:CustomersId>
      <d2p1:Email>String</d2p1:Email>
      <d2p1:EthnicGroup>String</d2p1:EthnicGroup>
      <d2p1:FirstName>String</d2p1:FirstName>
      <d2p1:Gender>String</d2p1:Gender>
      <d2p1:HomeLanguage>String</d2p1:HomeLanguage>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:IdNumber>String</d2p1:IdNumber>
      <d2p1:LastName>String</d2p1:LastName>
      <d2p1:PassportNumber>String</d2p1:PassportNumber>
      <d2p1:PostalCode>String</d2p1:PostalCode>
      <d2p1:Reason>String</d2p1:Reason>
      <d2p1:Region>String</d2p1:Region>
      <d2p1:StatusCodesDescription>String</d2p1:StatusCodesDescription>
      <d2p1:StatusCodesId>0</d2p1:StatusCodesId>
      <d2p1:Suburb>String</d2p1:Suburb>
      <d2p1:UniqueIdentifier>String</d2p1:UniqueIdentifier>
      <d2p1:UpdatedAddress>String</d2p1:UpdatedAddress>
      <d2p1:UpdatedAddressUrl>String</d2p1:UpdatedAddressUrl>
      <d2p1:UpdatedAge>0</d2p1:UpdatedAge>
      <d2p1:UpdatedBirthDate>0001-01-01T00:00:00</d2p1:UpdatedBirthDate>
      <d2p1:UpdatedCity>String</d2p1:UpdatedCity>
      <d2p1:UpdatedContactNumber>String</d2p1:UpdatedContactNumber>
      <d2p1:UpdatedCountry>String</d2p1:UpdatedCountry>
      <d2p1:UpdatedEmail>String</d2p1:UpdatedEmail>
      <d2p1:UpdatedEthnicGroup>String</d2p1:UpdatedEthnicGroup>
      <d2p1:UpdatedFirstName>String</d2p1:UpdatedFirstName>
      <d2p1:UpdatedGender>String</d2p1:UpdatedGender>
      <d2p1:UpdatedHomeLanguage>String</d2p1:UpdatedHomeLanguage>
      <d2p1:UpdatedIdNumber>String</d2p1:UpdatedIdNumber>
      <d2p1:UpdatedIdUrl>String</d2p1:UpdatedIdUrl>
      <d2p1:UpdatedLastName>String</d2p1:UpdatedLastName>
      <d2p1:UpdatedPassportNumber>String</d2p1:UpdatedPassportNumber>
      <d2p1:UpdatedPassportUrl>String</d2p1:UpdatedPassportUrl>
      <d2p1:UpdatedPostalCode>String</d2p1:UpdatedPostalCode>
      <d2p1:UpdatedRegion>String</d2p1:UpdatedRegion>
      <d2p1:UpdatedSuburb>String</d2p1:UpdatedSuburb>
      <d2p1:UpdatedUniqueIdentifier>String</d2p1:UpdatedUniqueIdentifier>
    </d2p1:CampaignCustomerVerificationsDetailView>
  </campaignCustomerVerificationsDetailView>
</CampaignCustomerVerificationsResponse>