digitaluapi

<back to all web services

CampaignVerifyCustomer

The following routes are available for this service:
PUT POST/campaign/verifycustomerVerify Campaign Customer
<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


class CampaignVerifyCustomer implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=1)
        // @Validate(Validator="NotNull")
        /** @var string */
        public string $CommsPublicAccessGuid='',

        // @DataMember(Order=2)
        /** @var int */
        public int $CustomersId=0,

        // @DataMember(Order=3)
        /** @var string|null */
        public ?string $UpdatedAddress=null,

        // @DataMember(Order=4)
        /** @var int|null */
        public ?int $UpdatedAge=null,

        // @DataMember(Order=5)
        /** @var string|null */
        public ?string $UpdatedCity=null,

        // @DataMember(Order=6)
        /** @var string|null */
        public ?string $UpdatedContactNumber=null,

        // @DataMember(Order=7)
        /** @var string|null */
        public ?string $UpdatedEmail=null,

        // @DataMember(Order=8)
        /** @var string|null */
        public ?string $UpdatedEthnicGroup=null,

        // @DataMember(Order=9)
        /** @var string|null */
        public ?string $UpdatedFirstName=null,

        // @DataMember(Order=10)
        /** @var string|null */
        public ?string $UpdatedGender=null,

        // @DataMember(Order=11)
        /** @var string|null */
        public ?string $UpdatedHomeLanguage=null,

        // @DataMember(Order=12)
        /** @var string|null */
        public ?string $UpdatedIdNumber=null,

        // @DataMember(Order=13)
        /** @var string|null */
        public ?string $UpdatedLastName=null,

        // @DataMember(Order=14)
        /** @var string|null */
        public ?string $UpdatedPostalCode=null,

        // @DataMember(Order=15)
        /** @var string|null */
        public ?string $UpdatedRegion=null,

        // @DataMember(Order=16)
        /** @var string|null */
        public ?string $UpdatedSuburb=null,

        // @DataMember(Order=17)
        /** @var string|null */
        public ?string $UpdatedUniqueIdentifier=null,

        // @DataMember(Order=18)
        /** @var DateTime|null */
        public ?DateTime $UpdatedBirthDate=null,

        // @DataMember(Order=19)
        /** @var string|null */
        public ?string $UpdatedCountry=null,

        // @DataMember(Order=20)
        /** @var string|null */
        public ?string $UpdatedPassportNumber=null,

        // @DataMember(Order=21)
        // @Required()
        /** @var int */
        public int $StatusCodesId=0,

        // @DataMember(Order=22)
        /** @var string|null */
        public ?string $Reason=null,

        // @DataMember(Order=22)
        // @Required()
        /** @var int */
        public int $CampaignsId=0,

        // @DataMember(Order=23)
        // @Required()
        /** @var DateTime */
        public DateTime $CapturedDate=new DateTime(),

        // @DataMember(Order=24)
        /** @var string|null */
        public ?string $UpdatedIdUrl=null,

        // @DataMember(Order=25)
        /** @var string|null */
        public ?string $UpdatedPassportUrl=null,

        // @DataMember(Order=26)
        /** @var string|null */
        public ?string $UpdatedAddressUrl=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['CommsPublicAccessGuid'])) $this->CommsPublicAccessGuid = $o['CommsPublicAccessGuid'];
        if (isset($o['CustomersId'])) $this->CustomersId = $o['CustomersId'];
        if (isset($o['UpdatedAddress'])) $this->UpdatedAddress = $o['UpdatedAddress'];
        if (isset($o['UpdatedAge'])) $this->UpdatedAge = $o['UpdatedAge'];
        if (isset($o['UpdatedCity'])) $this->UpdatedCity = $o['UpdatedCity'];
        if (isset($o['UpdatedContactNumber'])) $this->UpdatedContactNumber = $o['UpdatedContactNumber'];
        if (isset($o['UpdatedEmail'])) $this->UpdatedEmail = $o['UpdatedEmail'];
        if (isset($o['UpdatedEthnicGroup'])) $this->UpdatedEthnicGroup = $o['UpdatedEthnicGroup'];
        if (isset($o['UpdatedFirstName'])) $this->UpdatedFirstName = $o['UpdatedFirstName'];
        if (isset($o['UpdatedGender'])) $this->UpdatedGender = $o['UpdatedGender'];
        if (isset($o['UpdatedHomeLanguage'])) $this->UpdatedHomeLanguage = $o['UpdatedHomeLanguage'];
        if (isset($o['UpdatedIdNumber'])) $this->UpdatedIdNumber = $o['UpdatedIdNumber'];
        if (isset($o['UpdatedLastName'])) $this->UpdatedLastName = $o['UpdatedLastName'];
        if (isset($o['UpdatedPostalCode'])) $this->UpdatedPostalCode = $o['UpdatedPostalCode'];
        if (isset($o['UpdatedRegion'])) $this->UpdatedRegion = $o['UpdatedRegion'];
        if (isset($o['UpdatedSuburb'])) $this->UpdatedSuburb = $o['UpdatedSuburb'];
        if (isset($o['UpdatedUniqueIdentifier'])) $this->UpdatedUniqueIdentifier = $o['UpdatedUniqueIdentifier'];
        if (isset($o['UpdatedBirthDate'])) $this->UpdatedBirthDate = JsonConverters::from('DateTime', $o['UpdatedBirthDate']);
        if (isset($o['UpdatedCountry'])) $this->UpdatedCountry = $o['UpdatedCountry'];
        if (isset($o['UpdatedPassportNumber'])) $this->UpdatedPassportNumber = $o['UpdatedPassportNumber'];
        if (isset($o['StatusCodesId'])) $this->StatusCodesId = $o['StatusCodesId'];
        if (isset($o['Reason'])) $this->Reason = $o['Reason'];
        if (isset($o['CampaignsId'])) $this->CampaignsId = $o['CampaignsId'];
        if (isset($o['CapturedDate'])) $this->CapturedDate = JsonConverters::from('DateTime', $o['CapturedDate']);
        if (isset($o['UpdatedIdUrl'])) $this->UpdatedIdUrl = $o['UpdatedIdUrl'];
        if (isset($o['UpdatedPassportUrl'])) $this->UpdatedPassportUrl = $o['UpdatedPassportUrl'];
        if (isset($o['UpdatedAddressUrl'])) $this->UpdatedAddressUrl = $o['UpdatedAddressUrl'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->CommsPublicAccessGuid)) $o['CommsPublicAccessGuid'] = $this->CommsPublicAccessGuid;
        if (isset($this->CustomersId)) $o['CustomersId'] = $this->CustomersId;
        if (isset($this->UpdatedAddress)) $o['UpdatedAddress'] = $this->UpdatedAddress;
        if (isset($this->UpdatedAge)) $o['UpdatedAge'] = $this->UpdatedAge;
        if (isset($this->UpdatedCity)) $o['UpdatedCity'] = $this->UpdatedCity;
        if (isset($this->UpdatedContactNumber)) $o['UpdatedContactNumber'] = $this->UpdatedContactNumber;
        if (isset($this->UpdatedEmail)) $o['UpdatedEmail'] = $this->UpdatedEmail;
        if (isset($this->UpdatedEthnicGroup)) $o['UpdatedEthnicGroup'] = $this->UpdatedEthnicGroup;
        if (isset($this->UpdatedFirstName)) $o['UpdatedFirstName'] = $this->UpdatedFirstName;
        if (isset($this->UpdatedGender)) $o['UpdatedGender'] = $this->UpdatedGender;
        if (isset($this->UpdatedHomeLanguage)) $o['UpdatedHomeLanguage'] = $this->UpdatedHomeLanguage;
        if (isset($this->UpdatedIdNumber)) $o['UpdatedIdNumber'] = $this->UpdatedIdNumber;
        if (isset($this->UpdatedLastName)) $o['UpdatedLastName'] = $this->UpdatedLastName;
        if (isset($this->UpdatedPostalCode)) $o['UpdatedPostalCode'] = $this->UpdatedPostalCode;
        if (isset($this->UpdatedRegion)) $o['UpdatedRegion'] = $this->UpdatedRegion;
        if (isset($this->UpdatedSuburb)) $o['UpdatedSuburb'] = $this->UpdatedSuburb;
        if (isset($this->UpdatedUniqueIdentifier)) $o['UpdatedUniqueIdentifier'] = $this->UpdatedUniqueIdentifier;
        if (isset($this->UpdatedBirthDate)) $o['UpdatedBirthDate'] = JsonConverters::to('DateTime', $this->UpdatedBirthDate);
        if (isset($this->UpdatedCountry)) $o['UpdatedCountry'] = $this->UpdatedCountry;
        if (isset($this->UpdatedPassportNumber)) $o['UpdatedPassportNumber'] = $this->UpdatedPassportNumber;
        if (isset($this->StatusCodesId)) $o['StatusCodesId'] = $this->StatusCodesId;
        if (isset($this->Reason)) $o['Reason'] = $this->Reason;
        if (isset($this->CampaignsId)) $o['CampaignsId'] = $this->CampaignsId;
        if (isset($this->CapturedDate)) $o['CapturedDate'] = JsonConverters::to('DateTime', $this->CapturedDate);
        if (isset($this->UpdatedIdUrl)) $o['UpdatedIdUrl'] = $this->UpdatedIdUrl;
        if (isset($this->UpdatedPassportUrl)) $o['UpdatedPassportUrl'] = $this->UpdatedPassportUrl;
        if (isset($this->UpdatedAddressUrl)) $o['UpdatedAddressUrl'] = $this->UpdatedAddressUrl;
        return empty($o) ? new class(){} : $o;
    }
}

PHP CampaignVerifyCustomer DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"CommsPublicAccessGuid":"00000000000000000000000000000000","CustomersId":0,"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,"Reason":"String","CampaignsId":0,"CapturedDate":"0001-01-01T00:00:00.0000000+00:00","UpdatedIdUrl":"String","UpdatedPassportUrl":"String","UpdatedAddressUrl":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

false