All Versions

Version 1
Version 2


Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Table of Contents
maxLevel4
excludeTable of Contents

Overview

GET requests are used to retrieve data from the API. The URI for a get request indicates which resource will be returned.
View documentation for available Resources.

A URI that ends Endpoints with URIs that end with an identifier, such as /members/M0001{identifier}, is are used request a the specific instance of the a resource .
Learn more about Item Responses.URIs without an identifier will return a list identified by {identifier}. These requests will typically return an Item Response.

Endpoints with URIs that do not include an identifier, such as /members, will typically return a List Response which includes a collection of items of the specified resource type. Additional query parameters can be used to filter the returned list and limit the number of items returned. Learn more about List Responses.

Tip

Query parameters for filters and pagination of result sets are planned future functionality, and are not yet supported


Request Headers

The following headers should be used when issuing GET requests

Authorization

A valid Authorization header is required if the requested resource requires authentication. 
Learn more about our use of Authentication

Accept

The Accept header specifies the MIME type for the format in which you would like the API to return data to you. You may specify the Accept header using any valid syntax, including a combination of multiple MIME types with wildcards and quality values. The following examples are all considered to be valid and accepted by this API.

Accept: application/json
Accept: */*
Accept: text/html, application/xhtml+xml, application/xml;q=0.9, */*;q=0.8

If you do not specify the Accept header then API will assume application/json as the value.

Info

This API currently supports only JSON data for requests and responses

If you specify an Accept header that does not allow JSON as one of the specified MIME types, the API will respond with an HTTP Status of 406: Not Acceptable. In this case, the API must assume that the caller will not understand a JSON response. Since the API only knows how to respond with JSON, the response will have no content.

Example
No Format
GET /api/v2/members/M0001
Accept: application/xml
Accept-Version: 1.x
Authorization: Basic Y3JpdGljYWxtaXg6dG9wc2VjcmV0

HTTP/1.1 406

Accept-Version

Use the custom HTTP Header Accept-Version to specify the desired version of the resource being requested.
Learn more about our use of 
Versioned ResourcesAPI Versioning.

Successful Responses

HTTP Status Codes

Successful calls to the endpoints will return an appropriate HTTP Status Code from the following list: 

HTTP Status CodeUsage

200: OK

All successful calls not otherwise specified

Headers

Header NameValueDescription

Content-Type

application/json

MIME type of the response body. Currently the API offers only JSON responses.

Content-Version{version number}Version of the resource being returned. Learn more about Versioned ResourcesAPI Versioning.

Response Body 

The format of the response body will vary based on the potential of the request to match more than one resource. 

Requests that specify an identifier for the requested resource in the format of /resource/id will return at most one item. The response for these requests will always be an Item response type. You will never receive an empty Item response. Instead, if the requested identifier is not found, you will receive a 404: Not Found response.

Read more about the Item Response Model. 

If no identifier is specified in the request, such as /resource, then response will be a List response. The List format will be used even if the list contains only one item. If the list is empty, you will still receive a response in the List format with an empty _list array.

Read more about the List Response Model.


Excerpt
hiddentrue

Fetch a single resource object from the API, or a list of matching resource objects