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

GET /v4/link-affiliation-options HTTP/1.1 
Host: affiliation-api-pr-4587.qa.platform.georiot.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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