POST Agents/Appointment/GetContactAppointments
Some tooltip text!
• 8 minutes to read
• 8 minutes to read
POST /api/v1/Agents/Appointment/GetContactAppointments
Method that returns a specified number of appointments within a time range.
The appointments belong to the contact specified. If the logged on user is not allowed to view this persons appointments an exception is thrown.
Query String Parameters
| Parameter Name | Type | Description |
|---|---|---|
| $select | string | Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields. |
POST /api/v1/Agents/Appointment/GetContactAppointments?$select=name,department,category/id
Request Headers
| Parameter Name | Description |
|---|---|
| Authorization | Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type. |
| X-XSRF-TOKEN | If not using Authorization header, you must provide XSRF value from cookie or hidden input field |
| Content-Type | Content-type of the request body: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, application/json-patch+json, application/merge-patch+json |
| Accept | Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json |
| Accept-Language | Convert string references and multi-language values into a specified language (iso2) code. |
| SO-Language | Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value. |
| SO-Culture | Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set. |
| SO-TimeZone | Specify the timezone code that you would like date/time responses converted to. |
| SO-AppToken | The application token that identifies the partner app. Used when calling Online WebAPI from a server. |
Request Body: request
ContactId, StartTime, EndTime, Count
| Property Name | Type | Description |
|---|---|---|
| ContactId | Integer | |
| StartTime | String | |
| EndTime | String | |
| Count | Integer |
Response:array
OK
| Response | Description |
|---|---|
| 200 | OK |
Response body: array
| Property Name | Type | Description |
|---|---|---|
| AppointmentId | int32 | Primary key |
| StartDate | date-time | date + start time planned |
| EndDate | date-time | Date + end time planned |
| Type | string | The different types of appointment, if the appointment is supposed to be shown in the diary or checklist, or if it's a document. See the different types of appointments in the database manual. |
| Task | string | Task comprises the different types of activities, like “Phone call”, “Meeting” and so on. |
| AssociateFullName | string | The owner of the appointment - the associate whose diary/checklist the appointment is in. |
| ContactName | string | The contact associated with the appointment. |
| Description | string | The appointment's textbox; holds a descriptive text about the appointment. Filled out by the user. |
| PersonFullName | string | The full name of the person this appointment belongs to. |
| PersonId | int32 | Person ID of person the appointment is with, may be 0 |
| ContactId | int32 | Contact ID of owning contact, may be 0 |
| ProjectId | int32 | ID of project referred to, may be 0 |
| ProjectName | string | The name of the project this appointment belong to. Blank if no project is connected. |
| IsPublished | bool | True if appointment have an entry in published table |
| AssociateId | int32 | ID of associate whose diary the appointment is in, REQUIRED |
| ColorIndex | int32 | Appointment colour, used only in Japanese versions. Western versions take colour from Task |
| IsFree | bool | True if free, false if busy |
| HasAlarm | bool | Does this appointment have an alarm |
| IsAlldayEvent | bool | True if all day event |
| Private | string | Obsolete, but still maintained field for appointment privacy; denormalization of visiblefor status |
| PriorityId | int32 | Link to priority list |
| PriorityName | string | Name of the appointments priority |
| TaskType | string | The different task types of the appointment, if the activity is an appointment, task, phone. See the different types of appointments in the database manual. |
| IsBookingMain | bool | True if this appointment is a booking and current associate is the owner. False if it is a booking and current associate is a participant. |
| IsRecurrence | bool | True if the appointment is part of a recurring pattern. |
| IsBooking | bool | True if this appointment is a booking. |
| ActiveDate | date-time | The date to be used for searching & showing |
| AssignmentStatus | string | Status if this appointment is in the process of being assigned to someone else |
| InvitationStatus | string | Status if this appointment represents an invitation |
| BookingType | string | The type of booking the appointment represents |
| Completed | string | The Completed state. |
| RecurringPattern | string | |
| RecurringStartDate | date-time | |
| RecurringEndDate | date-time | |
| MotherId | int32 | ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment. However, if 0 and assoc_id != reg_id then this is an assigned appointment, indicated vt type = kBooking |
| AssignedBy | int32 | Who (last) assigned this appointment to associate_id? |
| AssignedByFullName | string | The associate's culture formatted fullname (firstname, middleName and lastname) |
| RejectReason | string | Why was this booking or assignment rejected, the RejectReason list is a source of suggestions but you can write anything here |
| Location | string | Location for appointment, defaulted from invited resource of type place and other rules, but you can write anything you want here |
| AlarmLeadTime | string | Alarm lead time. |
| SaleId | int32 | Owning sale, if any (may be 0) |
| SaleName | string | Heading of Owning sale, if any. (may be blank) |
| AssociateName | string | The associate's name |
| CreatedDate | date-time | Appointment creation date |
| CreatedBy | string | Who created the appointment. Associate name. |
| CreatedByFullName | string | Who created the appointment. Full name. |
| CreatedByAssociateId | int32 | Id of the associate that created the appointment |
| CautionWarning | string | Status field to indicate appointments that have some sort of problem |
| JoinVideomeetUrl | string | Blank when not a video meeting. Filled with Join Meeting URL when created. |
| PreferredTZLocation | int32 | Preferred timezone location to use when displaying/editing this appointment |
| Title | string | The title of the appointment. |
| Agenda | string | The agenda of the appointment. |
| InternalNotes | string | Internal notes for the appointment. |
| TableRight | TableRight | The carrier's table right |
| FieldProperties | object | Field property dictionary mapping field names to field access rights. |
Sample request
POST /api/v1/Agents/Appointment/GetContactAppointments
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: fr,de,ru,zh
Content-Type: application/json; charset=utf-8
{
"ContactId": 425,
"StartTime": "2023-08-04T14:13:38.938082+02:00",
"EndTime": "2001-12-24T14:13:38.938082+01:00",
"Count": 777
}
Sample response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
[
{
"AppointmentId": 21,
"StartDate": "2000-09-15T14:13:38.938082+02:00",
"EndDate": "2013-02-15T14:13:38.938082+01:00",
"Type": "BookingForChecklist",
"Task": "reprehenderit",
"AssociateFullName": "Celestine Auer",
"ContactName": "Thiel-Gutmann",
"Description": "Decentralized interactive concept",
"PersonFullName": "Dominique Hyatt",
"PersonId": 661,
"ContactId": 743,
"ProjectId": 751,
"ProjectName": "Maggio Inc and Sons",
"IsPublished": true,
"AssociateId": 951,
"ColorIndex": 668,
"IsFree": false,
"HasAlarm": false,
"IsAlldayEvent": false,
"Private": "PrivateGroup",
"PriorityId": 788,
"PriorityName": "Leffler-Crist",
"TaskType": "Appointment",
"IsBookingMain": false,
"IsRecurrence": false,
"IsBooking": false,
"ActiveDate": "2006-12-30T14:13:38.938082+01:00",
"AssignmentStatus": "Assigning",
"InvitationStatus": "Accepted",
"BookingType": "None",
"Completed": "Completed",
"RecurringPattern": "Custom",
"RecurringStartDate": "2015-06-06T14:13:38.938082+02:00",
"RecurringEndDate": "2006-02-28T14:13:38.938082+01:00",
"MotherId": 356,
"AssignedBy": 286,
"AssignedByFullName": "Dorothea Brekke",
"RejectReason": "",
"Location": "ut",
"AlarmLeadTime": "quod",
"SaleId": 929,
"SaleName": "Batz LLC",
"AssociateName": "Dibbert LLC",
"CreatedDate": "2024-12-29T14:13:38.938082+01:00",
"CreatedBy": "et",
"CreatedByFullName": "Lucile Pfannerstill",
"CreatedByAssociateId": 814,
"CautionWarning": "ExternalParticipantsDateTimeMismatch",
"JoinVideomeetUrl": "http://www.example.com/",
"PreferredTZLocation": 14,
"Title": "quia",
"Agenda": "voluptate",
"InternalNotes": "quod",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.String",
"FieldLength": 950
}
}
}
]