v1

latestOpenAPI 3.0.0MITraw.githubusercontent.com2019-08-017572.7 KB

entities

Gets data items for an entity (supports pagination and filters/queries)

Get the data items within a data set (supporting pagination).

Supports query string parameters (optional) to search within the data set. To support flexibility across entity definitions the main query parameters are two arrays: keys, values. These accept comma-separated lists. If the number of keys and values in the request are not equal, the request will be rejected.

Supports single eq (equal) filtering, example: - id=eq.3 - city=eq.London

Supports multiple eq (equal) filtering, example: - firstName=eq.Pedro&lastName=eq.Curado - city=eq.London&postcode=eq.SW13 9RQ

Supports single and multiple neq (not equal) filtering, example: - continent=neq.AS&continent=eq.EU - continent=neq.AS&continent=neq.EU

Supports single in (in list) filtering, example: - name=in.(Portugal, United Kingdom)

Not supported yet: - currently only un-quoted values are supported this means that using values with commas will not return any values for instance: street=in.(Flat 2, 33 Joy St, London, Flat 9, 20 Sad St, London)

Defaults to:

returning both the schema and the data items (the data items can be omitted by setting schemaOnly=true in the query parameters)
only returning ‘active’ data items (include inactive items by setting includeInactive=true in the query parameters).

get/v1/entities/{name}

Path parameters

namestring required

The name of the entity.

Query parameters

keysstring[]

The field keys that will be searched on.

[
  "alliance",
  "aviation"
]

valuesstring[]

The field values that will be searched for.

[
  "OneWorld",
  true
]

schemaOnlyboolean

Controls whether the response contains only the schema, or the schema and the data items.

includeInactiveboolean

Controls whether inactive records should be returned as part of the result set. Defaults to only returning currently active records.

offsetinteger

The number of items to skip before starting to collect the result set.

limitinteger

The maximum number of items to return in the result set.

Response

Success

statusstring

codeinteger

entityNamestring

entityLabelstring

entitySchemaobject

offsetinteger

limitinteger

Example response

{
  "status": "success",
  "code": 200,
  "entityName": "country",
  "entityLabel": "Countries",
  "entitySchema": {
    "description": {
      "description": "Countries",
      "schemalastupdated": "10/03/2019",
      "dataversion": 1
    },
    "required": [
      "id",
      "iso31661alpha2",
      "iso31661alpha3",
      "name",
      "continent",
      "iso31661numeric"
    ],
    "properties": {
      "id": {
        "format": "integer",
        "type": "integer",
        "description": {
          "label": "Identifier",
          "description": "database unique identity record",
          "summaryview": "false"
        }
      },
      "iso31661alpha2": {
        "maxLength": 2,
        "format": "character varying",
        "type": "string",
        "description": {
          "label": "2 digit alpha code",
          "description": "Country 2 Character alpha code",
          "summaryview": "true"
        }
      },
      "iso31661alpha3": {
        "maxLength": 3,
        "format": "character varying",
        "type": "string",
        "description": {
          "label": "3 digit alpha code",
          "description": "Country 3 Character alpha code",
          "summaryview": "true"
        }
      },
      "name": {
        "maxLength": 40,
        "format": "character varying",
        "type": "string",
        "description": {
          "label": "Country name",
          "description": "Country name",
          "summaryview": "true"
        }
      },
      "continent": {
        "maxLength": 2,
        "format": "character varying",
        "type": "string",
        "description": {
          "label": "Continent",
          "description": "Countinent country is part of",
          "summaryview": "true"
        }
      },
      "dial": {
        "maxLength": 20,
        "format": "character varying",
        "type": "string",
        "description": {
          "label": "Phone dial code",
          "description": "Country dailing prefix",
          "summaryview": "true"
        }
      },
      "iso31661numeric": {
        "format": "integer",
        "type": "integer",
        "description": {
          "label": "3 digit numeric code",
          "description": "Country numeric ISO code",
          "summaryview": "true"
        }
      },
      "validfrom": {
        "format": "date",
        "type": "string",
        "description": {
          "label": "Valid from date",
          "description": "Item valid from date",
          "summaryview": "false"
        }
      },
      "validto": {
        "format": "date",
        "type": "string",
        "description": {
          "label": "Valid to date",
          "description": "Item valid to date",
          "summaryview": "false"
        }
      }
    }
  },
  "offset": 78,
  "limit": 3,
  "data": [
    {
      "id": 78,
      "iso31661alpha2": "FJ",
      "iso31661alpha3": "FJI",
      "name": "Fiji",
      "continent": "OC",
      "dial": 679,
      "iso31661numeric": 242,
      "validfrom": null,
      "validto": null
    },
    {
      "id": 79,
      "iso31661alpha2": "FI",
      "iso31661alpha3": "FIN",
      "name": "Finland",
      "continent": "EU",
      "dial": 358,
      "iso31661numeric": 246,
      "validfrom": null,
      "validto": null
    },
    {
      "id": 80,
      "iso31661alpha2": "FR",
      "iso31661alpha3": "FRA",
      "name": "France",
      "continent": "EU",
      "dial": 33,
      "iso31661numeric": 250,
      "validfrom": null,
      "validto": null
    }
  ]
}