Get Next Suggested Appointment By Sale
Gets the next suggested appointment for a given sale (or rather a given sale’s guide).
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
SaleId, CurrentAppointmentId, SkipCompleteCheck
Response
OK
Carrier object for SuggestedAppointment. Services for the SuggestedAppointment Carrier is available from the Appointment Agent.
Should this appointment be auto-suggested
0 -> record is active 1 -> record is 'deleted' and should not be shown in lists
How many days into the future the appointment should be scheduled
Tooltip / description
The suggested text of the new appointment
Type of the suggested appointment
Primary key
Link to saleTypeStageLink, the anchor for sale guide items. Either this OR projectAnchorId should be set, not both at the same time.
Registered by whom
Rank, controls rank of non-instantiated items in Guide
Link to projectTypeStatusLink, the anchor for project guide items. Either this OR saleAnchorId should be set, not both at the same time.
Item name, visible in Guide
Duration in minutes of suggested appointment
Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.
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
NSAppointmentAgentGet Suggested AppointmentGet Suggested Appointment EntityGet Next Sale StageNSSuggestedAppointmentNSSuggestedAppointmentEntity