AffiliationAPI

<back to all web services

PostAffiliateTokensSetRequest

Requires Authentication
The following routes are available for this service:
POST/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 PostAffiliateTokensSetResponse implements JsonSerializable
{
    public function __construct(
        // @DataMember
        /** @var bool|null */
        public ?bool $success=null,

        // @DataMember
        /** @var string */
        public string $affiliateTokensSetGuid='',

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

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

// @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;
    }
}

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

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

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

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

POST /v4/affiliate-tokens-sets HTTP/1.1 
Host: affiliation-api-zane.dev.platform.georiot.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	username: String,
	affiliatePrograms: 
	[
		{
			programGuid: String
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	success: False,
	affiliateTokensSetGuid: 00000000000000000000000000000000,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}