Overview of GETs

A GET is an HTTP method that is used to retrieve data from an InsuranceSuite application.

In its simplest format, a GET consists of the GET operation and the endpoint, such as GET /activities. A GET can return either information about a single element (such as GET /activities/{activityId}) or information about a collection (such as GET /activities/{activityId}/notes).

The response to a GET includes:

  • An HTTP response code indicating success or failure.
  • A response payload that contains the data that was queried for.

When a developer configures a caller application to query information using a GET, the construction of the API call is fairly straight-forward. The call may require query parameters, but GETs do not require a request payload.

The majority of the work lies in parsing the response payload. The remainder of this chapter discusses how response payloads are structured and how developers can learn about response payload formats.