AffiliationAPI

<back to all web services

GetGroupAffiliateTokensRequest

Requires Authentication
The following routes are available for this service:
GET/v4/groups/{groupId}/group-affiliate-tokensRetrieve user's connected affiliate override programs and tokensRetrieve user's connected affiliate override 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 GetGroupAffiliateTokensResponse extends BaseResponse
{
    // @DataMember
    public affiliatePrograms: IAffiliateProgram[];

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

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

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

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

TypeScript GetGroupAffiliateTokensRequest 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/groups/{groupId}/group-affiliate-tokens HTTP/1.1 
Host: affiliation-api-zane.dev.platform.georiot.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetGroupAffiliateTokensResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AffiliationAPI.ServiceModel.V4.Responses">
  <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>
  <AffiliatePrograms xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:anyType i:nil="true" />
  </AffiliatePrograms>
</GetGroupAffiliateTokensResponse>