Billhighway Cloud API

IntegrationPartnerGetRq

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


export class OAuthAppRedirects
{
    public Scope?: string;
    public RedirectTemplate?: string;
    public AllowAnonymous?: boolean;

    public constructor(init?: Partial<OAuthAppRedirects>) { (Object as any).assign(this, init); }
}

export class IntegrationPartnerOAuthSettings
{
    public NatId?: number;
    public ChapId?: number;
    public AuthorizeUrl?: string;
    public AuthorizeRedirectUri?: string;
    public TokenUrl?: string;
    public UserInfoUrl?: string;
    public ConsumerKey?: string;
    public ConsumerSecret?: string;
    public Username?: string;
    public Password?: string;
    public SecurityToken?: string;
    public AppRedirects?: OAuthAppRedirects[];

    public constructor(init?: Partial<IntegrationPartnerOAuthSettings>) { (Object as any).assign(this, init); }
}

export enum DestinationUriType
{
    None = 0,
    Absolute = 1,
    Relative = 2,
}

export class IntegrationDestinationConfig
{
    public Type?: string;
    public UriType?: DestinationUriType;
    public Uri?: string;
    public AuthenticationKey?: string;

    public constructor(init?: Partial<IntegrationDestinationConfig>) { (Object as any).assign(this, init); }
}

export class IntegrationPartner
{
    public IntegrationPartnerId?: number;
    public Name?: string;
    public Description?: string;
    public Uri?: string;
    public Username?: string;
    public Password?: string;
    public ApiKey?: string;
    public OAuthSettings?: IntegrationPartnerOAuthSettings;
    public DetinationConfigurations?: IntegrationDestinationConfig[];
    public Scope?: string;

    public constructor(init?: Partial<IntegrationPartner>) { (Object as any).assign(this, init); }
}

export class IntegrationPartnerRs implements IApiResponse
{
    public Partner?: IntegrationPartner;

    public constructor(init?: Partial<IntegrationPartnerRs>) { (Object as any).assign(this, init); }
}

export class IntegrationPartnerGetRq implements IApiRequest
{
    public Name?: string;

    public constructor(init?: Partial<IntegrationPartnerGetRq>) { (Object as any).assign(this, init); }
}

TypeScript 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>