UidApi Resource

API to check UIDs managed by this web service.

GET /v1/uid/check/{tag}

This REST-API performs UID-checks and returns a JSON object with all details about the check.

To use the UID-API the following requirements have to be met:

  • 1) UIDs: UIDs have to be uploaded to this web service. This is done by NFC21 after ordering NFC-Tags with UID-readout.
  • 2) TagId and token: After uploading tagId and (secret) token are issued to call this api.

To perform the UID-check the parameters trusted-tap id, uid and (secret) token need to be provided. The web service will evaluate the call and perform the check if all conditions are met. Otherwise the result contains a list of errors.

Request Parameters
name type description
tag path id of trusted-tap to provide.
token query to authenticate the API call.
uid query the UID (14 HEX chars) to check.
Response Codes
code condition
200 If the UID is known and valid.
400 If the request was malformed (e.g. did not contain all necessary parameters).
404 If the UID is unknown.
Response Body
media type data type description
application/json UidApiResult (JSON) UidApiResult with details about the UID-check.
application/xml uidApiResult (XML)

Example

Request
GET /api/v1/uid/check/{tag}
Content-Type: application/json
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "created" : 12345,
  "uidKnown" : true,
  "errors" : [ "...", "..." ]
}