POST Appointments/Checkin

Check-in (Enqueue/Arrive) an appointment

Request Information

URI Parameters

None.

Body Parameters

Appointment identification

Name	Description	Type	Additional information
CaseId	Case ID (Booking ID) of the appointment (optional)	integer	None.
ProcessId	Process ID of the appointment (optional)	integer	None.
PersonalId	Vendor's Customer identifier (optional) If using this, the next appointment for today for this customer shall be enqueued	string	Max length: 30
ForceEarlyLate	Ignore Early/Late/Prevent Auto-Queue warnings by force enqueuing?	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "CaseId": 1,
  "ProcessId": 1,
  "PersonalId": "sample string 1",
  "ForceEarlyLate": true
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Case information

CaseDetail

Name	Description	Type	Additional information
CaseId	Case Id	integer	None.
ProcessId	Process Id (typically 1:1 with Case Id)	integer	None.
ProcessGuid		globally unique identifier	None.
Ticket	Ticket Number allocated (QCode+QNumber)	string	Max length: 20
CaseDateCreated	Date/Time the case was created	date	None.
ReferenceDate		date	None.
ArrivalTime	Actual arrival Date/Time	date	None.
TimeZoneOffset	Time Zone Offset in minutes from the server (-120 = 2 hours behind server)	integer	None.
LastUpdated	Last Date/Time that something happened to the case (when closed, = closed date)	date	None.
CaseStatus	Case Status (0=Active/1=Closed)	integer	None.
CaseStatusDesc	Case Status Description (Active/Closed)	string	Max length: 150
ProcessStatus	Process Status (0=Active/1=Closed/2=Pending)	integer	None.
ProcessStatusDesc	Process Status Description (Active/Pending/Closed)	string	Max length: 150
Subject	Case Subject field	string	Max length: 150
ExtRef	Case External Reference	string	Max length: 200
Customer	Associated Customer record (if any)	Customer	None.
UserName	Last agent User/Login Name	string	Max length: 250
UserFirstName	Last agent User first Name	string	Max length: 25
UserLastName	Last agent User last Name	string	Max length: 25
UserServedName	Last serving agent FULL Name (first last) (if applic)	string	Max length: 51
ServiceId	Current Service Id	integer	None.
ServiceName	Current Service Name	string	Max length: 50
ServiceDesc		string	Max length: 50
Action	Step Action (0=Enqueue/1=Call Next/2=Call Case/7=Complete/8=Return To Queue/9=Hold/10=Release/13=Set Appointment etc, etc)	integer	None.
ActionDesc	Step Action Description (Enqueue/Call Next/Call Case/Complete/Return To Queue/Hold/Release/Set Appointment etc, etc)	string	None.
EntityStatus	Process Entity Status (0=Expected/3=Waiting/6=InService/8=Completed/11=WaitWithRules/12=ServeThenWaitCustomer/15=Cancelled etc, etc)	integer	None.
EntityStatusDesc	Process Entity Status Description (Expected/Waiting/InService/Completed/WaitWithRules/WaitCustomer/Cancelled etc, etc)	string	None.
Resolution	Process Resolution (null/0=Complete/1=Cancelled/2=NoShow/3=Abandoned/4=Aborted/5=Rescheduled)	integer	None.
ResolutionDesc	Process Resolution Description (null/Complete/Cancelled/NoShow/Abandoned/Aborted/Rescheduled)	string	Max length: 150
UnitId	Unit Id	integer	None.
UnitName	Unit Name	string	Max length: 50
UnitDescription		string	Max length: 250
UnitTypeId		integer	None.
UnitParentName		string	Max length: 50
ParentUnitTypeId		integer	None.
UnitPath	Unit Path Name (ie \NEXA\NSW\Bondi Junction)	string	Max length: 2000
LocationName	Current counter name (if applic)	string	Max length: 50
LocationServedName	Served at counter name (if applic)	string	Max length: 50
LanguageCode	Language Code ie: en	string	Max length: 6
IsDirectAdmit	Was the case Direct Admitted in the Service Console	boolean	None.
AppointmentTypeName	Appointment Type Name	string	Max length: 50
QueuePosition	Position in the service queue. 0 based	integer	None.
WaitTimeEst	Estimated remaining wait time if waiting status (ceiling minutes = estimated wait - actual waited time)	integer	None.
CustomProperties	Collection of all custom properties for this case process	Dictionary of string [key] and string [value]	None.

Response Formats

application/json, text/json

Sample:

{
  "CaseId": 1,
  "ProcessId": 2,
  "ProcessGuid": "c02b8443-e2c3-4acb-a30a-a60ae6cee62a",
  "Ticket": "sample string 4",
  "CaseDateCreated": "2025-09-13T08:26:07.6348032+10:00",
  "ReferenceDate": "2025-09-13T08:26:07.6348032+10:00",
  "ArrivalTime": "2025-09-13T08:26:07.6348032+10:00",
  "TimeZoneOffset": 8,
  "LastUpdated": "2025-09-13T08:26:07.6348032+10:00",
  "CaseStatus": 10,
  "CaseStatusDesc": "sample string 11",
  "ProcessStatus": 12,
  "ProcessStatusDesc": "sample string 13",
  "Subject": "sample string 14",
  "ExtRef": "sample string 15",
  "Customer": {
    "CustomerId": 1,
    "PersonalId": "sample string 2",
    "PersonalIdTypeId": 1,
    "PersonalIdTypeExtRef": "sample string 3",
    "FirstName": "sample string 4",
    "LastName": "sample string 5",
    "Email": "sample string 6",
    "TelNumber1": "sample string 7",
    "TelNumber2": "sample string 8",
    "DOB": "2025-09-13T08:26:07.6348032+10:00",
    "Sex": 64,
    "Notes": "sample string 9",
    "ExtRef": "sample string 10",
    "NotificationConsent": true,
    "IsActive": true,
    "CustomProperties": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    }
  },
  "UserName": "sample string 16",
  "UserFirstName": "sample string 17",
  "UserLastName": "sample string 18",
  "UserServedName": "sample string 19",
  "ServiceId": 20,
  "ServiceName": "sample string 21",
  "ServiceDesc": "sample string 22",
  "Action": 23,
  "ActionDesc": "sample string 24",
  "EntityStatus": 25,
  "EntityStatusDesc": "sample string 26",
  "Resolution": 27,
  "ResolutionDesc": "sample string 28",
  "UnitId": 29,
  "UnitName": "sample string 30",
  "UnitDescription": "sample string 31",
  "UnitTypeId": 32,
  "UnitParentName": "sample string 33",
  "ParentUnitTypeId": 34,
  "UnitPath": "sample string 35",
  "LocationName": "sample string 36",
  "LocationServedName": "sample string 37",
  "LanguageCode": "sample string 38",
  "IsDirectAdmit": true,
  "AppointmentTypeName": "sample string 40",
  "QueuePosition": 41,
  "WaitTimeEst": 42,
  "CustomProperties": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}