POST visit/approve?Token={Token}
Approve existing visit by visited person.
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
VisitApproveReq| 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}$ |
| ApprovedByPerson |
Approved by person object |
SimplePerson |
Required |
| Reason |
The reason for approving the visit |
string |
Required String length: inclusive between 0 and 4000 |
Request Formats
application/json
Sample:
{"VisitId":"6bb93258-af78-4e5f-8ccb-5115529a7685","ApprovedByPerson":{"PersonId":"JB 007","Name":"Jack","Surname":"Bear","OrganizationStructure":null,"Presence":0},"Reason":"Specific reason"}
application/xml
Sample:
<Request>
<VisitId>6bb93258-af78-4e5f-8ccb-5115529a7685</VisitId>
<ApprovedByPerson>
<PersonId>JB 007</PersonId>
<Name>Jack</Name>
<Surname>Bear</Surname>
<Presence>0</Presence>
</ApprovedByPerson>
<Reason>Specific reason</Reason>
</Request>
text/json
Sample:
{
"VisitId": "357d235c-47d1-4ef7-a600-94ecf910e3b1",
"ApprovedByPerson": {
"PersonId": "sample string 1",
"Name": "sample string 2",
"Surname": "sample string 3",
"OrganizationStructure": "sample string 4",
"Presence": 5
},
"Reason": "sample string 2"
}
text/xml
Sample:
<Request xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<VisitId>357d235c-47d1-4ef7-a600-94ecf910e3b1</VisitId>
<ApprovedByPerson>
<PersonId>sample string 1</PersonId>
<Name>sample string 2</Name>
<Surname>sample string 3</Surname>
<OrganizationStructure>sample string 4</OrganizationStructure>
<Presence>5</Presence>
</ApprovedByPerson>
<Reason>sample string 2</Reason>
</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 | 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 | 1541 | VisitId [{0}] cannot be approved or already approved or ended |
| 403 server refuses fo fulfill the request | 1543 | Approving person has no rights to approve visit |
| 403 server refuses fo fulfill the request | 1544 | Updating visit ended with exception {0}. |
| 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 | 1542 | Approved person [personId: {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
VisitGetResp| Name | 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. |
Response Formats
application/json
Sample:
{"LastVisit":null,"VisitId":"6bb93258-af78-4e5f-8ccb-5115529a7685","Visitor":{"VisitorId":"190de305-9453-4127-96e4-27e20b64c902","Name":"Ian","Surname":"Apple","Firm":"The Big Company ltd.","Document":null,"FingerPrintISO":null,"FingerPrintSuprema":null,"Activities":[{"ActivityType":{"Title":"Activity A","Shortcut":"AA","Frequency":0,"Signed":0},"ValidTo":"\/Date(1779660000000)\/","Description":"Some description of this activity","Attachment":null},{"ActivityType":{"Title":"Activity B","Shortcut":"BB","Frequency":0,"Signed":0},"ValidTo":"\/Date(1780005600000)\/","Description":"Some description of this activity","Attachment":null}],"Email":"Ian@test","Mobile":"00420123456","Phone":"123456"},"Vehicle":null,"Trailer":null,"VisitType":null,"VisitedPerson":{"PersonId":"PB 007","Name":"Tina","Surname":"Goldeneye","OrganizationStructure":null,"Presence":0},"VisitedOrgStructure":null,"EscortedByPerson":null,"Identifier":null,"Reason":"Specific reason","State":0}
application/xml
Sample:
<Response>
<VisitId>6bb93258-af78-4e5f-8ccb-5115529a7685</VisitId>
<Visitor>
<VisitorId>190de305-9453-4127-96e4-27e20b64c902</VisitorId>
<Name>Ian</Name>
<Surname>Apple</Surname>
<Firm>The Big Company ltd.</Firm>
<Activities>
<VisitorActivity>
<ActivityType>
<Title>Activity A</Title>
<Shortcut>AA</Shortcut>
<Frequency>0</Frequency>
<Signed>0</Signed>
</ActivityType>
<ValidTo>2026-05-25T00:00:00+02:00</ValidTo>
<Description>Some description of this activity</Description>
</VisitorActivity>
<VisitorActivity>
<ActivityType>
<Title>Activity B</Title>
<Shortcut>BB</Shortcut>
<Frequency>0</Frequency>
<Signed>0</Signed>
</ActivityType>
<ValidTo>2026-05-29T00:00:00+02:00</ValidTo>
<Description>Some description of this activity</Description>
</VisitorActivity>
</Activities>
<Email>Ian@test</Email>
<Mobile>00420123456</Mobile>
<Phone>123456</Phone>
</Visitor>
<VisitedPerson>
<PersonId>PB 007</PersonId>
<Name>Tina</Name>
<Surname>Goldeneye</Surname>
<Presence>0</Presence>
</VisitedPerson>
<Reason>Specific reason</Reason>
<State>0</State>
</Response>
text/json
Sample:
{
"LastVisit": {
"VisitId": "d7adfdd8-9629-489a-af56-9ada93d1eafc",
"Visitor": {
"VisitorId": "cae56b8a-7acc-43a9-9a60-2d7f3e6dbd44",
"Name": "sample string 1",
"Surname": "sample string 2",
"Firm": "sample string 3",
"Document": {
"Nationality": "sample string 1",
"Sex": 2,
"Name": "sample string 1",
"Surname": "sample string 2",
"DocNumber": "sample string 3",
"DocType": 4,
"DateOfBirth": "2026-05-24T19:43:11.0813107+02:00",
"DateExpiration": "2026-05-24T19:43:11.0813107+02:00",
"State": "sample string 5"
},
"FingerPrintISO": "sample string 4",
"FingerPrintSuprema": "sample string 5",
"Activities": [
{
"ActivityType": {
"Title": "sample string 1",
"Shortcut": "sample string 2",
"Frequency": 3,
"Signed": 4
},
"ValidTo": "2026-05-24T19:43:11.0813107+02:00",
"Description": "sample string 1",
"Attachment": {
"Name": "sample string 1",
"Description": "sample string 2",
"Path": "sample string 3",
"Data": "QEA="
}
},
{
"ActivityType": {
"Title": "sample string 1",
"Shortcut": "sample string 2",
"Frequency": 3,
"Signed": 4
},
"ValidTo": "2026-05-24T19:43:11.0813107+02:00",
"Description": "sample string 1",
"Attachment": {
"Name": "sample string 1",
"Description": "sample string 2",
"Path": "sample string 3",
"Data": "QEA="
}
}
],
"Email": "sample string 6",
"Mobile": "sample string 7",
"Phone": "sample string 8"
},
"Vehicle": {
"LicenceNumber": "sample string 1",
"Brand": "sample string 2"
},
"Trailer": {
"LicenceNumber": "sample string 1",
"Brand": "sample string 2"
},
"VisitType": {
"Title": "sample string 1",
"Description": "sample string 2",
"ActivityTypes": [
{
"Title": "sample string 1",
"Shortcut": "sample string 2",
"Frequency": 3,
"Signed": 4
},
{
"Title": "sample string 1",
"Shortcut": "sample string 2",
"Frequency": 3,
"Signed": 4
}
],
"DocRequested": 3,
"VisitedPersonOrStructureRequested": 4,
"IdentifierRequested": 5,
"VisitPresentOnly": 6,
"VisitConfirmation": 7,
"VisitValidity": 8,
"GenerateEntryCode": 9
},
"VisitedPerson": {
"PersonId": "sample string 1",
"Name": "sample string 2",
"Surname": "sample string 3",
"OrganizationStructure": "sample string 4",
"Presence": 5
},
"VisitedOrgStructure": {
"Structure": "sample string 1",
"Title": "sample string 2"
},
"EscortedByPerson": {
"PersonId": "sample string 1",
"Name": "sample string 2",
"Surname": "sample string 3",
"OrganizationStructure": "sample string 4",
"Presence": 5
},
"Identifier": {
"InternalNrLong": "sample string 1",
"RegistrationNr": "sample string 2"
},
"Reason": "sample string 2",
"State": 3
},
"VisitId": "b8e42a9e-37d5-4832-9510-80778922de2c",
"Visitor": {
"VisitorId": "cae56b8a-7acc-43a9-9a60-2d7f3e6dbd44",
"Name": "sample string 1",
"Surname": "sample string 2",
"Firm": "sample string 3",
"Document": {
"Nationality": "sample string 1",
"Sex": 2,
"Name": "sample string 1",
"Surname": "sample string 2",
"DocNumber": "sample string 3",
"DocType": 4,
"DateOfBirth": "2026-05-24T19:43:11.0813107+02:00",
"DateExpiration": "2026-05-24T19:43:11.0813107+02:00",
"State": "sample string 5"
},
"FingerPrintISO": "sample string 4",
"FingerPrintSuprema": "sample string 5",
"Activities": [
{
"ActivityType": {
"Title": "sample string 1",
"Shortcut": "sample string 2",
"Frequency": 3,
"Signed": 4
},
"ValidTo": "2026-05-24T19:43:11.0813107+02:00",
"Description": "sample string 1",
"Attachment": {
"Name": "sample string 1",
"Description": "sample string 2",
"Path": "sample string 3",
"Data": "QEA="
}
},
{
"ActivityType": {
"Title": "sample string 1",
"Shortcut": "sample string 2",
"Frequency": 3,
"Signed": 4
},
"ValidTo": "2026-05-24T19:43:11.0813107+02:00",
"Description": "sample string 1",
"Attachment": {
"Name": "sample string 1",
"Description": "sample string 2",
"Path": "sample string 3",
"Data": "QEA="
}
}
],
"Email": "sample string 6",
"Mobile": "sample string 7",
"Phone": "sample string 8"
},
"Vehicle": {
"LicenceNumber": "sample string 1",
"Brand": "sample string 2"
},
"Trailer": {
"LicenceNumber": "sample string 1",
"Brand": "sample string 2"
},
"VisitType": {
"Title": "sample string 1",
"Description": "sample string 2",
"ActivityTypes": [
{
"Title": "sample string 1",
"Shortcut": "sample string 2",
"Frequency": 3,
"Signed": 4
},
{
"Title": "sample string 1",
"Shortcut": "sample string 2",
"Frequency": 3,
"Signed": 4
}
],
"DocRequested": 3,
"VisitedPersonOrStructureRequested": 4,
"IdentifierRequested": 5,
"VisitPresentOnly": 6,
"VisitConfirmation": 7,
"VisitValidity": 8,
"GenerateEntryCode": 9
},
"VisitedPerson": {
"PersonId": "sample string 1",
"Name": "sample string 2",
"Surname": "sample string 3",
"OrganizationStructure": "sample string 4",
"Presence": 5
},
"VisitedOrgStructure": {
"Structure": "sample string 1",
"Title": "sample string 2"
},
"EscortedByPerson": {
"PersonId": "sample string 1",
"Name": "sample string 2",
"Surname": "sample string 3",
"OrganizationStructure": "sample string 4",
"Presence": 5
},
"Identifier": {
"InternalNrLong": "sample string 1",
"RegistrationNr": "sample string 2"
},
"Reason": "sample string 2",
"State": 3
}
text/xml
Sample:
<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<LastVisit>
<VisitId>d7adfdd8-9629-489a-af56-9ada93d1eafc</VisitId>
<Visitor>
<VisitorId>cae56b8a-7acc-43a9-9a60-2d7f3e6dbd44</VisitorId>
<Name>sample string 1</Name>
<Surname>sample string 2</Surname>
<Firm>sample string 3</Firm>
<Document>
<Nationality>sample string 1</Nationality>
<Sex>2</Sex>
<Name>sample string 1</Name>
<Surname>sample string 2</Surname>
<DocNumber>sample string 3</DocNumber>
<DocType>4</DocType>
<DateOfBirth>2026-05-24T19:43:11.0813107+02:00</DateOfBirth>
<DateExpiration>2026-05-24T19:43:11.0813107+02:00</DateExpiration>
<State>sample string 5</State>
</Document>
<FingerPrintISO>sample string 4</FingerPrintISO>
<FingerPrintSuprema>sample string 5</FingerPrintSuprema>
<Activities>
<VisitorActivity>
<ActivityType>
<Title>sample string 1</Title>
<Shortcut>sample string 2</Shortcut>
<Frequency>3</Frequency>
<Signed>4</Signed>
</ActivityType>
<ValidTo>2026-05-24T19:43:11.0813107+02:00</ValidTo>
<Description>sample string 1</Description>
<Attachment>
<Name>sample string 1</Name>
<Description>sample string 2</Description>
<Path>sample string 3</Path>
<Data>QEA=</Data>
</Attachment>
</VisitorActivity>
<VisitorActivity>
<ActivityType>
<Title>sample string 1</Title>
<Shortcut>sample string 2</Shortcut>
<Frequency>3</Frequency>
<Signed>4</Signed>
</ActivityType>
<ValidTo>2026-05-24T19:43:11.0813107+02:00</ValidTo>
<Description>sample string 1</Description>
<Attachment>
<Name>sample string 1</Name>
<Description>sample string 2</Description>
<Path>sample string 3</Path>
<Data>QEA=</Data>
</Attachment>
</VisitorActivity>
</Activities>
<Email>sample string 6</Email>
<Mobile>sample string 7</Mobile>
<Phone>sample string 8</Phone>
</Visitor>
<Vehicle>
<LicenceNumber>sample string 1</LicenceNumber>
<Brand>sample string 2</Brand>
</Vehicle>
<Trailer>
<LicenceNumber>sample string 1</LicenceNumber>
<Brand>sample string 2</Brand>
</Trailer>
<VisitType>
<Title>sample string 1</Title>
<Description>sample string 2</Description>
<ActivityTypes>
<VisitorActivityType>
<Title>sample string 1</Title>
<Shortcut>sample string 2</Shortcut>
<Frequency>3</Frequency>
<Signed>4</Signed>
</VisitorActivityType>
<VisitorActivityType>
<Title>sample string 1</Title>
<Shortcut>sample string 2</Shortcut>
<Frequency>3</Frequency>
<Signed>4</Signed>
</VisitorActivityType>
</ActivityTypes>
<DocRequested>3</DocRequested>
<VisitedPersonOrStructureRequested>4</VisitedPersonOrStructureRequested>
<IdentifierRequested>5</IdentifierRequested>
<VisitPresentOnly>6</VisitPresentOnly>
<VisitConfirmation>7</VisitConfirmation>
<VisitValidity>8</VisitValidity>
<GenerateEntryCode>9</GenerateEntryCode>
</VisitType>
<VisitedPerson>
<PersonId>sample string 1</PersonId>
<Name>sample string 2</Name>
<Surname>sample string 3</Surname>
<OrganizationStructure>sample string 4</OrganizationStructure>
<Presence>5</Presence>
</VisitedPerson>
<VisitedOrgStructure>
<Structure>sample string 1</Structure>
<Title>sample string 2</Title>
</VisitedOrgStructure>
<EscortedByPerson>
<PersonId>sample string 1</PersonId>
<Name>sample string 2</Name>
<Surname>sample string 3</Surname>
<OrganizationStructure>sample string 4</OrganizationStructure>
<Presence>5</Presence>
</EscortedByPerson>
<Identifier>
<InternalNrLong>sample string 1</InternalNrLong>
<RegistrationNr>sample string 2</RegistrationNr>
</Identifier>
<Reason>sample string 2</Reason>
<State>3</State>
</LastVisit>
<VisitId>b8e42a9e-37d5-4832-9510-80778922de2c</VisitId>
<Visitor>
<VisitorId>cae56b8a-7acc-43a9-9a60-2d7f3e6dbd44</VisitorId>
<Name>sample string 1</Name>
<Surname>sample string 2</Surname>
<Firm>sample string 3</Firm>
<Document>
<Nationality>sample string 1</Nationality>
<Sex>2</Sex>
<Name>sample string 1</Name>
<Surname>sample string 2</Surname>
<DocNumber>sample string 3</DocNumber>
<DocType>4</DocType>
<DateOfBirth>2026-05-24T19:43:11.0813107+02:00</DateOfBirth>
<DateExpiration>2026-05-24T19:43:11.0813107+02:00</DateExpiration>
<State>sample string 5</State>
</Document>
<FingerPrintISO>sample string 4</FingerPrintISO>
<FingerPrintSuprema>sample string 5</FingerPrintSuprema>
<Activities>
<VisitorActivity>
<ActivityType>
<Title>sample string 1</Title>
<Shortcut>sample string 2</Shortcut>
<Frequency>3</Frequency>
<Signed>4</Signed>
</ActivityType>
<ValidTo>2026-05-24T19:43:11.0813107+02:00</ValidTo>
<Description>sample string 1</Description>
<Attachment>
<Name>sample string 1</Name>
<Description>sample string 2</Description>
<Path>sample string 3</Path>
<Data>QEA=</Data>
</Attachment>
</VisitorActivity>
<VisitorActivity>
<ActivityType>
<Title>sample string 1</Title>
<Shortcut>sample string 2</Shortcut>
<Frequency>3</Frequency>
<Signed>4</Signed>
</ActivityType>
<ValidTo>2026-05-24T19:43:11.0813107+02:00</ValidTo>
<Description>sample string 1</Description>
<Attachment>
<Name>sample string 1</Name>
<Description>sample string 2</Description>
<Path>sample string 3</Path>
<Data>QEA=</Data>
</Attachment>
</VisitorActivity>
</Activities>
<Email>sample string 6</Email>
<Mobile>sample string 7</Mobile>
<Phone>sample string 8</Phone>
</Visitor>
<Vehicle>
<LicenceNumber>sample string 1</LicenceNumber>
<Brand>sample string 2</Brand>
</Vehicle>
<Trailer>
<LicenceNumber>sample string 1</LicenceNumber>
<Brand>sample string 2</Brand>
</Trailer>
<VisitType>
<Title>sample string 1</Title>
<Description>sample string 2</Description>
<ActivityTypes>
<VisitorActivityType>
<Title>sample string 1</Title>
<Shortcut>sample string 2</Shortcut>
<Frequency>3</Frequency>
<Signed>4</Signed>
</VisitorActivityType>
<VisitorActivityType>
<Title>sample string 1</Title>
<Shortcut>sample string 2</Shortcut>
<Frequency>3</Frequency>
<Signed>4</Signed>
</VisitorActivityType>
</ActivityTypes>
<DocRequested>3</DocRequested>
<VisitedPersonOrStructureRequested>4</VisitedPersonOrStructureRequested>
<IdentifierRequested>5</IdentifierRequested>
<VisitPresentOnly>6</VisitPresentOnly>
<VisitConfirmation>7</VisitConfirmation>
<VisitValidity>8</VisitValidity>
<GenerateEntryCode>9</GenerateEntryCode>
</VisitType>
<VisitedPerson>
<PersonId>sample string 1</PersonId>
<Name>sample string 2</Name>
<Surname>sample string 3</Surname>
<OrganizationStructure>sample string 4</OrganizationStructure>
<Presence>5</Presence>
</VisitedPerson>
<VisitedOrgStructure>
<Structure>sample string 1</Structure>
<Title>sample string 2</Title>
</VisitedOrgStructure>
<EscortedByPerson>
<PersonId>sample string 1</PersonId>
<Name>sample string 2</Name>
<Surname>sample string 3</Surname>
<OrganizationStructure>sample string 4</OrganizationStructure>
<Presence>5</Presence>
</EscortedByPerson>
<Identifier>
<InternalNrLong>sample string 1</InternalNrLong>
<RegistrationNr>sample string 2</RegistrationNr>
</Identifier>
<Reason>sample string 2</Reason>
<State>3</State>
</Response>