Overview of GETs

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

There are two types of GETs:

• A collection GET is a GET that returns a collection of one or more resources. Collection GETs have paths that end in a plural noun, such as GET /activities/xc:1227/notes.
• An element GET is a GET that returns a single, specific resource. Element GETs have paths that end in the ID of the specific resource. For example, GET /activities/xc:1227.

When a GET is successful, the response includes:

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

When you configure a caller application to send 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 topic discusses how response payloads are structured and how developers can learn about response payload formats.