Get an Item¶

Request¶

This request retrieves an item based on known identification information.

Request Type	GET
URL	/api/v1/item/example.org/e9d35174-dea3-4629-afef-770220b4cbc4

In the URL above, example.org is the agency identifier of the item to be retrieved.
e9d35174-dea3-4629-afef-770220b4cbc4 is the identifier of the item to be retrieved.
This identification information can be retrieved based on a Search request.
No request body is required for this GET request.

Response¶

{
    "VersionRationale": {},
    "ItemType": "4bd6eef6-99df-40e6-9b11-5b8f64e5cb23",
    "AgencyId": "example.org",
    "Version": 1,
    "Identifier": "e9d35174-dea3-4629-afef-770220b4cbc4",
    "Item": "<Fragment xmlns:r=\"ddi:reusable:3_2\" xmlns=\"ddi:instance:3_2\"><Group xmlns=\"ddi:group:3_2\" isUniversallyUnique=\"true\" versionDate=\"2019-01-23T19:04:09.4036166Z\"><r:URN>urn:ddi:example.org:e9d35174-dea3-4629-afef-770220b4cbc4:1</r:URN><r:Agency>example.org</r:Agency><r:ID>e9d35174-dea3-4629-afef-770220b4cbc4</r:ID><r:Version>1</r:Version><r:VersionResponsibility>BRIDGIT\\jeremy</r:VersionResponsibility><r:Citation><r:Title><r:String xml:lang=\"en-US\">Sample Social Survey</r:String></r:Title></r:Citation><SubGroupReference><r:Agency>example.org</r:Agency><r:ID>e0034aac-4fc2-4761-b6f3-a39ec7e7f320</r:ID><r:Version>1</r:Version><r:TypeOfObject>SubGroup</r:TypeOfObject></SubGroupReference><SubGroupReference><r:Agency>example.org</r:Agency><r:ID>fa78b784-8e0e-4dee-8cbc-d489b1e0e5c8</r:ID><r:Version>1</r:Version><r:TypeOfObject>SubGroup</r:TypeOfObject></SubGroupReference></Group></Fragment>",
    "Notes": [],
    "VersionDate": "2019-01-23T19:04:09.553",
    "VersionResponsibility": "sue",
    "IsPublished": false,
    "IsDeprecated": false,
    "IsProvisional": false,
    "ItemFormat": "c0ca1bd4-1839-4233-a5b5-906da0302b89"
}

The Item property contains the DDI XML of the retrieved item.