| Requires any of the roles: | Client, Admin, Partner |
| 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 .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
}
}
}