| GET | /v4/user-affiliate-tokens | Retrieve user's connected affiliate programs and tokens | Retrieve user's connected affiliate 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 GetUserAffiliateTokensResponse extends BaseResponse implements JsonSerializable
{
/**
* @param ResponseStatus|null $responseStatus
*/
public function __construct(
?ResponseStatus $responseStatus=null,
// @DataMember(Name="affiliateTokensSet")
/** @var array<IAffiliateProgram>|null */
public ?array $affiliateTokensSet=null
) {
parent::__construct($responseStatus);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['affiliateTokensSet'])) $this->affiliateTokensSet = JsonConverters::fromArray('IAffiliateProgram', $o['affiliateTokensSet']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->affiliateTokensSet)) $o['affiliateTokensSet'] = JsonConverters::toArray('IAffiliateProgram', $this->affiliateTokensSet);
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class GetUserAffiliateTokensRequest implements JsonSerializable
{
public function __construct(
// @DataMember(Name="username", IsRequired=true)
/** @var string|null */
public ?string $username=null,
// @DataMember(Name="includeDisabled")
/** @var bool|null */
public ?bool $includeDisabled=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['username'])) $this->username = $o['username'];
if (isset($o['includeDisabled'])) $this->includeDisabled = $o['includeDisabled'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->username)) $o['username'] = $this->username;
if (isset($this->includeDisabled)) $o['includeDisabled'] = $this->includeDisabled;
return empty($o) ? new class(){} : $o;
}
}
PHP GetUserAffiliateTokensRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v4/user-affiliate-tokens HTTP/1.1 Host: affiliation-api-zane.dev.platform.georiot.com Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
affiliateTokensSet:
[
{
}
],
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}