Retrieve

A retrieve request is used to fetch a single resource by its integer “id” value. This is the most performant way to get a representation for a single resource where the “id” is known. The result set is not paginated. The “id” value is specified in the URI after the entity name:

…/lgfapi/v10/company/{id}/

For example, if we had previously looked up the company with code “ABC” and found its “id” value to be 1, we could retrieve its representation in the future by making a GET request to the URI:

…/lgfapi/v10/company/1/

Note that since the lookup is for a specific resource, no filters are allowed in the query string. It is permitted to pass in allowed non-filter reserved parameters like “format” and “fields”. However, any pagination related query string parameters like “page_mode” are not supported since the returned representation is not paginated.

Note: …/lgfapi/v10/company/?id=1 is still considered a “list” style request and is paginated.

Last-Modified HTTP Header

If the requested resource exists and the data is temporally tracked, the Last-Modified HTTP header will be returned. This is the date-time that the resource was last updated. It is in iso-8601 format in the requesting user’s time zone. This can be cached client-side and used in conjunction with HEAD requests as an efficient way to check for resource modification.