Billhighway Cloud API

KeyRequest

The following routes are available for this service:
POST	/api/keys/generate

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BH.CloudAPI.Common4.DTO
Imports BH.CloudAPI.Common.DTO

Namespace Global

    Namespace BH.CloudAPI.Common.DTO

        Public Partial Class KeyResult
            Implements IHaveErrorField
            Public Sub New()
                KeyNameValuePairs = New Dictionary(Of String, Long)
            End Sub

            Public Overridable Property KeyNameValuePairs As Dictionary(Of String, Long)
            Public Overridable Property IsSuccessful As Boolean
            Public Overridable Property ErrorCode As Integer
            Public Overridable Property Message As String
            Public Overridable Property IsError As Boolean
        End Class
    End Namespace

    Namespace BH.CloudAPI.Common4.DTO

        Public Partial Class KeyRequest
            Inherits KeyRequest
        End Class
    End Namespace
End Namespace

VB.NET KeyRequest 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.

POST /api/keys/generate HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Keys: 
	[
		{
			Name: String,
			NumberRequested: 0
		}
	],
	DbName: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	KeyNameValuePairs: 
	{
		String: 0
	},
	IsSuccessful: False,
	ErrorCode: 0,
	Message: String,
	IsError: True
}