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.
import Foundation
import ServiceStack

// @DataContract
public class GetUserAffiliateTokensRequest : Codable
{
    // @DataMember(Name="username", IsRequired=true)
    public var username:String

    // @DataMember(Name="includeDisabled")
    public var includeDisabled:Bool

    required public init(){}
}

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

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case affiliateTokensSet
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        affiliateTokensSet = try container.decodeIfPresent([IAffiliateProgram].self, forKey: .affiliateTokensSet) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if affiliateTokensSet != nil { try container.encode(affiliateTokensSet, forKey: .affiliateTokensSet) }
    }
}

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

    required public init(){}
}

public protocol IAffiliateProgram
{
    var programGuid:String { get set }
    var affiliateTokens:[String:String] { get set }

}


Swift GetUserAffiliateTokensRequest 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/user-affiliate-tokens HTTP/1.1 
Host: affiliation-api-pr-4587.qa.platform.georiot.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetUserAffiliateTokensResponse 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>
  <affiliateTokensSet xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:anyType i:nil="true" />
  </affiliateTokensSet>
</GetUserAffiliateTokensResponse>