POST Agents/Contact/GetMyActiveContacts

• 4 minutes to read
 • 4 minutes to read 
POST /api/v1/Agents/Contact/GetMyActiveContacts

Returns the contacts where there has been activity since activityStartTime.

If activityStartTime is larger than the current date, all contacts with activity since last log-out are returned. The result set can be filtered by category and action type.

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/Contact/GetMyActiveContacts?$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

ActivityStartTime, ContactCategories, ActionType

Property Name Type Description
ActivityStartTime String
ContactCategories Array
ActionType String

Response:array

OK

Response Description
200 OK

Response body: array

Property Name Type Description
ContactId int32 Primary key
Department string Department
OrgNr string VAT number or similar
Name string Contact name
URL string URL address
AssociateFullName string The contact's owner
Action string The activity that has occured on this contact.
ActionTime date-time The time of the activity. If more than one activity has occured on the contact, the last activity time is shown.
Category string The contact category.
ActivityPersonName string The person that carried out the activity on the contact.
ActionId int32 Id of the last element an activity was found on. I.e. AppointmentId, ContactId, or PersonId
PersonId int32 The person id
ActivityPersonId int32 Id of the person causing the activity.
AssociateId int32 Our contact
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/Contact/GetMyActiveContacts
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en
Content-Type: application/json; charset=utf-8

{
  "ActivityStartTime": "2006-12-08T17:54:02.8514704+01:00",
  "ContactCategories": [
    272,
    919
  ],
  "ActionType": "ActivityCompleted"
}

Sample response

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

[
  {
    "ContactId": 689,
    "Department": "",
    "OrgNr": "712804",
    "Name": "Strosin, Stracke and Casper",
    "URL": "http://www.example.com/",
    "AssociateFullName": "Stacey Reina Metz MD",
    "Action": "ActivityCompleted",
    "ActionTime": "2024-08-26T17:54:02.8514704+02:00",
    "Category": "VIP Customer",
    "ActivityPersonName": "Luettgen, Langosh and Lind",
    "ActionId": 947,
    "PersonId": 801,
    "ActivityPersonId": 751,
    "AssociateId": 674,
    "TableRight": null,
    "FieldProperties": {
      "fieldName": {
        "FieldRight": null,
        "FieldType": "System.String",
        "FieldLength": 88
      }
    }
  }
]