digitaluapi

CampaignCustomersToIncludeLookup

**Requires Authentication**
Requires any of the roles:	Client, Admin, Partner

The following routes are available for this service:
GET	/customerstoinclude/{CampaignsId}

<?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 CampaignCustomersToIncludeLookup implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $CampaignsId=0,
        /** @var int[]|null */
        public ?array $CustomersId=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['CampaignsId'])) $this->CampaignsId = $o['CampaignsId'];
        if (isset($o['CustomersId'])) $this->CustomersId = JsonConverters::fromArray('int', $o['CustomersId']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->CampaignsId)) $o['CampaignsId'] = $this->CampaignsId;
        if (isset($this->CustomersId)) $o['CustomersId'] = JsonConverters::toArray('int', $this->CustomersId);
        return empty($o) ? new class(){} : $o;
    }
}

PHP CampaignCustomersToIncludeLookup 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.

GET /customerstoinclude/{CampaignsId} HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfCustomersView xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel.Types">
  <CustomersView>
    <Address>String</Address>
    <Age>0</Age>
    <BirthDate>0001-01-01T00:00:00</BirthDate>
    <City>String</City>
    <Classifications xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Classifications>
    <CompaniesId>0</CompaniesId>
    <CompaniesName>String</CompaniesName>
    <ContactNumber>String</ContactNumber>
    <Country>String</Country>
    <CurrenciesId>0</CurrenciesId>
    <CustomField1>String</CustomField1>
    <CustomField10>String</CustomField10>
    <CustomField2>String</CustomField2>
    <CustomField3>String</CustomField3>
    <CustomField4>String</CustomField4>
    <CustomField5>String</CustomField5>
    <CustomField6>String</CustomField6>
    <CustomField7>String</CustomField7>
    <CustomField8>String</CustomField8>
    <CustomField9>String</CustomField9>
    <Email>String</Email>
    <EthnicGroup>String</EthnicGroup>
    <FirstName>String</FirstName>
    <Gender>String</Gender>
    <HomeLanguage>String</HomeLanguage>
    <Id>0</Id>
    <IdNumber>String</IdNumber>
    <LastName>String</LastName>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
    <PassportNumber>String</PassportNumber>
    <PostalCode>String</PostalCode>
    <Reason>String</Reason>
    <Region>String</Region>
    <SegmentsId>0</SegmentsId>
    <SegmentsIsCustom>false</SegmentsIsCustom>
    <SegmentsName>String</SegmentsName>
    <StatusCodesDescription>String</StatusCodesDescription>
    <StatusCodesId>0</StatusCodesId>
    <Suburb>String</Suburb>
    <TenantsId>0</TenantsId>
    <UniqueIdentifier>String</UniqueIdentifier>
    <UserAuthId>0</UserAuthId>
    <VulnerabilityFlag>false</VulnerabilityFlag>
  </CustomersView>
</ArrayOfCustomersView>