| POST | /cmd/locations/devices/add |
|---|
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
Object = TypeVar('Object')
class DeviceUsageMode(IntEnum):
CLERK_SERVICED = 0
PERSONAL = 1
SELF_SERVICE = 2
UNKNOWN = -1
class DeviceUserInterface(IntEnum):
TABLET = 0
KIOSK = 1
DEFAULT = 2
UNKNOWN = -1
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Ref:
id: Optional[str] = None
val: Optional[str] = None
class DeviceManagement(IntEnum):
PARTNER = 1
PLATFORM = 2
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DeviceProfile:
usage_mode: Optional[DeviceUsageMode] = None
user_interface: Optional[DeviceUserInterface] = None
wallet: Optional[Ref] = None
managed_by: Optional[DeviceManagement] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Device:
id: Optional[str] = None
name: Optional[str] = None
is_active: bool = False
profile: Optional[DeviceProfile] = None
integrations_data: Optional[RecordDictionary[str, str]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AddLocationDevice:
id: Optional[str] = None
device: Optional[Device] = None
TKey = TypeVar('TKey')
TVal = TypeVar('TVal')
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RecordDictionary(Generic[TKey, TVal], Dict[TKey,TVal]):
pass
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 /cmd/locations/devices/add HTTP/1.1
Host: api.bettor.webhop.biz
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
id: String,
device:
{
id: String,
name: String,
isActive: False,
profile:
{
usageMode: 0,
userInterface: 0,
wallet:
{
id: String,
val: String
},
managedBy: 0
},
integrationsData:
{
String: String
}
}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}