Trendsic Platform Service

<back to all web services

BranchApptCreateRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
POST,OPTIONS/v1/queue/appointments
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 BranchApptWriteResponse:
    response_status: Optional[ResponseStatus] = None
    calendar_event_id: int = 0
    check_in_id: Optional[str] = None
    start_local: Optional[datetime.datetime] = None
    end_local: Optional[datetime.datetime] = None
    contact_id: int = 0
    contact_existed: bool = False
    notified: bool = False
    open: Optional[int] = None
    capacity: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BranchApptNewContact:
    name: Optional[str] = None
    phone: Optional[str] = None
    email: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BranchApptCreateRequest:
    location_id: Optional[str] = None
    date: Optional[str] = None
    start_local: Optional[str] = None
    line_ids: List[str] = field(default_factory=list)
    contact_id: Optional[int] = None
    new_contact: Optional[BranchApptNewContact] = None
    via: Optional[str] = None
    notify: bool = False
    note: Optional[str] = None
    overbook: bool = False

Python BranchApptCreateRequest 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.

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

{"LocationId":"00000000000000000000000000000000","Date":"String","StartLocal":"String","LineIds":["00000000000000000000000000000000"],"ContactId":0,"NewContact":{"Name":"String","Phone":"String","Email":"String"},"Via":"String","Notify":false,"Note":"String","Overbook":false}
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"}},"CalendarEventId":0,"CheckInId":"00000000000000000000000000000000","StartLocal":"0001-01-01T00:00:00.0000000","EndLocal":"0001-01-01T00:00:00.0000000","ContactId":0,"ContactExisted":false,"Notified":false,"Open":0,"Capacity":0}