AffiliationAPI

<back to all web services

GetLinkAffiliationOptionsRequest

Requires Authentication
The following routes are available for this service:
GET/v4/link-affiliation-options
<?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 LinkAffiliationOptionsResponse implements ILinkAffiliationOptionsResponse, JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $id=null,
        /** @var string|null */
        public ?string $type=null,
        /** @var string|null */
        public ?string $linkId=null,
        /** @var bool|null */
        public ?bool $affiliationDisabled=null,
        /** @var DateTime|null */
        public ?DateTime $createdDate=null
    ) {
    }

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

class GetLinkAffiliationOptionsResponse implements IGetLinkAffiliationOptionsResponse, JsonSerializable
{
    public function __construct(
        /** @var LinkAffiliationOptionsResponse|null */
        public ?LinkAffiliationOptionsResponse $data=null,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null
    ) {
    }

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

// @DataContract
class GetLinkAffiliationOptionsRequest implements IGetLinkAffiliationOptionsRequest, JsonSerializable
{
    public function __construct(
        // @DataMember(Name="linkId", IsRequired=true)
        /** @var string|null */
        public ?string $linkId=null
    ) {
    }

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

PHP GetLinkAffiliationOptionsRequest DTOs

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

HTTP + OTHER

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

GET /v4/link-affiliation-options HTTP/1.1 
Host: affiliation-api-pr-4587.qa.platform.georiot.com 
Accept: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"data":{"id":"String","type":"link-affiliation-options","linkId":"String","affiliationDisabled":false,"createdDate":"0001-01-01T00:00:00.0000000"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}