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
BranchApptCreateRequest Parameters:
NameParameterData TypeRequiredDescription
LocationIdbodyGuidNo
DatebodystringNo
StartLocalbodystringNo
LineIdsbodyList<Guid>No
ContactIdbodyint?No
NewContactbodyBranchApptNewContactNo
ViabodystringNo
NotifybodyboolNo
NotebodystringNo
OverbookbodyboolNo
BranchApptNewContact Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
PhoneformstringNo
EmailformstringNo
BranchApptWriteResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
CalendarEventIdformintNo
CheckInIdformGuidNo
StartLocalformDateTime?No
EndLocalformDateTime?No
ContactIdformintNo
ContactExistedformboolNo
NotifiedformboolNo
Openformint?No
Capacityformint?No

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

HTTP + OTHER

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: text/jsonl
Content-Type: text/jsonl
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: text/jsonl
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}