| Requires any of the roles: | Client, Admin, Partner |
| 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 .jsv suffix or ?format=jsv
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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
campaignCustomerVerificationsDetailView:
[
{
Id: 0,
CurrenciesId: 0,
CurrencyName: String,
Address: String,
Age: 0,
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: 0001-01-01,
Country: String,
PassportNumber: String,
UpdatedAddress: String,
UpdatedAge: 0,
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: 0001-01-01,
UpdatedCountry: String,
UpdatedPassportNumber: String,
StatusCodesId: 0,
StatusCodesDescription: String,
Reason: String,
CustomersId: 0,
CampaignsId: 0,
CapturedDate: 0001-01-01T00:00:00.0000000+00:00,
UpdatedIdUrl: String,
UpdatedPassportUrl: String,
UpdatedAddressUrl: String,
CampaignPublicAccessGuid: 00000000000000000000000000000000
}
],
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}