v1

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

Gets a single item

Get the details of a single data item, by ID.

get/v1/entities/{name}/items/{id}

Path parameters

namestring required

The name of the entity.

idstring required

The name of the entity.

Response

Success

statusstring
codeinteger
entityNamestring
entityLabelstring
entitySchemaobject
itemidstring
dataobject

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"
        }
      }
    }
  },
  "data": {
    "id": 78,
    "iso31661alpha2": "FJ",
    "iso31661alpha3": "FJI",
    "name": "Fiji",
    "continent": "OC",
    "dial": 679,
    "iso31661numeric": 242,
    "validfrom": null,
    "validto": null
  }
}