Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
ON THIS PAGE
 

GET /reference_data/maps

SUMMARY Retrieve a list of all reference maps.

Retrieve a list of all reference maps.

Table 1: GET /reference_data/maps resource details:

GET /reference_data/maps resource details
MIME Type

application/json

Table 2: GET /reference_data/maps request parameter details:

GET /reference_data/maps request parameter details
Parameter Type Optionality Data Type MIME Type Description

Range

header

Optional

String

text/plain

Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero.

fields

query

Optional

String

text/plain

Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

filter

query

Optional

String

text/plain

Optional - This parameter is used to restrict the elements in a list base on the contents of various fields.
Table 3: GET /reference_data/maps response codes:

GET /reference_data/maps response codes
HTTP Response Code Unique Code Description

200

The reference map list has been retrieved

500

1020

An error occurred while attempting to retrieve all of the reference maps

Response Description

A list of all of the reference maps. This returns information about the maps but not the contained data.

Response Sample