AffiliationAPI

<back to all web services

GetLinkAffiliationOptionsRequest

Requires Authentication
The following routes are available for this service:
GET/v4/link-affiliation-options
"use strict";
export class LinkAffiliationOptionsResponse {
    /** @param {{id?:string,type?:string,linkId?:string,affiliationDisabled?:boolean,createdDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    id;
    /** @type {string} */
    type;
    /** @type {string} */
    linkId;
    /** @type {?boolean} */
    affiliationDisabled;
    /** @type {?string} */
    createdDate;
}
export class GetLinkAffiliationOptionsResponse {
    /** @param {{data?:LinkAffiliationOptionsResponse,responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {LinkAffiliationOptionsResponse} */
    data;
    /** @type {ResponseStatus} */
    responseStatus;
}
export class GetLinkAffiliationOptionsRequest {
    /** @param {{linkId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    linkId;
}

JavaScript GetLinkAffiliationOptionsRequest 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/link-affiliation-options 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

<GetLinkAffiliationOptionsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AffiliationAPI.ServiceModel.V4.Responses">
  <Data>
    <AffiliationDisabled>false</AffiliationDisabled>
    <CreatedDate>0001-01-01T00:00:00</CreatedDate>
    <Id>String</Id>
    <LinkId>String</LinkId>
  </Data>
  <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>
</GetLinkAffiliationOptionsResponse>