AffiliationAPI

<back to all web services

PostGroupAffiliateTokensRequest

Requires Authentication
The following routes are available for this service:
POST/v4/groups/{groupId}/group-affiliate-tokensAdd group affiliate override 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.

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

    // @DataMember(Name="parameters", IsRequired=true)
    public parameters: { [index:string]: string; };

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

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

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

// @DataContract
export class PostGroupAffiliateTokensResponse extends BaseResponse
{
    // @DataMember
    public success: boolean;

    // @DataMember
    public affiliateTokensId: string;

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

// @DataContract
export class PostGroupAffiliateTokensRequest extends AffiliateTokensRequestBase
{
    // @DataMember(Name="groupId", IsRequired=true)
    public groupId: number;

    // @DataMember(Name="programGuid", IsRequired=true)
    public programGuid: string;

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

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

POST /v4/groups/{groupId}/group-affiliate-tokens HTTP/1.1 
Host: affiliation-api-pr-4587.qa.platform.georiot.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	groupId: 0,
	programGuid: String,
	username: String,
	parameters: 
	{
		String: String
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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
		}
	}
}