Skip to main content
Get Next Suggested Appointment By Sale

Headers

Accept-Language
string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language
string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture
string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone
string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken
string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Query Parameters

$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.

Body

SaleId, CurrentAppointmentId, SkipCompleteCheck

GetNextSuggestedAppointmentBySale: Gets the next suggested appointment for a given sale (or rather a given sale's guide).

SaleId
integer<int32>
CurrentAppointmentId
integer<int32>
SkipCompleteCheck
boolean

Response

OK

Carrier object for SuggestedAppointment. Services for the SuggestedAppointment Carrier is available from the Appointment Agent.

AutoSuggest
integer<int32>

Should this appointment be auto-suggested

Deleted
integer<int32>

0 -> record is active 1 -> record is 'deleted' and should not be shown in lists

DaysFuture
integer<int32>

How many days into the future the appointment should be scheduled

Tooltip
string

Tooltip / description

Text
string

The suggested text of the new appointment

TaskId
integer<int32>

Type of the suggested appointment

SuggestedAppointmentId
integer<int32>

Primary key

Link to saleTypeStageLink, the anchor for sale guide items. Either this OR projectAnchorId should be set, not both at the same time.

RegisteredAssociateId
integer<int32>

Registered by whom

Rank
integer<int32>

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.

Name
string

Item name, visible in Guide

Duration
integer<int32>

Duration in minutes of suggested appointment

Associate
object

Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.

TableRight
object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

FieldProperties
object

Field property dictionary mapping field names to field access rights.