Billhighway Cloud API

IntegrationPartnerGetRq

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

namespace BH.Partner.Integration

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type OAuthAppRedirects() = 
        member val Scope:String = null with get,set
        member val RedirectTemplate:String = null with get,set
        member val AllowAnonymous:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type IntegrationPartnerOAuthSettings() = 
        member val NatId:Int32 = new Int32() with get,set
        member val ChapId:Int32 = new Int32() with get,set
        member val AuthorizeUrl:String = null with get,set
        member val AuthorizeRedirectUri:String = null with get,set
        member val TokenUrl:String = null with get,set
        member val UserInfoUrl:String = null with get,set
        member val ConsumerKey:String = null with get,set
        member val ConsumerSecret:String = null with get,set
        member val Username:String = null with get,set
        member val Password:String = null with get,set
        member val SecurityToken:String = null with get,set
        member val AppRedirects:ResizeArray<OAuthAppRedirects> = new ResizeArray<OAuthAppRedirects>() with get,set

    type DestinationUriType =
        | None = 0
        | Absolute = 1
        | Relative = 2

    [<AllowNullLiteral>]
    type IntegrationDestinationConfig() = 
        member val Type:String = null with get,set
        member val UriType:DestinationUriType = new DestinationUriType() with get,set
        member val Uri:String = null with get,set
        member val AuthenticationKey:String = null with get,set

    [<AllowNullLiteral>]
    type IntegrationPartner() = 
        member val IntegrationPartnerId:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val Description:String = null with get,set
        member val Uri:String = null with get,set
        member val Username:String = null with get,set
        member val Password:String = null with get,set
        member val ApiKey:String = null with get,set
        member val OAuthSettings:IntegrationPartnerOAuthSettings = null with get,set
        member val DetinationConfigurations:ResizeArray<IntegrationDestinationConfig> = new ResizeArray<IntegrationDestinationConfig>() with get,set
        member val Scope:String = null with get,set

    [<AllowNullLiteral>]
    type IntegrationPartnerRs() = 
        member val Partner:IntegrationPartner = null with get,set

    [<AllowNullLiteral>]
    type IntegrationPartnerGetRq() = 
        member val Name:String = null with get,set

F# 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
	}
}