| GET | /pulsit/profile |
|---|
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 ApiServiceRequest(IServiceRequest, IHasApiKey):
# @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
api_key: Optional[str] = None
"""
The API Key required for authentication
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ApiServiceResponse(IServiceResponse):
description: Optional[str] = None
heading: Optional[str] = None
was_successful: bool = False
model_state: Optional[Object] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PulsitModuleStatusItem:
pulsit_module_id: Optional[str] = None
latitude: float = 0.0
longitude: float = 0.0
event_description: Optional[str] = None
event_time: datetime.datetime = datetime.datetime(1, 1, 1)
status: Optional[str] = None
pulsit_start_id: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PulsitProfileProductItem:
product: Optional[str] = None
make: Optional[str] = None
model: Optional[str] = None
year: Optional[str] = None
registration_number: Optional[str] = None
pulsit_module_id: Optional[str] = None
latest_status: Optional[PulsitModuleStatusItem] = None
class DeviceType(IntEnum):
LOCK = 0
HOME_SECURITY = 1
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PulsitProfileDeviceItem:
pulsit_module_id: Optional[str] = None
product: Optional[str] = None
description: Optional[str] = None
type: Optional[DeviceType] = None
type_string: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PulsitProfileResponse(ApiServiceResponse):
products: Optional[List[PulsitProfileProductItem]] = None
devices: Optional[List[PulsitProfileDeviceItem]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PulsitProfileRequest(ApiServiceRequest):
id_number: Optional[str] = None
Python PulsitProfileRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /pulsit/profile HTTP/1.1 Host: galaxymobile.api.client.prod.86degrees.com Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"Products":[{"Product":"String","Make":"String","Model":"String","Year":"String","RegistrationNumber":"String","PulsitModuleId":"String","LatestStatus":{"PulsitModuleId":"String","Latitude":0,"Longitude":0,"EventDescription":"String","EventTime":"0001-01-01T00:00:00.0000000","Status":"String","PulsitStartId":0}}],"Devices":[{"PulsitModuleId":"String","Product":"String","Description":"String","Type":0,"TypeString":"Lock"}],"Description":"String","Heading":"String","WasSuccessful":false,"ModelState":{}}