Billhighway Cloud API

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

HTTP + XML

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/xml

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

<IntegrationPartnerRs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.Partner.Integration.Service">
  <Partner xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.Partner.Integration">
    <d2p1:_x003C_ApiKey_x003E_k__BackingField>String</d2p1:_x003C_ApiKey_x003E_k__BackingField>
    <d2p1:_x003C_Description_x003E_k__BackingField>String</d2p1:_x003C_Description_x003E_k__BackingField>
    <d2p1:_x003C_DetinationConfigurations_x003E_k__BackingField>
      <d2p1:IntegrationDestinationConfig>
        <d2p1:_x003C_AuthenticationKey_x003E_k__BackingField>String</d2p1:_x003C_AuthenticationKey_x003E_k__BackingField>
        <d2p1:_x003C_Type_x003E_k__BackingField>String</d2p1:_x003C_Type_x003E_k__BackingField>
        <d2p1:_x003C_UriType_x003E_k__BackingField>None</d2p1:_x003C_UriType_x003E_k__BackingField>
        <d2p1:_x003C_Uri_x003E_k__BackingField>String</d2p1:_x003C_Uri_x003E_k__BackingField>
      </d2p1:IntegrationDestinationConfig>
    </d2p1:_x003C_DetinationConfigurations_x003E_k__BackingField>
    <d2p1:_x003C_IntegrationPartnerId_x003E_k__BackingField>0</d2p1:_x003C_IntegrationPartnerId_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>String</d2p1:_x003C_Name_x003E_k__BackingField>
    <d2p1:_x003C_OAuthSettings_x003E_k__BackingField>
      <d2p1:_x003C_AppRedirects_x003E_k__BackingField>
        <d2p1:OAuthAppRedirects>
          <d2p1:_x003C_AllowAnonymous_x003E_k__BackingField>false</d2p1:_x003C_AllowAnonymous_x003E_k__BackingField>
          <d2p1:_x003C_RedirectTemplate_x003E_k__BackingField>String</d2p1:_x003C_RedirectTemplate_x003E_k__BackingField>
          <d2p1:_x003C_Scope_x003E_k__BackingField>String</d2p1:_x003C_Scope_x003E_k__BackingField>
        </d2p1:OAuthAppRedirects>
      </d2p1:_x003C_AppRedirects_x003E_k__BackingField>
      <d2p1:_x003C_AuthorizeRedirectUri_x003E_k__BackingField>String</d2p1:_x003C_AuthorizeRedirectUri_x003E_k__BackingField>
      <d2p1:_x003C_AuthorizeUrl_x003E_k__BackingField>String</d2p1:_x003C_AuthorizeUrl_x003E_k__BackingField>
      <d2p1:_x003C_ChapId_x003E_k__BackingField>0</d2p1:_x003C_ChapId_x003E_k__BackingField>
      <d2p1:_x003C_ConsumerKey_x003E_k__BackingField>String</d2p1:_x003C_ConsumerKey_x003E_k__BackingField>
      <d2p1:_x003C_ConsumerSecret_x003E_k__BackingField>String</d2p1:_x003C_ConsumerSecret_x003E_k__BackingField>
      <d2p1:_x003C_NatId_x003E_k__BackingField>0</d2p1:_x003C_NatId_x003E_k__BackingField>
      <d2p1:_x003C_Password_x003E_k__BackingField>String</d2p1:_x003C_Password_x003E_k__BackingField>
      <d2p1:_x003C_SecurityToken_x003E_k__BackingField>String</d2p1:_x003C_SecurityToken_x003E_k__BackingField>
      <d2p1:_x003C_TokenUrl_x003E_k__BackingField>String</d2p1:_x003C_TokenUrl_x003E_k__BackingField>
      <d2p1:_x003C_UserInfoUrl_x003E_k__BackingField>String</d2p1:_x003C_UserInfoUrl_x003E_k__BackingField>
      <d2p1:_x003C_Username_x003E_k__BackingField>String</d2p1:_x003C_Username_x003E_k__BackingField>
    </d2p1:_x003C_OAuthSettings_x003E_k__BackingField>
    <d2p1:_x003C_Password_x003E_k__BackingField>String</d2p1:_x003C_Password_x003E_k__BackingField>
    <d2p1:_x003C_Scope_x003E_k__BackingField>String</d2p1:_x003C_Scope_x003E_k__BackingField>
    <d2p1:_x003C_Uri_x003E_k__BackingField>String</d2p1:_x003C_Uri_x003E_k__BackingField>
    <d2p1:_x003C_Username_x003E_k__BackingField>String</d2p1:_x003C_Username_x003E_k__BackingField>
  </Partner>
</IntegrationPartnerRs>