Get Person Appointments By Task
Method that returns a specified number of appointments of a specific appointment task type within a time range.
The appointments belong to the person specified. Task represents the different types of activities, like “Phone call”, “Meeting” and so on. NsApiSlow threshold: 2000 ms.
Headers
Convert string references and multi-language values into a specified language (iso2) code.
Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
Specify the timezone code that you would like date/time responses converted to.
The application token that identifies the partner app. Used when calling Online WebAPI from a server.
Query Parameters
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.
Body
PersonId, IncludeProjectAppointments, StartTime, EndTime, Count, TaskId
GetPersonAppointmentsByTask: Method that returns a specified number of appointments of a specific appointment task type within a time range. The appointments belong to the person specified. Task represents the different types of activities, like “Phone call”, “Meeting” and so on.
Response
OK
Primary key
date + start time planned
Date + end time planned
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.
Unknown, inDiary, inChecklist, Note, Document, SavedReport, BookingForDiary, BookingForChecklist, MergeDraft, MergeFinal Task comprises the different types of activities, like “Phone call”, “Meeting” and so on.
The owner of the appointment - the associate whose diary/checklist the appointment is in.
The contact associated with the appointment.
The appointment's textbox; holds a descriptive text about the appointment. Filled out by the user.
The full name of the person this appointment belongs to.
Person ID of person the appointment is with, may be 0
Contact ID of owning contact, may be 0
ID of project referred to, may be 0
The name of the project this appointment belong to. Blank if no project is connected.
True if appointment have an entry in published table
ID of associate whose diary the appointment is in, REQUIRED
Appointment colour, used only in Japanese versions. Western versions take colour from Task
True if free, false if busy
Does this appointment have an alarm
True if all day event
Obsolete, but still maintained field for appointment privacy; denormalization of visiblefor status
Public, PrivateUser, PrivateGroup Link to priority list
Name of the appointments priority
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.
Unknown, Appointment, Document, Email, Fax, Phone, ToDo, MailMergeDraft, MailMergeFinal, Report, SaintAll 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.
True if the appointment is part of a recurring pattern.
True if this appointment is a booking.
The date to be used for searching & showing
Status if this appointment is in the process of being assigned to someone else
Unknown, None, Assigning, Seen, Declined Status if this appointment represents an invitation
Unknown, None, Accepted, Hidden, Invitation, Moved, Seen, MovedSeen, Declined, Cancelled The type of booking the appointment represents
Unknown, None, Owner, Participant The Completed state.
Unknown, NotStarted, Started, Completed Unknown, Daily, Weekly, Monthly, Yearly, Custom 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
Who (last) assigned this appointment to associate_id?
The associate's culture formatted fullname (firstname, middleName and lastname)
Why was this booking or assignment rejected, the RejectReason list is a source of suggestions but you can write anything here
Location for appointment, defaulted from invited resource of type place and other rules, but you can write anything you want here
Alarm lead time.
Owning sale, if any (may be 0)
Heading of Owning sale, if any. (may be blank)
The associate's name
Appointment creation date
Who created the appointment. Associate name.
Who created the appointment. Full name.
Id of the associate that created the appointment
Status field to indicate appointments that have some sort of problem
OK, NotInSync, NotNotifiedByEmail, RecurrencePatternNotSupported, IncomingRecurrenceChangeNotSupported, ExternalParticipantsDateTimeMismatch Set if an external system owns this appointment.
None, Other, Outlook, Google Associate/owner of the mother appointment
Blank when not a video meeting. Filled with Join Meeting URL when created.
Preferred timezone location to use when displaying/editing this appointment
The title of the appointment.
The agenda of the appointment.
Internal notes for the appointment.
Link to task list
Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.
Field property dictionary mapping field names to field access rights.
Related topics
Get Person Appointments By TasksGet Person Appointments By Task HeadingNSAppointmentAgentGet Person TasksGet Project Member Appointments By TaskGet Project Member Appointments By Tasks