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

HTTP + JSV

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