Trendsic Platform Service

<back to all web services

CustomerCheckinsPut

The following routes are available for this service:
PUT/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 CustomerCheckinsPutResponse:
    response_status: Optional[ResponseStatus] = None
    success: bool = False


@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 CustomerCheckinsPut:
    api_key: Optional[str] = None
    checkins: List[CustomerCheckinObject] = field(default_factory=list)

Python CustomerCheckinsPut DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /v1/CustomerCheckins HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ApiKey":"00000000000000000000000000000000","Checkins":[{"Id":"00000000000000000000000000000000","LineId":"00000000000000000000000000000000","CustomerId":"00000000000000000000000000000000","EmployeeId":"00000000000000000000000000000000","LocationId":"00000000000000000000000000000000","StationId":"00000000000000000000000000000000","SignInTime":"0001-01-01T00:00:00.0000000","AdjustedSignInTime":"0001-01-01T00:00:00.0000000","SendReminders":false,"Status":0,"TaskTime":0,"Completed":false,"CompletedTime":"0001-01-01T00:00:00.0000000","QuestionnaireSubmitted":false,"LineIds":["00000000000000000000000000000000"]}]}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Success":false}