Billhighway Cloud API

<back to all web services

IntegrationPartnerGetRq

The following routes are available for this service:
GET/signup/api/integration/partner/{name}
import Foundation
import ServiceStack

public class IntegrationPartnerGetRq : IApiRequest, Codable
{
    public var name:String?

    required public init(){}
}

public class IntegrationPartnerRs : IApiResponse, Codable
{
    public var partner:IntegrationPartner?

    required public init(){}
}

public class IntegrationPartner : Codable
{
    public var integrationPartnerId:Int?
    public var name:String?
    public var Description:String?
    public var uri:String?
    public var username:String?
    public var password:String?
    public var apiKey:String?
    public var oAuthSettings:IntegrationPartnerOAuthSettings?
    public var detinationConfigurations:[IntegrationDestinationConfig] = []
    public var scope:String?

    required public init(){}
}

public class IntegrationPartnerOAuthSettings : Codable
{
    public var natId:Int?
    public var chapId:Int?
    public var authorizeUrl:String?
    public var authorizeRedirectUri:String?
    public var tokenUrl:String?
    public var userInfoUrl:String?
    public var consumerKey:String?
    public var consumerSecret:String?
    public var username:String?
    public var password:String?
    public var securityToken:String?
    public var appRedirects:[OAuthAppRedirects] = []

    required public init(){}
}

public class OAuthAppRedirects : Codable
{
    public var scope:String?
    public var redirectTemplate:String?
    public var allowAnonymous:Bool?

    required public init(){}
}

public class IntegrationDestinationConfig : Codable
{
    public var type:String?
    public var uriType:DestinationUriType?
    public var uri:String?
    public var authenticationKey:String?

    required public init(){}
}

public enum DestinationUriType : Int, Codable
{
    case None = 0
    case Absolute = 1
    case Relative = 2
}

Swift IntegrationPartnerGetRq 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 /signup/api/integration/partner/{name} HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/json

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

{"Partner":{"IntegrationPartnerId":0,"Name":"String","Description":"String","Uri":"String","Username":"String","Password":"String","ApiKey":"String","OAuthSettings":{"NatId":0,"ChapId":0,"AuthorizeUrl":"String","AuthorizeRedirectUri":"String","TokenUrl":"String","UserInfoUrl":"String","ConsumerKey":"String","ConsumerSecret":"String","Username":"String","Password":"String","SecurityToken":"String","AppRedirects":[{"Scope":"String","RedirectTemplate":"String","AllowAnonymous":false}]},"DetinationConfigurations":[{"Type":"String","UriType":0,"Uri":"String","AuthenticationKey":"String"}],"Scope":"String"}}