digitaluapi

<back to all web services

CampaignVerifyCustomer

The following routes are available for this service:
PUT POST/campaign/verifycustomerVerify Campaign Customer
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 CampaignVerifyCustomer:
    # @Validate(Validator="NotNull")
    comms_public_access_guid: Optional[str] = None

    customers_id: int = 0
    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
    # @Required()
    status_codes_id: int = 0

    reason: Optional[str] = None
    # @Required()
    campaigns_id: int = 0

    # @Required()
    captured_date: datetime.datetime = datetime.datetime(1, 1, 1)

    updated_id_url: Optional[str] = None
    updated_passport_url: Optional[str] = None
    updated_address_url: Optional[str] = None

Python CampaignVerifyCustomer 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.

POST /campaign/verifycustomer HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CampaignVerifyCustomer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <CampaignsId>0</CampaignsId>
  <CapturedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </CapturedDate>
  <CommsPublicAccessGuid>00000000-0000-0000-0000-000000000000</CommsPublicAccessGuid>
  <CustomersId>0</CustomersId>
  <Reason>String</Reason>
  <StatusCodesId>0</StatusCodesId>
  <UpdatedAddress>String</UpdatedAddress>
  <UpdatedAddressUrl>String</UpdatedAddressUrl>
  <UpdatedAge>0</UpdatedAge>
  <UpdatedBirthDate>0001-01-01T00:00:00</UpdatedBirthDate>
  <UpdatedCity>String</UpdatedCity>
  <UpdatedContactNumber>String</UpdatedContactNumber>
  <UpdatedCountry>String</UpdatedCountry>
  <UpdatedEmail>String</UpdatedEmail>
  <UpdatedEthnicGroup>String</UpdatedEthnicGroup>
  <UpdatedFirstName>String</UpdatedFirstName>
  <UpdatedGender>String</UpdatedGender>
  <UpdatedHomeLanguage>String</UpdatedHomeLanguage>
  <UpdatedIdNumber>String</UpdatedIdNumber>
  <UpdatedIdUrl>String</UpdatedIdUrl>
  <UpdatedLastName>String</UpdatedLastName>
  <UpdatedPassportNumber>String</UpdatedPassportNumber>
  <UpdatedPassportUrl>String</UpdatedPassportUrl>
  <UpdatedPostalCode>String</UpdatedPostalCode>
  <UpdatedRegion>String</UpdatedRegion>
  <UpdatedSuburb>String</UpdatedSuburb>
  <UpdatedUniqueIdentifier>String</UpdatedUniqueIdentifier>
</CampaignVerifyCustomer>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">false</boolean>