POST visit/schedule?Token={Token}

Create a scheduled visit, visitor, visitor's car, and document in the system. Agenda "Visit" has to be licensed. Privilege "New" of licensed agenda "Visits" required.

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

VisitScheduleReq

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}$
VisitDate	The visit date	date	Required
Visitor	The visitor encapsulating object	Visitor	Required
Vehicle	The visitor vehicle object	VisitorVehicle	None.
Trailer	The visitor trailer object	VisitorVehicle	None.
VisitType	The visit type object	VisitType	Required
VisitedPerson	Visited person object	SimplePerson	None.
VisitedOrgStructure	Organization structure object	OrgStructure	None.
Reason	The reason of the visit	string	Required String length: inclusive between 0 and 4000

Request Formats

application/json

Sample:

{"VisitId":"ccdde75f-a7ea-42dd-92e4-7fe542cef53d","VisitDate":"\/Date(1761865200000)\/","Visitor":{"VisitorId":"154d2c37-728f-4bcc-9c59-f436f1840bee","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(1761778800000)\/","Description":"Some description of this activity","Attachment":null},{"ActivityType":{"Title":"Activity B","Shortcut":"BB","Frequency":0,"Signed":0},"ValidTo":"\/Date(1762124400000)\/","Description":"Some description of this activity","Attachment":null}],"Email":"Ian@test","Mobile":"00420123456","Phone":"123456"},"Vehicle":null,"Trailer":null,"VisitType":{"Title":"Common visit","Description":null,"ActivityTypes":null,"DocRequested":1,"VisitedPersonOrStructureRequested":1,"IdentifierRequested":1,"VisitPresentOnly":1,"VisitConfirmation":0,"VisitValidity":1,"GenerateEntryCode":1},"VisitedPerson":{"PersonId":"PB 007","Name":"Tina","Surname":"Goldeneye","OrganizationStructure":null,"Presence":0},"VisitedOrgStructure":null,"Reason":"Meeting with Tina"}

application/xml

Sample:


<Request>
  <VisitId>ccdde75f-a7ea-42dd-92e4-7fe542cef53d</VisitId>
  <VisitDate>2025-10-31T00:00:00+01:00</VisitDate>
  <Visitor>
    <VisitorId>154d2c37-728f-4bcc-9c59-f436f1840bee</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>2025-10-30T00:00:00+01: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>2025-11-03T00:00:00+01:00</ValidTo>
        <Description>Some description of this activity</Description>
      </VisitorActivity>
    </Activities>
    <Email>Ian@test</Email>
    <Mobile>00420123456</Mobile>
    <Phone>123456</Phone>
  </Visitor>
  <VisitType>
    <Title>Common visit</Title>
    <DocRequested>1</DocRequested>
    <VisitedPersonOrStructureRequested>1</VisitedPersonOrStructureRequested>
    <IdentifierRequested>1</IdentifierRequested>
    <VisitPresentOnly>1</VisitPresentOnly>
    <VisitConfirmation>0</VisitConfirmation>
    <VisitValidity>1</VisitValidity>
    <GenerateEntryCode>1</GenerateEntryCode>
  </VisitType>
  <VisitedPerson>
    <PersonId>PB 007</PersonId>
    <Name>Tina</Name>
    <Surname>Goldeneye</Surname>
    <Presence>0</Presence>
  </VisitedPerson>
  <Reason>Meeting with Tina</Reason>
</Request>

Response Information

Response Codes

Http Code	Error Number	Description
200 request succesfully done	0	Successfully done
202 accepted for processing	0	Create activity of type [{0}] for visitor [{1}] failed. Exception:{2}
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	1520	Privilege New of agenda Visits violated for [VisitID {0}]
403 server refuses fo fulfill the request	8	Not licensed
403 server refuses fo fulfill the request	1506	VisitId [{0}] already exist
403 server refuses fo fulfill the request	1533	Fp by other person
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	Not licensed
404 required resource does not exist on the server	1160	Organization structure [{0}] not found
404 required resource does not exist on the server	1508	Visited person [personId: {0}] not found
404 required resource does not exist on the server	1510	Visit type [{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

BaseRespOfVisitCreateReq

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

Response Formats

application/json

Sample:

{"Result":{"Message":"Processed with result: ExecOK","Code":0,"ModelStateErr":null},"Request":{"VisitId":"ccdde75f-a7ea-42dd-92e4-7fe542cef53d","Visitor":{"VisitorId":"154d2c37-728f-4bcc-9c59-f436f1840bee","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(1761778800000)\/","Description":"Some description of this activity","Attachment":null},{"ActivityType":{"Title":"Activity B","Shortcut":"BB","Frequency":0,"Signed":0},"ValidTo":"\/Date(1762124400000)\/","Description":"Some description of this activity","Attachment":null}],"Email":"Ian@test","Mobile":"00420123456","Phone":"123456"},"Vehicle":null,"Trailer":null,"VisitType":{"Title":"Common visit","Description":null,"ActivityTypes":null,"DocRequested":1,"VisitedPersonOrStructureRequested":1,"IdentifierRequested":1,"VisitPresentOnly":1,"VisitConfirmation":0,"VisitValidity":1,"GenerateEntryCode":1},"VisitedPerson":{"PersonId":"PB 007","Name":"Tina","Surname":"Goldeneye","OrganizationStructure":null,"Presence":0},"VisitedOrgStructure":null,"EscortedByPerson":null,"Identifier":null,"Reason":"Meeting with Tina","Photos":null}}

application/xml

Sample:


<Response>
  <Result>
    <Message>Processed with result: ExecOK</Message>
    <Code>0</Code>
  </Result>
  <Request>
    <VisitId>ccdde75f-a7ea-42dd-92e4-7fe542cef53d</VisitId>
    <Visitor>
      <VisitorId>154d2c37-728f-4bcc-9c59-f436f1840bee</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>2025-10-30T00:00:00+01: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>2025-11-03T00:00:00+01:00</ValidTo>
          <Description>Some description of this activity</Description>
        </VisitorActivity>
      </Activities>
      <Email>Ian@test</Email>
      <Mobile>00420123456</Mobile>
      <Phone>123456</Phone>
    </Visitor>
    <VisitType>
      <Title>Common visit</Title>
      <DocRequested>1</DocRequested>
      <VisitedPersonOrStructureRequested>1</VisitedPersonOrStructureRequested>
      <IdentifierRequested>1</IdentifierRequested>
      <VisitPresentOnly>1</VisitPresentOnly>
      <VisitConfirmation>0</VisitConfirmation>
      <VisitValidity>1</VisitValidity>
      <GenerateEntryCode>1</GenerateEntryCode>
    </VisitType>
    <VisitedPerson>
      <PersonId>PB 007</PersonId>
      <Name>Tina</Name>
      <Surname>Goldeneye</Surname>
      <Presence>0</Presence>
    </VisitedPerson>
    <Reason>Meeting with Tina</Reason>
  </Request>
</Response>