Billhighway Cloud API

<back to all web services

IntegrationPartnerGetRq

The following routes are available for this service:
GET/signup/api/integration/partner/{name}
import java.math.*
import java.util.*
import net.servicestack.client.*


open class IntegrationPartnerGetRq : IApiRequest
{
    var Name:String? = null
}

open class IntegrationPartnerRs : IApiResponse
{
    var Partner:IntegrationPartner? = null
}

open class IntegrationPartner
{
    var IntegrationPartnerId:Int? = null
    var Name:String? = null
    var Description:String? = null
    var Uri:String? = null
    var Username:String? = null
    var Password:String? = null
    var ApiKey:String? = null
    var OAuthSettings:IntegrationPartnerOAuthSettings? = null
    var DetinationConfigurations:ArrayList<IntegrationDestinationConfig> = ArrayList<IntegrationDestinationConfig>()
    var Scope:String? = null
}

open class IntegrationPartnerOAuthSettings
{
    var NatId:Int? = null
    var ChapId:Int? = null
    var AuthorizeUrl:String? = null
    var AuthorizeRedirectUri:String? = null
    var TokenUrl:String? = null
    var UserInfoUrl:String? = null
    var ConsumerKey:String? = null
    var ConsumerSecret:String? = null
    var Username:String? = null
    var Password:String? = null
    var SecurityToken:String? = null
    var AppRedirects:ArrayList<OAuthAppRedirects> = ArrayList<OAuthAppRedirects>()
}

open class OAuthAppRedirects
{
    var Scope:String? = null
    var RedirectTemplate:String? = null
    var AllowAnonymous:Boolean? = null
}

open class IntegrationDestinationConfig
{
    var Type:String? = null
    var UriType:DestinationUriType? = null
    var Uri:String? = null
    var AuthenticationKey:String? = null
}

enum class DestinationUriType(val value:Int)
{
    @SerializedName("0") None(0),
    @SerializedName("1") Absolute(1),
    @SerializedName("2") Relative(2),
}

Kotlin IntegrationPartnerGetRq DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}