POST Agents/Associate/GetAssociatesByGroup

• 4 minutes to read
 • 4 minutes to read 
POST /api/v1/Agents/Associate/GetAssociatesByGroup

Method that returns a array of associate , based on DiaryGroupType and groupId.

The differernt types are, Userdefined, Usergroup and ResourceHeadings NsApiSlow threshold: 2000 ms.

Query String Parameters

Parameter Name Type Description
$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/GetAssociatesByGroup?$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
Content-Type Content-type of the request body: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, application/json-patch+json, application/merge-patch+json
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.

Request Body: request

GroupId, Type

Property Name Type Description
GroupId Integer
Type Integer

Response:array

OK

Response Description
200 OK

Response body: array

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
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 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/GetAssociatesByGroup
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en
Content-Type: application/json; charset=utf-8

{
  "GroupId": 551,
  "Type": 517
}

Sample response

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

[
  {
    "AssociateId": 794,
    "Name": "EW",
    "PersonId": 316,
    "Rank": 4,
    "Tooltip": "Marketing Manager",
    "Type": "InternalAssociate",
    "GroupIdx": 869,
    "FullName": "Emily Wilson",
    "FormalName": "Wilson, Emily",
    "Deleted": false,
    "EjUserId": 666,
    "UserName": "emily.wilson",
    "ExtraFields": {
      "ExtraFields1": "Marketing",
      "ExtraFields2": "Digital"
    },
    "CustomFields": {
      "CustomFields1": "Department: Marketing",
      "CustomFields2": "Focus: Digital Campaigns"
    },
    "TableRight": null,
    "FieldProperties": {
      "fieldName": {
        "FieldRight": null,
        "FieldType": "System.Int32",
        "FieldLength": 872
      }
    }
  }
]