Querying for activities

Activities cannot exist on their own. They must be attached to a parent object. In ClaimCenter, activities can be attached only to claims (directly or indirectly), and in PolicyCenter, activities can be attached to accounts, jobs, or policies. In BillingCenter, you can only retrieve activities by using the Common API.

The different queries for activities return different responses for the different InsuranceSuite applications, based on their parent objects. Use the following endpoints to GET activities:

Note that the endpoints to retrieve activities exist in different APIs. To get all activities for a claim, you use an endpoint in the Claim API. But to get information about all activities (regardless of parent), or to get information about a specific activity, you use endpoints in the Common API.

For example, the following query retrieves the IDs and subjects of all activities for account demo_sample:1. This endpoint is in the Claim API.

ClaimCenter

Request

GET claim/v1/claims/demo_sample:1/activities?fields=id,subject

Response

{
  "count": 14,
    "data": [
      {
        "attributes": {
          "id": "cc:23218",
          "subject": "Contact insured"
        }
      },
      {
        "attributes": {
          "id": "cc:40404",
          "subject": "Determine fault rating"
        }
      },
      ...

The following query retrieves activity cc:40404 in detail. This endpoint is in the Common API.

Request

GET /common/v1/activities/pc:40404

Response

{
  "data": {
    "attributes": {
      "activityPattern": "general_reminder",
      "activityType": {
        "code": "general",
        "name": "General"
      },
      "assignedGroup": {
        "displayName": "Auto1 - TeamA",
        "id": "demo_sample:31"
      },
      "assignedUser": {
        "displayName": "Andy Applegate",
        "id": "demo_sample:1",
        "type": "User",
        "uri": "/admin/v1/users/demo_sample:1"
      },
      "assignmentStatus": {
        "code": "assigned",
        "name": "Assigned"
      },
      "createTime": "2023-11-18T02:00:20.481Z",
      "dueDate": "2023-11-07T00:00:00.000Z",
      "escalated": false,
      "externallyOwned": false,
      "id": "cc:40404",
      "importance": {
        "code": "notOnCalendar",
        "name": "Not On Calendar"
      },
      "mandatory": false,
      "priority": {
        "code": "normal",
        "name": "Normal"
      },
      "recurring": false,
      "relatedTo": {
        "displayName": "Ray Newton",
        "id": "cc:SW8RXsrWJZiKa7jfCEAYr",
        "type": "ClaimContact",
        "uri": "/claim/v1/claims/demo_sample:1/contacts/cc:SW8RXsrWJZiKa7jfCEAYr"
      },
      "status": {
        "code": "open",
        "name": "Open"
      },
      "subject": "Determine fault rating"
    },
    ...

PolicyCenter

To get all activities for an account, job, or policy, you use endpoints in the Account API, Job API, or Policy API. But to get information about all activities (regardless of parent), or to get information about a specific activity, you use endpoints in the Common API.

Here's another example of how a query for activities the following query retrieves the IDs and subjects of all activities for account pc:101. This endpoint is in the Account API.

Request

GET account/v1/accounts/pc:101/activities?fields=id,subject

Response

{
  "count": 2,
    "data": [
      {
        "attributes": {
          "id": "pc:23221",
          "subject": "All ordered MVRs received - Clear"
        }
      },
      {
        "attributes": {
          "id": "pc:40404",
          "subject": "Review Risk Information"
        }
      }
    ],
    ...

The following query retrieves activity pc:40404 in detail. This endpoint is in the Common API.

Request

GET /common/v1/activities/pc:40404

Response

{
  "data": {
    "attributes": {
      "activityType": {
        "code": "general",
        "name": "General"
      },
      "assignedGroup": {
        "displayName": "Los Angeles Branch UW",
        "id": "pc:SPMK8WfF0qE3G7erNndfW"
      },
      "assignedUser": {
        "displayName": "Alice Applegate",
        "id": "pc:SSmfb1spW-C2IyI8rFOja",
        "type": "User",
        "uri": "/admin/v1/users/pc:SSmfb1spW-C2IyI8rFOja"
      },
      "assignmentStatus": {
        "code": "assigned",
        "name": "Assigned"
      },
      "createTime": "2023-11-26T08:02:56.607Z",
      "description": "Review the risk information for the policy's scheduled items.",
      "dueDate": "2023-11-26T08:02:56.604Z",
      "escalated": false,
      "externallyOwned": false,
      "id": "pc:40404",
      "mandatory": false,
      "priority": {
        "code": "normal",
        "name": "Normal"
      },
      "recurring": false,
      "status": {
        "code": "open",
        "name": "Open"
      },
      "subject": "Review Risk Information"
    },
    ...

BillingCenter

The following query retrieves the IDs and subjects of all activities assigned to the user who makes the call.

Request

GET /common/v1/activities?fields=id,subject

Response

{
    "count": 3,
    "data": [
        {
            "attributes": {
                "id": "bc:SgDIOE5GHnRiVkqQ9x3mB",
                "subject": "Inactivity Notification on Account bc:2538"
            }
        },
        {
            "attributes": {
                "id": "bc:SbP7mYxSHaUAK7AWQDR8z",
                "subject": "Inactivity Notification on Account bc:896"
            }
        },
        {
            "attributes": {
                "id": "bc:SON0bsszUiQ5B9WexpeoK",
                "subject": "Inactivity Notification on Account Standard Account"
            }
        }
    ],
    ...
}

The following query retrieves a single activity.

Request

GET /common/v1/activities/bc:40404

Response

{
    "data": {
        "attributes": {
            "activityType": {
                "code": "general",
                "name": "General"
            },
            "assignedByUser": {
                "displayName": "Super Visor",
                "id": "bc:SV9U7v71njqJ2Jekl_sQO",
                "type": "User",
                "uri": "/admin/v1/users/bc:SV9U7v71njqJ2Jekl_sQO"
            },
            "assignedGroup": {
                "displayName": "Default Root Group",
                "id": "systemTables:1",
                "type": "Group",
                "uri": "/admin/v1/groups/systemTables:1"
            },
            "assignedUser": {
                "displayName": "Default Owner",
                "id": "systemTables:1",
                "type": "User",
                "uri": "/admin/v1/users/systemTables:1"
            },
            "assignmentStatus": {
                "code": "assigned",
                "name": "Assigned"
            },
            "createTime": "2024-11-25T17:52:00.408Z",
            "description": "Account bc:893 has been inactive for 60 days",
            "dueDate": "2024-12-02T17:52:00.229Z",
            "escalated": false,
            "externallyOwned": false,
            "id": "bc:40404",
            "mandatory": false,
            "priority": {
                "code": "normal",
                "name": "Normal"
            },
            "recurring": false,
            "status": {
                "code": "open",
                "name": "Open"
            },
            "subject": "Inactivity Notification on Account bc:893",
            "subtype": {
                "code": "AcctInactiveActivity",
                "name": "AcctInactiveActivity"
            }
        },
        ...
    }
}