AffiliationAPI

<back to all web services

PostUserAffiliateTokensRequest

Requires Authentication
The following routes are available for this service:
POST/v4/user-affiliate-tokensAdd user's affiliate info for a specific programList of supported affiliate programs may be retrieved by calling the GET /v3/affiliate-programs endpoint.
Parameter names must match and valid values must be provided.
"use strict";
export class AffiliateTokensRequestBase {
    /** @param {{username?:string,parameters?:{ [index:string]: string; }}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    username;
    /** @type {{ [index:string]: string; }} */
    parameters;
}
export class BaseResponse {
    /** @param {{responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
}
export class PostUserAffiliateTokensResponse extends BaseResponse {
    /** @param {{success?:boolean,affiliateTokensId?:string,responseStatus?:ResponseStatus}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {boolean} */
    success;
    /** @type {string} */
    affiliateTokensId;
}
export class PostUserAffiliateTokensRequest extends AffiliateTokensRequestBase {
    /** @param {{programGuid?:string,username?:string,parameters?:{ [index:string]: string; }}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    programGuid;
}

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

POST /v4/user-affiliate-tokens HTTP/1.1 
Host: affiliation-api-zane.dev.platform.georiot.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"programGuid":"String","username":"String","parameters":{"String":"String"}}

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

{"success":false,"affiliateTokensId":"String","responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}