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

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

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

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

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

    // @DataMember(Order=5)
    public Age?: number;

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

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

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

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

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

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

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

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

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

    // @DataMember(Order=15)
    public PostalCode: string;

    // @DataMember(Order=16)
    public Region: string;

    // @DataMember(Order=17)
    public Suburb: string;

    // @DataMember(Order=18)
    public UniqueIdentifier: string;

    // @DataMember(Order=19)
    public BirthDate?: string;

    // @DataMember(Order=20)
    public Country: string;

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

    // @DataMember(Order=22)
    public UpdatedAddress: string;

    // @DataMember(Order=23)
    public UpdatedAge?: number;

    // @DataMember(Order=24)
    public UpdatedCity: string;

    // @DataMember(Order=25)
    public UpdatedContactNumber: string;

    // @DataMember(Order=26)
    public UpdatedEmail: string;

    // @DataMember(Order=27)
    public UpdatedEthnicGroup: string;

    // @DataMember(Order=28)
    public UpdatedFirstName: string;

    // @DataMember(Order=29)
    public UpdatedGender: string;

    // @DataMember(Order=30)
    public UpdatedHomeLanguage: string;

    // @DataMember(Order=31)
    public UpdatedIdNumber: string;

    // @DataMember(Order=32)
    public UpdatedLastName: string;

    // @DataMember(Order=33)
    public UpdatedPostalCode: string;

    // @DataMember(Order=34)
    public UpdatedRegion: string;

    // @DataMember(Order=35)
    public UpdatedSuburb: string;

    // @DataMember(Order=36)
    public UpdatedUniqueIdentifier: string;

    // @DataMember(Order=37)
    public UpdatedBirthDate?: string;

    // @DataMember(Order=38)
    public UpdatedCountry: string;

    // @DataMember(Order=39)
    public UpdatedPassportNumber: string;

    // @DataMember(Order=40)
    public StatusCodesId?: number;

    // @DataMember(Order=41)
    public StatusCodesDescription: string;

    // @DataMember(Order=42)
    public Reason: string;

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

    // @DataMember(Order=44)
    public CampaignsId?: number;

    // @DataMember(Order=45)
    public CapturedDate?: string;

    // @DataMember(Order=46)
    public UpdatedIdUrl: string;

    // @DataMember(Order=47)
    public UpdatedPassportUrl: string;

    // @DataMember(Order=48)
    public UpdatedAddressUrl: string;

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

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

export class CampaignCustomerVerificationsResponse
{
    public campaignCustomerVerificationsDetailView: CampaignCustomerVerificationsDetailView[];
    public ResponseStatus: ResponseStatus;

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

export class CampaignCustomerVerificationsRequest
{
    // @Validate(Validator="NotNull")
    public PublicAccessGuid: string;

    public PageNumber: number;
    public PageSize: number;
    public UniqueIdentifier: string;
    public FirstName: string;
    public LastName: string;
    public ContactNumber: string;
    public Email: string;
    public StatusCodesId?: number;

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

TypeScript 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>