| Requires any of the roles: | Agent, Administrator |
| POST,OPTIONS | /v1/queue/appointments |
|---|
export class BranchApptWriteResponse
{
public ResponseStatus: ResponseStatus;
public CalendarEventId: number;
public CheckInId: string;
public StartLocal?: string;
public EndLocal?: string;
public ContactId: number;
public ContactExisted: boolean;
public Notified: boolean;
public Open?: number;
public Capacity?: number;
public constructor(init?: Partial<BranchApptWriteResponse>) { (Object as any).assign(this, init); }
}
export class BranchApptNewContact
{
public Name: string;
public Phone: string;
public Email: string;
public constructor(init?: Partial<BranchApptNewContact>) { (Object as any).assign(this, init); }
}
export class BranchApptCreateRequest
{
public LocationId: string;
public Date: string;
public StartLocal: string;
public LineIds: string[] = [];
public ContactId?: number;
public NewContact: BranchApptNewContact;
public Via: string;
public Notify: boolean;
public Note: string;
public Overbook: boolean;
public constructor(init?: Partial<BranchApptCreateRequest>) { (Object as any).assign(this, init); }
}
TypeScript BranchApptCreateRequest DTOs
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/queue/appointments HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
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/jsv
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-01,
EndLocal: 0001-01-01,
ContactId: 0,
ContactExisted: False,
Notified: False,
Open: 0,
Capacity: 0
}