| Requires any of the roles: | Agent, Administrator |
| 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 .xml suffix or ?format=xml
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/xml
Content-Type: application/xml
Content-Length: length
<BranchApptCreateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<ContactId>0</ContactId>
<Date>String</Date>
<LineIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
</LineIds>
<LocationId>00000000-0000-0000-0000-000000000000</LocationId>
<NewContact>
<Email>String</Email>
<Name>String</Name>
<Phone>String</Phone>
</NewContact>
<Note>String</Note>
<Notify>false</Notify>
<Overbook>false</Overbook>
<StartLocal>String</StartLocal>
<Via>String</Via>
</BranchApptCreateRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<BranchApptWriteResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<CalendarEventId>0</CalendarEventId>
<Capacity>0</Capacity>
<CheckInId>00000000-0000-0000-0000-000000000000</CheckInId>
<ContactExisted>false</ContactExisted>
<ContactId>0</ContactId>
<EndLocal>0001-01-01T00:00:00</EndLocal>
<Notified>false</Notified>
<Open>0</Open>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<StartLocal>0001-01-01T00:00:00</StartLocal>
</BranchApptWriteResponse>