AIM Web Services

<back to all web services

CustomerAccessTokenRequest

CustomerAccessToken
Requires active-e Customer Service.

The following routes are available for this service:
GET/api/CustomerAccessToken
import Foundation
import ServiceStack

/**
* CustomerAccessTokenRequires active-e Customer Service.
*/
// @DataContract
public class CustomerAccessTokenRequest : BaseSecureRequest
{
    /**
    * AIM Customer Account Number. Only used for Employee logins.
    */
    // @DataMember
    // @ApiMember(DataType="integer", Description="AIM Customer Account Number. Only used for Employee logins.", Format="int32", Name="Acct", ParameterType="query")
    public var acct:Int?

    /**
    * Can be ADD_CUSTOMER_CARD, ADD_CONTRACT_CARD, ADD_STUDENT_CARD or UPDATE_CARD. If empty, the customer can select what to do.
    */
    // @DataMember
    // @ApiMember(Description="Can be ADD_CUSTOMER_CARD, ADD_CONTRACT_CARD, ADD_STUDENT_CARD or UPDATE_CARD. If empty, the customer can select what to do.", Name="Mode", ParameterType="query")
    public var mode:String

    /**
    * Send the Contract Pk for ADD_CONTRACT_CARD, Student PK for ADD_STUDENT_CARD, or Token Pk for UPDATE_CARD. Send nothing for ADD_CUSTOMER_CARD.
    */
    // @DataMember
    // @ApiMember(Description="Send the Contract Pk for ADD_CONTRACT_CARD, Student PK for ADD_STUDENT_CARD, or Token Pk for UPDATE_CARD. Send nothing for ADD_CUSTOMER_CARD.", Name="ItemKey", ParameterType="query")
    public var itemKey:Int?

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

    private enum CodingKeys : String, CodingKey {
        case acct
        case mode
        case itemKey
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        acct = try container.decodeIfPresent(Int.self, forKey: .acct)
        mode = try container.decodeIfPresent(String.self, forKey: .mode)
        itemKey = try container.decodeIfPresent(Int.self, forKey: .itemKey)
    }

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

// @DataContract
public class BaseSecureRequest : BaseRequest
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    public var token:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
    public var deviceId:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
    public var appId:String

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

    private enum CodingKeys : String, CodingKey {
        case token
        case deviceId
        case appId
    }

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

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

// @DataContract
public class BaseRequest : Codable
{
    /**
    * This is your AIM API Key provided by Tri-Tech
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")
    public var apiKey:String

    // @DataMember
    // @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    public var oAuthToken:String

    required public init(){}
}

// @DataContract
public class CustomerAccessTokenResponse : BaseResponse
{
    // @DataMember
    public var token:String

    // @DataMember
    public var accountManagementUrl:String

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

    private enum CodingKeys : String, CodingKey {
        case token
        case accountManagementUrl
    }

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

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

// @DataContract
public class BaseResponse : Codable
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    public var status:BaseResponseResult

    required public init(){}
}

// @DataContract
public class BaseResponseResult : Codable
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    public var statusCode:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    public var login:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    public var errorCode:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    public var errorDisplayText:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    public var errorMessage:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    public var domainName:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    public var ipAddress:String

    required public init(){}
}

Swift CustomerAccessTokenRequest 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 /api/CustomerAccessToken HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Token":"String","AccountManagementUrl":"String","Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}