Skip to main content
Create Default Suggested Appointment Entity

Authorizations

Authorization
string
header
required

SuperOffice username:password are passed in Base64-encoded.

You can also pass inn an unencoded ticket 7T:abc== with the HTTP Authenticate header.

Authorization
string
header
required

SuperOffice SuperId OAuth implicit flow. You need to issue a request to the SuperId authorization URL https://online.superoffice.com/login/common/oauth/authorize?response_type=token &client_id=670734e0-4c5a-11e3-be9e-a171392e81db &redirect_uri=https://example.com/spa/

passing in the application id and redirect URL.

SuperId will log the user in, and redirect to the requested redirect URL with a #payload containing the access token and claims. (The redirect URL must be registered with SuperId in advance)

https://example.com/spa#access_token=8A%3aCust12227.AXRrCITpPBvQX3UbIohb &token_type=bearer &state= &expires_in=3600 &ctx=Cust12227 &netserver_url=https%3a%2f%2fsod.superoffice.com%2fCust12227%2fRemote%2fServices82%2f

You can take the #access_token value and pass it as the Authenticate HTTP header as a BEARER token.

FlowImplicit
Authorization URL
https://online.superoffice.com/login/common/oauth/authorize

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.

Response

OK

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

SuggestedAppointmentId
integer<int32>

Primary key

Name
string

Item name, visible in Guide

Tooltip
string

Tooltip / description

Rank
integer<int32>

Rank, controls rank of non-instantiated items in Guide

Deleted
boolean

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

Duration
string

Duration in minutes of suggested appointment

AutoSuggest
boolean

Should this appointment be auto-suggested

IsMilestone
boolean

Is this a milestone activity

AssignToMember
boolean

Should this appointment be assigned to project member

Text
string

The suggested text of the new appointment

Carrier object for ProjectTypeStatusLink.

Carrier object for SaleTypeStageLink.

Type
object

Type of an appointment Carrier object for SoTask. Services for the SoTask Carrier is available from the List 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.