GET visit/getIdentifierEntryCode?VisitId={VisitId}&Token={Token}
Retrieve visit IdentifierEntryCode using Visit id.
Request Information
Authorization
- Authorization by token required
Availability
- Method can be used
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| VisitId |
The visit identifier |
globally unique identifier |
Required Matching regular expression pattern: ^({){0,1}[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}(}){0,1}$ |
| 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 | 8 | Not licensed |
| 404 required resource does not exist on the server | 1540 | Visit not exists |
| 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
VisitGetIdentifierEntryCodeResp| Name | Description | Type | Additional information |
|---|---|---|---|
| IdentifierEntryCode |
Visit's identifier entry code |
string |
None. |
| IdentifierEntryCodeQR |
Visit's identifier entry code as QR value. |
string |
None. |
Response Formats
application/json, text/json
Sample:
{
"IdentifierEntryCode": "sample string 1",
"IdentifierEntryCodeQR": "sample string 2"
}
application/xml, text/xml
Sample:
<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <IdentifierEntryCode>sample string 1</IdentifierEntryCode> <IdentifierEntryCodeQR>sample string 2</IdentifierEntryCodeQR> </Response>