Trendsic Platform Service

<back to all web services

BranchApptChangeRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
POST,OPTIONS/v1/queue/appointments/{CheckInId}/change
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 BranchApptChangeRequest:
    check_in_id: Optional[str] = None
    date: Optional[str] = None
    start_local: Optional[str] = None
    line_ids: List[str] = field(default_factory=list)
    notify: bool = False
    reason: Optional[str] = None
    note: Optional[str] = None
    overbook: bool = False

Python BranchApptChangeRequest DTOs

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

HTTP + JSV

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

POST /v1/queue/appointments/{CheckInId}/change HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CheckInId: 00000000000000000000000000000000,
	Date: String,
	StartLocal: String,
	LineIds: 
	[
		00000000000000000000000000000000
	],
	Notify: False,
	Reason: String,
	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
}