GET /v1/parse_udi (v1)
The Parse UDI API allows users to pass a complex GS1, HIBCC or ICCBBA UDI and it will return each part of the UDI in a structured format.
This API is going to be deprecated. Please move to the v2 Parse UDI API.
Resource URLs
format | URL |
---|---|
JSON |
https://accessgudid.awsprod.nlm.nih.gov/api/v1/parse_udi.json |
XML |
https://accessgudid.awsprod.nlm.nih.gov/api/v1/parse_udi.xml |
Parameters
udi
must be provided.
parameter | type | description |
---|---|---|
udi |
String |
The full Unique Device Identifier string for a device.
Example Value: (01)00208851107345(17)150331
The UDI parameter should be percent-encoded. |
Examples
JSON: GET
https://accessgudid.awsprod.nlm.nih.gov/api/v1/parse_udi.json?udi=%3D%2FA9999XYZ100T0944%3D%2C000025%3DA99971312345600%3D%3E014032%3D%7D013032%26%2C1000000000000XYZ123
{
udi: "=/A9999XYZ100T0944=,000025=A99971312345600=>014032=}013032&,1000000000000XYZ123",
issuing_agency: "ICCBBA",
di: "A9999XYZ100T0944",
serial_number: "000025",
donation_id: "A99971312345600",
expiration_date_original_format: "YYYJJJ",
expiration_date_original: "014032",
expiration_date: "2014-02-01",
manufacturing_date_original_format: "YYYJJJ",
manufacturing_date_original: "013032",
manufacturing_date: "2013-02-01",
lot_number: "000000000000XYZ123"
}
XML: GET
https://accessgudid.awsprod.nlm.nih.gov/api/v1/parse_udi.xml?udi=%3D%2FA9999XYZ100T0944%3D%2C000025%3DA99971312345600%3D%3E014032%3D%7D013032%26%2C1000000000000XYZ123
<?xml version="1.0" encoding="UTF-8"?>
<result>
<udi>
=/A9999XYZ100T0944=,000025=A99971312345600=>014032=}013032&,1000000000000XYZ123
</udi>
<issuing-agency>ICCBBA</issuing-agency>
<di>A9999XYZ100T0944</di>
<serial-number>000025</serial-number>
<donation-id>A99971312345600</donation-id>
<expiration-date-original-format>YYYJJJ</expiration-date-original-format>
<expiration-date-original>014032</expiration-date-original>
<expiration-date type="date">2014-02-01</expiration-date>
<manufacturing-date-original-format>YYYJJJ</manufacturing-date-original-format>
<manufacturing-date-original>013032</manufacturing-date-original>
<manufacturing-date type="date">2013-02-01</manufacturing-date>
<lot-number>000000000000XYZ123</lot-number>
</result>