Billhighway Cloud API

KeyRequest

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

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class KeyResult(IHaveErrorField):
    key_name_value_pairs: Optional[Dict[str, int]] = None
    is_successful: Optional[bool] = None
    error_code: Optional[int] = None
    message: Optional[str] = None
    is_error: Optional[bool] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class KeyRequest(KeyRequest):
    pass

Python 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
}