Skip to main content
Default Contact Relation 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

Relationship between a (contact/person) and another (contact/person), as described by the RelationDefinition. Carrier object for ContactRelationEntity. Services for the ContactRelationEntity Carrier is available from the Relation Agent.

SourceContactId
integer<int32>

Id of the source contact. The value is mandatory.

SourcePersonId
integer<int32>

Id of the source person. The value is not mandatory. The person must belong to the source contact.

DestinationContactId
integer<int32>

Id of the destination contact. The value is mandatory.

DestinationPersonId
integer<int32>

Id of the destination person. The value is not mandatory. The person must belong to the destination contact.

RelationId
integer<int32>

Primary key

Comment
string

Comment for relation

RelationDefinitionId
integer<int32>

Reference to definition

Reversed
integer<int32>

Is direction reversed relative to definition

UpdatedDate
string<date-time>

Last updated when in UTC.

CreatedDate
string<date-time>

Registered when in UTC.

CreatedBy
object

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

UpdatedBy
object

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

SourceContactName
string

Name of the source contact.

SourcePersonName
string

Name of the source person.

DestinationContactName
string

Name of the destination contact.

DestinationPersonName
string

Name of the destination person.

ActiveText
string

Active text for the relation.

PassiveText
string

Passive text for the relation.

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.