GET identifier/get?InternalNrLong={InternalNrLong}&Token={Token}

Retrieve detail data for specific identifier. Application privilege "View" for licensed agenda "Identifiers" required. Data may also be restricted by record permission "View" of agenda "Identifiers"

Request Information

Authorization

Authorization by token required

Availability

Method can be used

URI Parameters

Name	Description	Type	Additional information
InternalNrLong	Internal number of the identifier in hex format	string	Required Matching regular expression pattern: ([0-9a-fA-F]+) String length: inclusive between 0 and 20
Token	The action is authorized by this token. Token should generated by calling action "POST login". Expiration time of each token is 20 seconds	globally unique identifier	Required

Name

Description

Type

Additional information

InternalNrLong

Internal number of the identifier in hex format

string

Required

Matching regular expression pattern: ([0-9a-fA-F]+)

String length: inclusive between 0 and 20

Token

The action is authorized by this token. Token should generated by calling action "POST login". Expiration time of each token is 20 seconds

globally unique identifier

Required

Body Parameters

None.

Response Information

Response Codes

Http Code	Error Number	Description
200 request succesfully done	0	Successfully done
400 bad request	1002	Entry parameter missing or parameter bindigs failed
401 unauthorized	1000	Token {0} not found
401 unauthorized	1001	Token {0} already expired
401 unauthorized	1006	Ip filter violated for ip client address [{0}]
401 unauthorized	1007	Ip filter [{0}] parsing failed
401 unauthorized	1008	Request rate policy violated for [{0}]
403 server refuses fo fulfill the request	1141	Privilege View of agenda Identifiers violated for [{0}]
403 server refuses fo fulfill the request	1144	Record permission View of agenda Identifiers violated for [{0}]
404 required resource does not exist on the server	1140	Identifier [{0}] not found
415 unsupported Media Type		The request entity has a media type which the server or resource does not support. Only application/json and application/xml are supported
500 internal error		Server exception description

Resource Description

IdentifierGetResp

Name	Description	Type	Additional information
InternalNrLong	Long internal number of the identifer in hexadecimal format	string	None.
RegistrationNr	Registration number of the identifier	string	None.
Technology	Used technology of the identifier. The meaning is : 0 UNIQUE (H4102); 1 High Security (HS); 2 MIFARE (MF); 3 ABA Track; 4 HID; 5 Desfire	integer	None.
Type	Type of the idenfier. The meaning is: 0 - Card; 1 - Tag; 2 - Bracelet; 3 - Visiting card; 4 - Password; 5 - Article; 6 - Spare; 7 - eCard	integer	None.
Status	Actual status of the identifier. The meaning is: 0 - free, not yet assigned; 1 - Already assigned; 2 - Lost; 4 - Configuration	integer	None.
Holder	Person id or (License plate number if holder is a car) of the identifier holder	string	None.
Lock	Lock flag of the identifier. The meaning is: 0 - open; 1 - locked	integer	None.
Security	Security flag of the identifier; The meaning is: 0 - not secure identifier; 1 - secure identifier	integer	None.
ValidFrom	The begin of the identifier validity in format "yyyy-mm-ddThh:mi:ss". The time is included	string	None.
ValidTo	The end of the identifier validity in format "yyyy-mm-ddThh:mi:ss". The time is included	string	None.
TimeLastChange	The last change time of the data record. Can be used to check manual modification of data record	date	None.
HolderDefault	The identifier is default for its holder; The meaning is: 0 - is not default; 1 - is default	integer	None.
UdsCollection	The collection of available user defined columns of the agenda in the system: Any user defined columns have not been found	Collection of UdsOut	None.

Response Formats

application/json

Sample:

{"InternalNrLong":"0A1B2C3D4EFF","RegistrationNr":"RN100369","Technology":1,"Type":1,"Status":0,"Holder":"100200300","Lock":0,"Security":0,"ValidFrom":"2018-01-01 07:00:00","ValidTo":"2018-12-31 23:59:59","TimeLastChange":"\/Date(1729228394777)\/","HolderDefault":0,"UdsCollection":null}

application/xml

Sample:


<Response>
  <InternalNrLong>0A1B2C3D4EFF</InternalNrLong>
  <RegistrationNr>RN100369</RegistrationNr>
  <Technology>1</Technology>
  <Type>1</Type>
  <Holder>100200300</Holder>
  <Lock>0</Lock>
  <Security>0</Security>
  <ValidFrom>2018-01-01 07:00:00</ValidFrom>
  <ValidTo>2018-12-31 23:59:59</ValidTo>
  <TimeLastChange>2024-10-18T05:13:14.7778849Z</TimeLastChange>
  <HolderDefault>0</HolderDefault>
</Response>

text/json

Sample:

{
  "InternalNrLong": "sample string 1",
  "Holder": "sample string 6",
  "HolderDefault": 12,
  "UdsCollection": [
    {
      "SystemName": "sample string 1",
      "Name": "sample string 2",
      "Value": "sample string 3",
      "IsExtern": 4,
      "DataType": "sample string 5"
    },
    {
      "SystemName": "sample string 1",
      "Name": "sample string 2",
      "Value": "sample string 3",
      "IsExtern": 4,
      "DataType": "sample string 5"
    }
  ]
}

text/xml

Sample:

<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <InternalNrLong>sample string 1</InternalNrLong>
  <Holder>sample string 6</Holder>
  <HolderDefault>12</HolderDefault>
  <UdsCollection>
    <UdsOut>
      <SystemName>sample string 1</SystemName>
      <Name>sample string 2</Name>
      <Value>sample string 3</Value>
      <IsExtern>4</IsExtern>
      <DataType>sample string 5</DataType>
    </UdsOut>
    <UdsOut>
      <SystemName>sample string 1</SystemName>
      <Name>sample string 2</Name>
      <Value>sample string 3</Value>
      <IsExtern>4</IsExtern>
      <DataType>sample string 5</DataType>
    </UdsOut>
  </UdsCollection>
</Response>