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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"affiliateTokensSet":[{}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}