| All Verbs | /apikeys | ||
|---|---|---|---|
| All Verbs | /apikeys/{Environment} |
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 UserApiKey(IMeta):
key: Optional[str] = None
key_type: Optional[str] = None
expiry_date: Optional[datetime.datetime] = None
meta: Optional[Dict[str, str]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetApiKeysResponse(IMeta):
results: Optional[List[UserApiKey]] = None
meta: Optional[Dict[str, str]] = None
response_status: Optional[ResponseStatus] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetApiKeys(IGet, IMeta):
environment: Optional[str] = None
meta: Optional[Dict[str, str]] = None
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /apikeys HTTP/1.1
Host: notifications.breastcancertrials.org.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
environment: String,
meta:
{
String: String
}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
results:
[
{
key: String,
keyType: String,
expiryDate: "0001-01-01T00:00:00.0000000",
meta:
{
String: String
}
}
],
meta:
{
String: String
},
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}