Billhighway Cloud API

<back to all web services

KeyRequest

The following routes are available for this service:
POST/api/keys/generate
KeyResult Parameters:
NameParameterData TypeRequiredDescription
KeyNameValuePairsformDictionary<string, long>No
IsSuccessfulformboolNo
ErrorCodeformintNo
MessageformstringNo
IsErrorformboolNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

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

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"KeyNameValuePairs":{"String":0},"IsSuccessful":false,"ErrorCode":0,"Message":"String","IsError":true}