Billhighway Cloud API

IntegrationPartnerGetRq

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

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BH.Partner.Integration.Service
Imports BH.Partner.Integration

Namespace Global

    Namespace BH.Partner.Integration

        Public Enum DestinationUriType
            None = 0
            Absolute = 1
            Relative = 2
        End Enum

        Public Partial Class IntegrationDestinationConfig
            Public Overridable Property Type As String
            Public Overridable Property UriType As DestinationUriType
            Public Overridable Property Uri As String
            Public Overridable Property AuthenticationKey As String
        End Class

        Public Partial Class IntegrationPartner
            Public Sub New()
                DetinationConfigurations = New List(Of IntegrationDestinationConfig)
            End Sub

            Public Overridable Property IntegrationPartnerId As Integer
            Public Overridable Property Name As String
            Public Overridable Property Description As String
            Public Overridable Property Uri As String
            Public Overridable Property Username As String
            Public Overridable Property Password As String
            Public Overridable Property ApiKey As String
            Public Overridable Property OAuthSettings As IntegrationPartnerOAuthSettings
            Public Overridable Property DetinationConfigurations As List(Of IntegrationDestinationConfig)
            Public Overridable Property Scope As String
        End Class

        Public Partial Class IntegrationPartnerOAuthSettings
            Public Sub New()
                AppRedirects = New List(Of OAuthAppRedirects)
            End Sub

            Public Overridable Property NatId As Integer
            Public Overridable Property ChapId As Integer
            Public Overridable Property AuthorizeUrl As String
            Public Overridable Property AuthorizeRedirectUri As String
            Public Overridable Property TokenUrl As String
            Public Overridable Property UserInfoUrl As String
            Public Overridable Property ConsumerKey As String
            Public Overridable Property ConsumerSecret As String
            Public Overridable Property Username As String
            Public Overridable Property Password As String
            Public Overridable Property SecurityToken As String
            Public Overridable Property AppRedirects As List(Of OAuthAppRedirects)
        End Class

        Public Partial Class OAuthAppRedirects
            Public Overridable Property Scope As String
            Public Overridable Property RedirectTemplate As String
            Public Overridable Property AllowAnonymous As Boolean
        End Class
    End Namespace

    Namespace BH.Partner.Integration.Service

        Public Partial Class IntegrationPartnerGetRq
            Implements IApiRequest
            Public Overridable Property Name As String
        End Class

        Public Partial Class IntegrationPartnerRs
            Implements IApiResponse
            Public Overridable Property Partner As IntegrationPartner
        End Class
    End Namespace
End Namespace

VB.NET IntegrationPartnerGetRq DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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/csv

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