POST identifier/create?Token={Token}

Create identifier in the system. Application privilege "New" for licensed agenda "Identifiers" required. No record permissions restriction implemented.

Request Information

Authorization

Authorization by token required

Availability

Method can be used

URI Parameters

Name	Description	Type	Additional information
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

IdentifierCreateReq

Name	Description	Type	Additional information
InternalNrLong	Long internal number of the identifer in hexadecimal format. Leading zeros will be removed	string	Required Matching regular expression pattern: [0-9a-fA-F]+ String length: inclusive between 0 and 20
RegistrationNr	Registration number of the identifier	string	Required String length: inclusive between 0 and 100
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	Required Matching regular expression pattern: [0,1,2,3,4,5]
Type	Type of the identifier. The meaning is: 0 - Card; 1 - Tag; 2 - Bracelet; 3 - Visiting card; 4 - EntryCode; 5 - Article, not supported by WebAPI	integer	Required Matching regular expression pattern: [0,1,2,3,4]
Status	Actual status od the identifier. The meaning is: 0 - free, not yet assigned; 1 - Already assigned, not supported by WebAPI Base identifier management; 2 - Lost; 4 - Configuration, not supported by WebAPI	integer	Matching regular expression pattern: [0,2]
Lock	Lock flag of the identifier. The meaning is: 0 - open; 1 - locked	integer	Range: inclusive between 0 and 1
Security	Security flag of the identifier; The meaning is: 0 - not secure identifier; 1 - secure identifier	integer	Range: inclusive between 0 and 1
ValidFrom	The begin of the identifier validity in format "yyyy-MM-ddTHH:mi:ss".	date	Data type: Date
ValidTo	The end of the identifier validity in format "yyyy-MM-ddTHH:mi:ss".	date	Data type: Date

Request Formats

application/json

Sample:

{"InternalNrLong":"0105AF00BC","RegistrationNr":"1000234","Technology":2,"Type":1,"Status":0,"Lock":1,"Security":1,"ValidFrom":"\/Date(1729228394871)\/","ValidTo":"\/Date(1823836394871)\/"}

application/xml

Sample:


<Request>
  <InternalNrLong>0105AF00BC</InternalNrLong>
  <RegistrationNr>1000234</RegistrationNr>
  <Technology>2</Technology>
  <Type>1</Type>
  <Status>0</Status>
  <Lock>1</Lock>
  <Security>1</Security>
  <ValidFrom>2024-10-18T05:13:14.8716401Z</ValidFrom>
  <ValidTo>2027-10-18T05:13:14.8716401Z</ValidTo>
</Request>

text/json

Sample:

{
  "InternalNrLong": "sample string 1",
  "RegistrationNr": "sample string 2",
  "Technology": 3,
  "Type": 4,
  "Status": 5,
  "Lock": 6,
  "Security": 7,
  "ValidFrom": "2024-10-18T13:28:54.6127454+02:00",
  "ValidTo": "2024-10-18T13:28:54.6127454+02:00"
}

text/xml

Sample:

<Request xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <InternalNrLong>sample string 1</InternalNrLong>
  <RegistrationNr>sample string 2</RegistrationNr>
  <Technology>3</Technology>
  <Type>4</Type>
  <Status>5</Status>
  <Lock>6</Lock>
  <Security>7</Security>
  <ValidFrom>2024-10-18T13:28:54.6127454+02:00</ValidFrom>
  <ValidTo>2024-10-18T13:28:54.6127454+02:00</ValidTo>
</Request>

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	1145	Privilege New of agenda Identifiers violated for [{0}]
403 server refuses fo fulfill the request	1	Db operation failed, agenda missing priviliges
403 server refuses fo fulfill the request	2	Db operation failed, record missing priviliges
403 server refuses fo fulfill the request	3	Db operation failed, Record duplicity
403 server refuses fo fulfill the request	4	Db operation failed, already changed by another user
403 server refuses fo fulfill the request	5	Db operation failed, already deleted by another user
403 server refuses fo fulfill the request	6	Db operation failed, database data consistence violation
403 server refuses fo fulfill the request	7	Db operation failed, operation can not be executed because another problems occured
403 server refuses fo fulfill the request	8	Db operation failed, licence violation
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

BaseRespOfIdentifierCreateReq

Name	Description	Type	Additional information
Result		RequestResult	None.
Request		IdentifierCreateReq	None.

Response Formats

application/json

Sample:

{"Result":{"Message":"Processed with result: ExecOK","Code":0,"ModelStateErr":null},"Request":{"InternalNrLong":"0105AF00BC","RegistrationNr":"1000234","Technology":2,"Type":1,"Status":0,"Lock":1,"Security":1,"ValidFrom":"\/Date(1729228394871)\/","ValidTo":"\/Date(1823836394871)\/"}}

application/xml

Sample:


<Response>
  <Result>
    <Message>Processed with result: ExecOK</Message>
    <Code>0</Code>
  </Result>
  <Request>
    <InternalNrLong>0105AF00BC</InternalNrLong>
    <RegistrationNr>1000234</RegistrationNr>
    <Technology>2</Technology>
    <Type>1</Type>
    <Status>0</Status>
    <Lock>1</Lock>
    <Security>1</Security>
    <ValidFrom>2024-10-18T05:13:14.8716401Z</ValidFrom>
    <ValidTo>2027-10-18T05:13:14.8716401Z</ValidTo>
  </Request>
</Response>

text/json

Sample:

{
  "Result": {
    "Message": "sample string 1",
    "Code": 2,
    "ModelStateErr": [
      "sample string 1",
      "sample string 2"
    ]
  },
  "Request": {
    "InternalNrLong": "sample string 1",
    "RegistrationNr": "sample string 2",
    "Technology": 3,
    "Type": 4,
    "Status": 5,
    "Lock": 6,
    "Security": 7,
    "ValidFrom": "2024-10-18T13:28:54.6284576+02:00",
    "ValidTo": "2024-10-18T13:28:54.6284576+02:00"
  }
}

text/xml

Sample:

<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Result>
    <Message>sample string 1</Message>
    <Code>2</Code>
    <ModelStateErr>
      <string>sample string 1</string>
      <string>sample string 2</string>
    </ModelStateErr>
  </Result>
  <Request>
    <InternalNrLong>sample string 1</InternalNrLong>
    <RegistrationNr>sample string 2</RegistrationNr>
    <Technology>3</Technology>
    <Type>4</Type>
    <Status>5</Status>
    <Lock>6</Lock>
    <Security>7</Security>
    <ValidFrom>2024-10-18T13:28:54.6284576+02:00</ValidFrom>
    <ValidTo>2024-10-18T13:28:54.6284576+02:00</ValidTo>
  </Request>
</Response>