GET identifier/getAll?PageNumber={PageNumber}&PageSize={PageSize}&Token={Token}
Retrieve data for all identifiers. 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 |
---|---|---|---|
PageNumber |
Optional parameter may be omitted. All records are displayed when is omitted otherwise specific page is displayed |
integer |
Matching regular expression pattern: ([0-9]+) |
PageSize |
Optional parameter may be omitted. Define number of records in the page. |
integer |
Matching regular expression pattern: ([0-9]+) |
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}] |
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
IdentifierGetAllRespName | Description | Type | Additional information |
---|---|---|---|
Identifiers | Collection of Identifier |
None. |
|
Paging | PagingResp |
None. |
Response Formats
application/json
Sample:
{"Identifiers":[{"InternalNrLong":"0A1B2C3D4EF1","Type":2,"Status":0,"Holder":null,"HolderDefault":0,"TimeLastChange":"\/Date(1747198575626)\/","RegistrationNr":null,"Technology":0,"Lock":0,"Security":0,"ValidFrom":null,"ValidTo":null,"UdsCollection":null},{"InternalNrLong":"0A1B2C3D4EF2","Type":1,"Status":0,"Holder":null,"HolderDefault":0,"TimeLastChange":"\/Date(1747198575626)\/","RegistrationNr":null,"Technology":0,"Lock":0,"Security":0,"ValidFrom":null,"ValidTo":null,"UdsCollection":null},{"InternalNrLong":"0A1B2C3D4EF3","Type":3,"Status":1,"Holder":"00065","HolderDefault":0,"TimeLastChange":"\/Date(1747198575626)\/","RegistrationNr":null,"Technology":0,"Lock":0,"Security":0,"ValidFrom":null,"ValidTo":null,"UdsCollection":null}],"Paging":{"CurrentPage":1,"PageSize":25,"TotalCount":3,"TotalPages":1}}
application/xml
Sample:
<Response> <Identifiers> <Identifier> <InternalNrLong>0A1B2C3D4EF1</InternalNrLong> <Type>2</Type> <HolderDefault>0</HolderDefault> <TimeLastChange>2025-05-14T04:56:15.6268917Z</TimeLastChange> <Technology>0</Technology> <Lock>0</Lock> <Security>0</Security> </Identifier> <Identifier> <InternalNrLong>0A1B2C3D4EF2</InternalNrLong> <Type>1</Type> <HolderDefault>0</HolderDefault> <TimeLastChange>2025-05-14T04:56:15.6268917Z</TimeLastChange> <Technology>0</Technology> <Lock>0</Lock> <Security>0</Security> </Identifier> <Identifier> <InternalNrLong>0A1B2C3D4EF3</InternalNrLong> <Type>3</Type> <Holder>00065</Holder> <HolderDefault>0</HolderDefault> <TimeLastChange>2025-05-14T04:56:15.6268917Z</TimeLastChange> <Technology>0</Technology> <Lock>0</Lock> <Security>0</Security> </Identifier> </Identifiers> <Paging> <CurrentPage>1</CurrentPage> <PageSize>25</PageSize> <TotalCount>3</TotalCount> <TotalPages>1</TotalPages> </Paging> </Response>