Billhighway Cloud API

IntegrationPartnerGetRq

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

**IntegrationPartnerGetRq** Parameters:
Name	Parameter	Data Type	Required	Description
Name	path	string	No

**IntegrationPartnerRs** Parameters:
Name	Parameter	Data Type	Required	Description
Partner	form	IntegrationPartner	No

**IntegrationPartner** Parameters:
Name	Parameter	Data Type	Required
IntegrationPartnerId	form	int	No
Name	form	string	No
Description	form	string	No
Uri	form	string	No
Username	form	string	No
Password	form	string	No
ApiKey	form	string	No
OAuthSettings	form	IntegrationPartnerOAuthSettings	No
DetinationConfigurations	form	List<IntegrationDestinationConfig>	No
Scope	form	string	No

**IntegrationPartnerOAuthSettings** Parameters:
Name	Parameter	Data Type	Required
NatId	form	int	No
ChapId	form	int	No
AuthorizeUrl	form	string	No
AuthorizeRedirectUri	form	string	No
TokenUrl	form	string	No
UserInfoUrl	form	string	No
ConsumerKey	form	string	No
ConsumerSecret	form	string	No
Username	form	string	No
Password	form	string	No
SecurityToken	form	string	No
AppRedirects	form	List<OAuthAppRedirects>	No

**OAuthAppRedirects** Parameters:
Name	Parameter	Data Type	Required
Scope	form	string	No
RedirectTemplate	form	string	No
AllowAnonymous	form	bool	No

**IntegrationDestinationConfig** Parameters:
Name	Parameter	Data Type	Required
Type	form	string	No
UriType	form	DestinationUriType	No
Uri	form	string	No
AuthenticationKey	form	string	No

**DestinationUriType** Enum:
Name	Value
None	0
Absolute	1
Relative	2

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>