AffiliationAPI

<back to all web services

GetAffiliateTokensSetRequest

Requires Authentication
The following routes are available for this service:
GET/v4/affiliate-tokens-sets
<?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};


// @DataContract
class AffiliateProgram implements IAffiliateProgram, JsonSerializable
{
    public function __construct(
        // @DataMember(Name="programGuid")
        /** @var string|null */
        public ?string $programGuid=null,

        // @DataMember(Name="affiliateTokens")
        /** @var array<string,string>|null */
        public ?array $affiliateTokens=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['programGuid'])) $this->programGuid = $o['programGuid'];
        if (isset($o['affiliateTokens'])) $this->affiliateTokens = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','string']), $o['affiliateTokens']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->programGuid)) $o['programGuid'] = $this->programGuid;
        if (isset($this->affiliateTokens)) $o['affiliateTokens'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','string']), $this->affiliateTokens);
        return empty($o) ? new class(){} : $o;
    }
}

class AffiliateTokens implements IAffiliateTokens, JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $id=null,
        /** @var array<AffiliateProgram>|null */
        public ?array $programs=null,
        /** @var DateTime */
        public DateTime $createdAtUtc=new DateTime(),
        /** @var DateTime */
        public DateTime $updatedAtUtc=new DateTime()
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['id'])) $this->id = $o['id'];
        if (isset($o['programs'])) $this->programs = JsonConverters::fromArray('AffiliateProgram', $o['programs']);
        if (isset($o['createdAtUtc'])) $this->createdAtUtc = JsonConverters::from('DateTime', $o['createdAtUtc']);
        if (isset($o['updatedAtUtc'])) $this->updatedAtUtc = JsonConverters::from('DateTime', $o['updatedAtUtc']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->id)) $o['id'] = $this->id;
        if (isset($this->programs)) $o['programs'] = JsonConverters::toArray('AffiliateProgram', $this->programs);
        if (isset($this->createdAtUtc)) $o['createdAtUtc'] = JsonConverters::to('DateTime', $this->createdAtUtc);
        if (isset($this->updatedAtUtc)) $o['updatedAtUtc'] = JsonConverters::to('DateTime', $this->updatedAtUtc);
        return empty($o) ? new class(){} : $o;
    }
}

class AffiliateTokensSet extends AffiliateTokens implements IAffiliateTokensSet, JsonSerializable
{
    /**
     * @param string|null $id
     * @param array<AffiliateProgram>|null $programs
     * @param DateTime $createdAtUtc
     * @param DateTime $updatedAtUtc
     */
    public function __construct(
        ?string $id=null,
        ?array $programs=null,
        DateTime $createdAtUtc=new DateTime(),
        DateTime $updatedAtUtc=new DateTime(),
        // @DataMember(Name="setGuid")
        /** @var string|null */
        public ?string $setGuid=null,

        // @DataMember(Name="username")
        /** @var string|null */
        public ?string $username=null
    ) {
        parent::__construct($id,$programs,$createdAtUtc,$updatedAtUtc);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
        if (isset($o['setGuid'])) $this->setGuid = $o['setGuid'];
        if (isset($o['username'])) $this->username = $o['username'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        if (isset($this->setGuid)) $o['setGuid'] = $this->setGuid;
        if (isset($this->username)) $o['username'] = $this->username;
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class GetAffiliateTokensSetResponse implements JsonSerializable
{
    public function __construct(
        // @DataMember(Name="affiliateTokensSet")
        /** @var AffiliateTokensSet|null */
        public ?AffiliateTokensSet $affiliateTokensSet=null,

        // @DataMember(Name="responseStatus")
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['affiliateTokensSet'])) $this->affiliateTokensSet = JsonConverters::from('AffiliateTokensSet', $o['affiliateTokensSet']);
        if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->affiliateTokensSet)) $o['affiliateTokensSet'] = JsonConverters::to('AffiliateTokensSet', $this->affiliateTokensSet);
        if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class GetAffiliateTokensSetRequest implements JsonSerializable
{
    public function __construct(
        // @DataMember(Name="setGuid")
        /** @var string */
        public string $setGuid=''
    ) {
    }

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

PHP GetAffiliateTokensSetRequest 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 /v4/affiliate-tokens-sets HTTP/1.1 
Host: affiliation-api-pr-4587.qa.platform.georiot.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetAffiliateTokensSetResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AffiliationAPI.ServiceModel.V4.Responses">
  <affiliateTokensSet xmlns:d2p1="http://schemas.datacontract.org/2004/07/AffiliationAPI.ServiceModel.DomainModel">
    <d2p1:CreatedAtUtc>0001-01-01T00:00:00</d2p1:CreatedAtUtc>
    <d2p1:Id>String</d2p1:Id>
    <d2p1:Programs>
      <d2p1:AffiliateProgram>
        <d2p1:affiliateTokens xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
        <d2p1:programGuid>String</d2p1:programGuid>
      </d2p1:AffiliateProgram>
    </d2p1:Programs>
    <d2p1:UpdatedAtUtc>0001-01-01T00:00:00</d2p1:UpdatedAtUtc>
    <d2p1:SetGuid>String</d2p1:SetGuid>
    <d2p1:Username>String</d2p1:Username>
  </affiliateTokensSet>
  <responseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1: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>
    </d2p1:Meta>
  </responseStatus>
</GetAffiliateTokensSetResponse>