| 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
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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/xml
Content-Type: application/xml
Content-Length: length
<KeyRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://www.billhighway.com/api">
<DbName xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</DbName>
<Keys xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">
<Keys>
<Name>String</Name>
<NumberRequested>0</NumberRequested>
</Keys>
</Keys>
</KeyRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<KeyResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">
<ErrorCode>0</ErrorCode>
<IsSuccessful>false</IsSuccessful>
<KeyNameValuePairs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringlong>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value>0</d2p1:Value>
</d2p1:KeyValueOfstringlong>
</KeyNameValuePairs>
<Message>String</Message>
</KeyResult>