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
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CampaignCustomerVerificationsDetailView:
    id: Optional[int] = None
    currencies_id: Optional[int] = None
    currency_name: Optional[str] = None
    address: Optional[str] = None
    age: Optional[int] = None
    city: Optional[str] = None
    contact_number: Optional[str] = None
    email: Optional[str] = None
    ethnic_group: Optional[str] = None
    first_name: Optional[str] = None
    gender: Optional[str] = None
    home_language: Optional[str] = None
    id_number: Optional[str] = None
    last_name: Optional[str] = None
    postal_code: Optional[str] = None
    region: Optional[str] = None
    suburb: Optional[str] = None
    unique_identifier: Optional[str] = None
    birth_date: Optional[datetime.datetime] = None
    country: Optional[str] = None
    passport_number: Optional[str] = None
    updated_address: Optional[str] = None
    updated_age: Optional[int] = None
    updated_city: Optional[str] = None
    updated_contact_number: Optional[str] = None
    updated_email: Optional[str] = None
    updated_ethnic_group: Optional[str] = None
    updated_first_name: Optional[str] = None
    updated_gender: Optional[str] = None
    updated_home_language: Optional[str] = None
    updated_id_number: Optional[str] = None
    updated_last_name: Optional[str] = None
    updated_postal_code: Optional[str] = None
    updated_region: Optional[str] = None
    updated_suburb: Optional[str] = None
    updated_unique_identifier: Optional[str] = None
    updated_birth_date: Optional[datetime.datetime] = None
    updated_country: Optional[str] = None
    updated_passport_number: Optional[str] = None
    status_codes_id: Optional[int] = None
    status_codes_description: Optional[str] = None
    reason: Optional[str] = None
    customers_id: Optional[int] = None
    campaigns_id: Optional[int] = None
    captured_date: Optional[datetime.datetime] = None
    updated_id_url: Optional[str] = None
    updated_passport_url: Optional[str] = None
    updated_address_url: Optional[str] = None
    campaign_public_access_guid: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CampaignCustomerVerificationsResponse:
    campaign_customer_verifications_detail_view: Optional[List[CampaignCustomerVerificationsDetailView]] = None
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CampaignCustomerVerificationsRequest:
    # @Validate(Validator="NotNull")
    public_access_guid: Optional[str] = None

    page_number: int = 0
    page_size: int = 0
    unique_identifier: Optional[str] = None
    first_name: Optional[str] = None
    last_name: Optional[str] = None
    contact_number: Optional[str] = None
    email: Optional[str] = None
    status_codes_id: Optional[int] = None

Python CampaignCustomerVerificationsRequest DTOs

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

HTTP + 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
		}
	}
}