AffiliationAPI

<back to all web services

PutGroupAffiliateTokensRequest

Requires Authentication
The following routes are available for this service:
PUT/v4/groups/{groupId}/group-affiliate-tokens/{guid}Update user's group affiliate info for specific programList of user's group currently connected affiliate programs (including assigned GUID per program) may be retrieved by calling the GET /v3/group-affiliate-tokens endpoint.
Please note that parameter names must match the information we have for the affiliate network, this information may be obtained using the GET /v3/affiliate-programs endpoint.
import Foundation
import ServiceStack

// @DataContract
public class PutGroupAffiliateTokensRequest : AffiliateTokensRequestBase
{
    // @DataMember(Name="groupId", IsRequired=true)
    public var groupId:UInt32

    // @DataMember(Name="guid", IsRequired=true)
    public var guid:String

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

    private enum CodingKeys : String, CodingKey {
        case groupId
        case guid
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        groupId = try container.decodeIfPresent(UInt32.self, forKey: .groupId)
        guid = try container.decodeIfPresent(String.self, forKey: .guid)
    }

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

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

    // @DataMember(Name="parameters", IsRequired=true)
    public var parameters:[String:String]

    required public init(){}
}

// @DataContract
public class PutGroupAffiliateTokensResponse : BaseResponse
{
    // @DataMember
    public var success:Bool

    // @DataMember
    public var affiliateTokensId:String

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

    private enum CodingKeys : String, CodingKey {
        case success
        case affiliateTokensId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        success = try container.decodeIfPresent(Bool.self, forKey: .success)
        affiliateTokensId = try container.decodeIfPresent(String.self, forKey: .affiliateTokensId)
    }

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

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

    required public init(){}
}


Swift PutGroupAffiliateTokensRequest 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.

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

{
	groupId: 0,
	guid: 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
		}
	}
}