POST Agents/Associate/GetAssociate

• 3 minutes to read
 • 3 minutes to read 
POST /api/v1/Agents/Associate/GetAssociate

Gets a Associate object.

Query String Parameters

Parameter Name Type Description
associateId int32 Required The primary key.
$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. 
POST /api/v1/Agents/Associate/GetAssociate?associateId=967
POST /api/v1/Agents/Associate/GetAssociate?$select=name,department,category/id

Request Headers

Parameter Name Description
Authorization Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Accept Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json
Accept-Language Convert string references and multi-language values into a specified language (iso2) code.
SO-Language Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
SO-Culture Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
SO-TimeZone Specify the timezone code that you would like date/time responses converted to.
SO-AppToken The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Response:

OK

Response Description
200 OK

Response body: Associate

Property Name Type Description
AssociateId int32 Primary key
Name string Initials, also login name, possibly database user name
PersonId int32 Owning person record Use MDO List name "person" to get list items.
Rank int32 Rank order
Tooltip string Tooltip or other description
Type string User type - 1 = internal user, 2 = resource, 3 = external user, 4 = anonymous, 5 = system
GroupIdx 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 bool If true, the user is retired and should have no rights, not appear in lists, etc.
EjUserId int32 ID of the ej user record corresponding to this associate; 0 for associates that are not ej users
UserName string User name
TableRight TableRight The carrier's table right
FieldProperties object Field property dictionary mapping field names to field access rights.

Sample request

POST /api/v1/Agents/Associate/GetAssociate
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: *

Sample response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "AssociateId": 836,
  "Name": "Kautzer Group",
  "PersonId": 76,
  "Rank": 188,
  "Tooltip": "eos",
  "Type": "AnonymousAssociate",
  "GroupIdx": 148,
  "FullName": "Ms. Brad Margarita Wolf",
  "FormalName": "Beier-Hills",
  "Deleted": true,
  "EjUserId": 327,
  "UserName": "O'Keefe-Mueller",
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.Int32",
      "FieldLength": 834
    }
  }
}