POST visit/end?Token={Token}
Ends existing visit.
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
VisitEndReqName | 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}$ |
Reason |
The reason for ending the visit |
string |
Required String length: inclusive between 0 and 4000 |
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 | 1516 | Privilege View of agenda Visits violated |
403 server refuses fo fulfill the request | 1537 | Record permission View of agenda Visits violated |
403 server refuses fo fulfill the request | 8 | Not licensed |
403 server refuses fo fulfill the request | 1545 | VisitId [{0}] cannot be ended |
404 required resource does not exist on the server | 1517 | Visit not found |
404 required resource does not exist on the server | 1540 | Visit not exists |
404 required resource does not exist on the server | 1544 | Updating visit ended with exception {0}. |
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
VisitGetRespName | Description | Type | Additional information |
---|---|---|---|
LastVisit |
Last visit data |
Visit |
None. |
VisitId |
Unique identification of the visit in the system |
globally unique identifier |
None. |
Visitor |
Visitor's data |
Visitor |
None. |
Vehicle |
Visitor's vehicle data |
VisitorVehicle |
None. |
Trailer |
Visitor's trailer data |
VisitorVehicle |
None. |
VisitType |
Visit type |
VisitType |
None. |
VisitedPerson |
Visited person |
SimplePerson |
None. |
VisitedOrgStructure |
Visited organization structure |
OrgStructure |
None. |
EscortedByPerson |
Visitor is escorted by |
SimplePerson |
None. |
Identifier |
Visitor's identification card |
VisitorIdentifier |
None. |
Reason |
Visit's reason. |
string |
None. |
State |
Visit state. The value meaning: new visit = 0; planned visit = 1; verified documents, PIN or finger prints = 2; not valid activity = 3; not confirmed by escort = 4; all is valid = 5; visit is in area = 6; visit left = 7; rejected = 8; |
integer |
None. |