AffiliationAPI

<back to all web services

GetGroupAffiliateTokensRequest

Requires Authentication
The following routes are available for this service:
GET/v4/groups/{groupId}/group-affiliate-tokensRetrieve user's connected affiliate override programs and tokensRetrieve user's connected affiliate override programs information, which includes affiliate program profiles and tokens information.
<?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 BaseResponse implements JsonSerializable
{
    public function __construct(
        // @DataMember(Name="responseStatus")
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null
    ) {
    }

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

/**
 * @property string|null $programGuid
 * @property array<string,string>|null $affiliateTokens
 */
interface IAffiliateProgram
{
}

// @DataContract
class GetGroupAffiliateTokensResponse extends BaseResponse implements JsonSerializable
{
    /**
     * @param ResponseStatus|null $responseStatus
     */
    public function __construct(
        ?ResponseStatus $responseStatus=null,
        // @DataMember
        /** @var array<IAffiliateProgram>|null */
        public ?array $affiliatePrograms=null
    ) {
        parent::__construct($responseStatus);
    }

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

// @DataContract
class GetGroupAffiliateTokensRequest implements JsonSerializable
{
    public function __construct(
        // @DataMember(Name="groupId", IsRequired=true)
        /** @var int */
        public int $groupId=0,

        // @DataMember(Name="username", IsRequired=true)
        /** @var string|null */
        public ?string $username=null
    ) {
    }

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

PHP GetGroupAffiliateTokensRequest DTOs

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

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v4/groups/{groupId}/group-affiliate-tokens HTTP/1.1 
Host: affiliation-api-zane.dev.platform.georiot.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"affiliatePrograms":[{}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}