Skip to main content
Get All

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

PrefDescId
integer<int32>

Primary key

Section
string

Preference section name

Key
string

Preference key name

Name
string

Multi-language name

ValueType
enum<string>

1=number, 2=text, 3=bool, 4=list of values; 5=list table ref; 6=contact ID, 7=Person ID, 8=Project ID, 9=Selection ID

Available options:
Unknown,
Number,
Text,
Bool,
ListOfValues,
ListTableRef,
TimeList,
ContactID,
PersonID,
ProjectID,
SelectionID,
PosSize,
TimeZone,
Time,
Password,
MultiLineText
MaxLevel
enum<string>

Lowest allowed setting level, set by user, but not lower than sysMaxLevel

Available options:
Undefined,
HardDefault,
SystemWide,
Database,
Group,
Individual,
PC
SysMaxLevel
enum<string>

Lowest allowed setting level, set by SuperOffice

Available options:
Undefined,
HardDefault,
SystemWide,
Database,
Group,
Individual,
PC
AccessFlags
enum<string>

1=wizard mode, 2=level 0, 4=admin gui, 8=crm gui

Available options:
Unknown,
WizardMode,
Level0,
adminGUI,
CRMGUI
Description
string

Description of preference, multi-language parsed

IsBuiltin
boolean

1 = This row populated and maintained by SuperOffice

TableName
string

If valueType = 5, then TableName contains the table referenced by the preference

UserDefinedListId
integer<int32>

Read-only field, If valueType = 5, and TableName is UDList, then UserdefinedLIstId contains the id of the list referenced by the preference

Rank
integer<int32>

Rank field for ordering sections, and keys within sections

SubGroup
string

Keys that share a value (including NULL) in this field are shown together; a visual spacer is shown between groups

MinLevel
integer<int32>

The minimum (furthest away from User) level this preference can be set for

MaxValue
integer<int32>

Max value (if type 1); list table ID (if type 5)

MinValue
integer<int32>

Min value (if type 1); list extra id (if type 5)

RequiredLicense
string

Licenses the user/installation must have if this reference is to be shown. Comma-separated list of owner.module pairs

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.