Skip to main content
Get Associate By Person Id

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

PersonId

GetAssociateByPersonId: Returns the associate that belongs to this person if the person is an associate.

PersonId
integer<int32>

Response

OK

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

AssociateId
integer<int32>

Primary key

Name
string

Initials, also login name, possibly database user name

PersonId
integer<int32>

Owning person record Use MDO List name "person" to get list items.

Rank
integer<int32>

Rank order

Tooltip
string

Tooltip or other description

Type
enum<string>

User type - 1 = internal user, 2 = resource, 3 = external user, 4 = anonymous, 5 = system

Available options:
Unknown,
InternalAssociate,
ResourceAssociate,
ExternalAssociate,
AnonymousAssociate,
SystemAssociate
GroupIdx
integer<int32>

Primary group membership, see UserGroupLink for secondary memberships

FullName
string

The associate's culture formatted fullname (firstname, middleName and lastname)

FormalName
string

The associate's culture formatted formalname (firstname, middleName and lastname, title, mrmrs)

Deleted
boolean

If true, the user is retired and should have no rights, not appear in lists, etc.

EjUserId
integer<int32>

ID of the ej user record corresponding to this associate; 0 for associates that are not ej users

UserName
string

User name

ExtraFields
object

Deprecated: Use {SuperOffice.CRM.Services.Associate.CustomFields} instead. Extra fields added to the carrier. This could be data from Plug-ins, the foreign key system, external applications, etc.

CustomFields
object

Udef + Extra fields added to the carrier. Extra fields as defined by changes to database schema + user-defined fields as defined by admin. Custom fields combines user defined fields and extra fields into one bucket. The individual {SuperOffice.CRM.Services.Associate.ExtraFields} and UserDefinedFields properties are deprecated in favor of this combined collection.

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.