AffiliationAPI

<back to all web services

GetUserAffiliateTokensRequest

Requires Authentication
The following routes are available for this service:
GET/v4/user-affiliate-tokensRetrieve user's connected affiliate programs and tokensRetrieve user's connected affiliate programs information, which includes affiliate program profiles and tokens information.

// @DataContract
export class BaseResponse
{
    // @DataMember(Name="responseStatus")
    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<BaseResponse>) { (Object as any).assign(this, init); }
}

export interface IAffiliateProgram
{
    programGuid: string;
    affiliateTokens: { [index:string]: string; };
}

// @DataContract
export class GetUserAffiliateTokensResponse extends BaseResponse
{
    // @DataMember(Name="affiliateTokensSet")
    public affiliateTokensSet: IAffiliateProgram[];

    public constructor(init?: Partial<GetUserAffiliateTokensResponse>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class GetUserAffiliateTokensRequest
{
    // @DataMember(Name="username", IsRequired=true)
    public username: string;

    // @DataMember(Name="includeDisabled")
    public includeDisabled: boolean;

    public constructor(init?: Partial<GetUserAffiliateTokensRequest>) { (Object as any).assign(this, init); }
}

TypeScript GetUserAffiliateTokensRequest 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/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
		}
	}
}