Billhighway Cloud API

<back to all web services

IntegrationPartnerGetRq

The following routes are available for this service:
GET/signup/api/integration/partner/{name}
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BH.Partner.Integration.Service;
using BH.Partner.Integration;

namespace BH.Partner.Integration
{
    public enum DestinationUriType
    {
        None = 0,
        Absolute = 1,
        Relative = 2,
    }

    public partial class IntegrationDestinationConfig
    {
        public virtual string Type { get; set; }
        public virtual DestinationUriType UriType { get; set; }
        public virtual string Uri { get; set; }
        public virtual string AuthenticationKey { get; set; }
    }

    public partial class IntegrationPartner
    {
        public IntegrationPartner()
        {
            DetinationConfigurations = new List<IntegrationDestinationConfig>{};
        }

        public virtual int IntegrationPartnerId { get; set; }
        public virtual string Name { get; set; }
        public virtual string Description { get; set; }
        public virtual string Uri { get; set; }
        public virtual string Username { get; set; }
        public virtual string Password { get; set; }
        public virtual string ApiKey { get; set; }
        public virtual IntegrationPartnerOAuthSettings OAuthSettings { get; set; }
        public virtual List<IntegrationDestinationConfig> DetinationConfigurations { get; set; }
        public virtual string Scope { get; set; }
    }

    public partial class IntegrationPartnerOAuthSettings
    {
        public IntegrationPartnerOAuthSettings()
        {
            AppRedirects = new List<OAuthAppRedirects>{};
        }

        public virtual int NatId { get; set; }
        public virtual int ChapId { get; set; }
        public virtual string AuthorizeUrl { get; set; }
        public virtual string AuthorizeRedirectUri { get; set; }
        public virtual string TokenUrl { get; set; }
        public virtual string UserInfoUrl { get; set; }
        public virtual string ConsumerKey { get; set; }
        public virtual string ConsumerSecret { get; set; }
        public virtual string Username { get; set; }
        public virtual string Password { get; set; }
        public virtual string SecurityToken { get; set; }
        public virtual List<OAuthAppRedirects> AppRedirects { get; set; }
    }

    public partial class OAuthAppRedirects
    {
        public virtual string Scope { get; set; }
        public virtual string RedirectTemplate { get; set; }
        public virtual bool AllowAnonymous { get; set; }
    }

}

namespace BH.Partner.Integration.Service
{
    public partial class IntegrationPartnerGetRq
        : IApiRequest
    {
        public virtual string Name { get; set; }
    }

    public partial class IntegrationPartnerRs
        : IApiResponse
    {
        public virtual IntegrationPartner Partner { get; set; }
    }

}

C# 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>