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
CampaignCustomerVerificationsRequest Parameters:
NameParameterData TypeRequiredDescription
PublicAccessGuidpathGuidYes
PageNumberqueryintNo
PageSizequeryintNo
UniqueIdentifierquerystringNo
FirstNamequerystringNo
LastNamequerystringNo
ContactNumberquerystringNo
EmailquerystringNo
StatusCodesIdquerylong?No
CampaignCustomerVerificationsResponse Parameters:
NameParameterData TypeRequiredDescription
campaignCustomerVerificationsDetailViewformList<CampaignCustomerVerificationsDetailView>No
ResponseStatusformResponseStatusNo
CampaignCustomerVerificationsDetailView Parameters:
NameParameterData TypeRequiredDescription
Idformlong?No
CurrenciesIdformint?No
CurrencyNameformstringNo
AddressformstringNo
Ageformint?No
CityformstringNo
ContactNumberformstringNo
EmailformstringNo
EthnicGroupformstringNo
FirstNameformstringNo
GenderformstringNo
HomeLanguageformstringNo
IdNumberformstringNo
LastNameformstringNo
PostalCodeformstringNo
RegionformstringNo
SuburbformstringNo
UniqueIdentifierformstringNo
BirthDateformDateTime?No
CountryformstringNo
PassportNumberformstringNo
UpdatedAddressformstringNo
UpdatedAgeformint?No
UpdatedCityformstringNo
UpdatedContactNumberformstringNo
UpdatedEmailformstringNo
UpdatedEthnicGroupformstringNo
UpdatedFirstNameformstringNo
UpdatedGenderformstringNo
UpdatedHomeLanguageformstringNo
UpdatedIdNumberformstringNo
UpdatedLastNameformstringNo
UpdatedPostalCodeformstringNo
UpdatedRegionformstringNo
UpdatedSuburbformstringNo
UpdatedUniqueIdentifierformstringNo
UpdatedBirthDateformDateTime?No
UpdatedCountryformstringNo
UpdatedPassportNumberformstringNo
StatusCodesIdformlong?No
StatusCodesDescriptionformstringNo
ReasonformstringNo
CustomersIdformlong?No
CampaignsIdformlong?No
CapturedDateformDateTimeOffset?No
UpdatedIdUrlformstringNo
UpdatedPassportUrlformstringNo
UpdatedAddressUrlformstringNo
CampaignPublicAccessGuidformGuid?No

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

HTTP + CSV

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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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-01T00:00:00.0000000","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-01T00:00:00.0000000","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"}}}