| Requires any of the roles: | Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator |
| GET,POST,DELETE,OPTIONS | /v1/CustomerCheckins/{Id} | ||
|---|---|---|---|
| GET,POST,DELETE,OPTIONS | /v1/CustomerCheckins |
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 CustomerCheckinObject:
id: Optional[str] = None
line_id: Optional[str] = None
customer_id: Optional[str] = None
employee_id: Optional[str] = None
location_id: Optional[str] = None
station_id: Optional[str] = None
sign_in_time: datetime.datetime = datetime.datetime(1, 1, 1)
adjusted_sign_in_time: datetime.datetime = datetime.datetime(1, 1, 1)
send_reminders: bool = False
status: int = 0
task_time: int = 0
completed: bool = False
completed_time: datetime.datetime = datetime.datetime(1, 1, 1)
questionnaire_submitted: bool = False
line_ids: List[str] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LineQuestion:
id: int = 0
customer_check_in_id: Optional[str] = None
line_id: Optional[str] = None
question: Optional[str] = None
answer: Optional[str] = None
active: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LineImage:
image_id: Optional[str] = None
file_name: Optional[str] = None
image_title: Optional[str] = None
upload_date: datetime.datetime = datetime.datetime(1, 1, 1)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Line:
id: Optional[str] = None
location_id: Optional[str] = None
location_name: Optional[str] = None
name: Optional[str] = None
description: Optional[str] = None
service_duration_minutes: int = 0
wait_time: int = 0
cost: Decimal = decimal.Decimal(0)
upper_threshold: Optional[int] = None
lower_threshold: Optional[int] = None
active: bool = False
ent_date: Optional[datetime.datetime] = None
mod_date: Optional[datetime.datetime] = None
send_questionnaire: bool = False
require_upload: bool = False
upload_message: Optional[str] = None
line_images: List[LineImage] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CheckinInformation:
id: Optional[str] = None
location_id: Optional[str] = None
location_name: Optional[str] = None
customer_id: Optional[str] = None
questionnaire_submitted: Optional[bool] = None
name: Optional[str] = None
description: Optional[str] = None
total_service_duration_minutes: int = 0
total_cost: Decimal = decimal.Decimal(0)
send_questionnaire: bool = False
require_upload: bool = False
questions: List[LineQuestion] = field(default_factory=list)
lines: List[Line] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CustomerCheckinsResponse:
response_status: Optional[ResponseStatus] = None
customer_checkins: List[CustomerCheckinObject] = field(default_factory=list)
customer_checkin_requirements: Optional[CheckinInformation] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CustomerCheckins(CustomerCheckinObject):
api_key: Optional[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 /v1/CustomerCheckins/{Id} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
ApiKey: 00000000000000000000000000000000,
Id: 00000000000000000000000000000000,
LineId: 00000000000000000000000000000000,
CustomerId: 00000000000000000000000000000000,
EmployeeId: 00000000000000000000000000000000,
LocationId: 00000000000000000000000000000000,
StationId: 00000000000000000000000000000000,
SignInTime: 0001-01-01,
AdjustedSignInTime: 0001-01-01,
SendReminders: False,
Status: 0,
TaskTime: 0,
Completed: False,
CompletedTime: 0001-01-01,
QuestionnaireSubmitted: False,
LineIds:
[
00000000000000000000000000000000
]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
},
CustomerCheckins:
[
{
Id: 00000000000000000000000000000000,
LineId: 00000000000000000000000000000000,
CustomerId: 00000000000000000000000000000000,
EmployeeId: 00000000000000000000000000000000,
LocationId: 00000000000000000000000000000000,
StationId: 00000000000000000000000000000000,
SignInTime: 0001-01-01,
AdjustedSignInTime: 0001-01-01,
SendReminders: False,
Status: 0,
TaskTime: 0,
Completed: False,
CompletedTime: 0001-01-01,
QuestionnaireSubmitted: False,
LineIds:
[
00000000000000000000000000000000
]
}
],
CustomerCheckinRequirements:
{
Id: 00000000000000000000000000000000,
LocationId: 00000000000000000000000000000000,
LocationName: String,
CustomerId: 00000000000000000000000000000000,
QuestionnaireSubmitted: False,
Name: String,
Description: String,
TotalServiceDurationMinutes: 0,
TotalCost: 0,
SendQuestionnaire: False,
RequireUpload: False,
Questions:
[
{
Id: 0,
CustomerCheckInId: 00000000000000000000000000000000,
LineId: 00000000000000000000000000000000,
Question: String,
Answer: String,
Active: False
}
],
Lines:
[
{
Id: 00000000000000000000000000000000,
LocationId: 00000000000000000000000000000000,
LocationName: String,
Name: String,
Description: String,
ServiceDurationMinutes: 0,
WaitTime: 0,
Cost: 0,
UpperThreshold: 0,
LowerThreshold: 0,
Active: False,
EntDate: 0001-01-01,
ModDate: 0001-01-01,
SendQuestionnaire: False,
RequireUpload: False,
UploadMessage: String,
LineImages:
[
{
ImageId: 00000000000000000000000000000000,
FileName: String,
ImageTitle: String,
UploadDate: 0001-01-01
}
]
}
]
}
}