Error
A valid request URL is required to generate request examples{
"arrival": {
"aqActualArrivalTime": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"sysidHost": 12345,
"sysidVisitType": 12345,
"sysidReservation": 12345,
"notes": "...",
"acknowledgements": [
{
"accepted": true,
"sysidConfigAcknowledgement": 12345,
"sysidVisitorAcknowledgement": 12345
},
{
"accepted": true,
"sysidConfigAcknowledgement": 12345,
"sysidVisitorAcknowledgement": 12345
}
],
"sysidVisitCreator": 12345,
"aqActualDepartureTime": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"sysidVenue": 12345,
"visitType": "SiteVisit",
"aqArrivalTime": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"sysidVisitorArrival": 12345,
"coVisitors": [
{
"visitorName": "...",
"sysidVisitorArrivalCoVisitor": 12345
},
{
"visitorName": "...",
"sysidVisitorArrivalCoVisitor": 12345
}
],
"aqDepartureTime": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"sysidVisitor": 12345,
"coVisitorCount": 12345,
"sysidAltHost": 12345,
"sysidActionType": 12345,
"readOnlyActions": [
{
"aqActionTime": {},
"sysidActionType": 12345,
"sysidVisitorAction": 12345,
"sysidUserPerformer": 12345
},
{
"aqActionTime": {},
"sysidActionType": 12345,
"sysidVisitorAction": 12345,
"sysidUserPerformer": 12345
}
]
},
"visitor": {
"sysidVisitor": 12345,
"country": "...",
"sysidLanguage": 12345,
"firstName": "...",
"active": true,
"lastName": "...",
"visitorImages": [
{
"displayOrder": 12345,
"imageSource": "...",
"height": 12345,
"thumbnailSource": "...",
"sysidVisitorImage": 12345,
"defaultImage": true,
"width": 12345
},
{
"displayOrder": 12345,
"imageSource": "...",
"height": 12345,
"thumbnailSource": "...",
"sysidVisitorImage": 12345,
"defaultImage": true,
"width": 12345
}
],
"company": "...",
"designation": "...",
"emailAddress": "...",
"phoneNumber": "...",
"address": "..."
}
}VisitorService
Post visitors
Creates a new Visitor for an account.
The requesting User must have one of the following rights to perform this task: AuthRuleType.VISITOR_ADMIN Requestor is a Visitor Manager for the venue Requestor is a Super Host, or Super Alt-Host, at the Venue This operation requires a Create Visitor Data value. The CreateVisitorData has the following fields: Name Data Type Required Description visitor Visitor Data REQUIRED The visitor to be created. arrival Visitor Arrival REQUIRED The visitor arrival to be created.
The requesting User must have one of the following rights to perform this task:
This operation requires a Create Visitor Data value. The CreateVisitorData has the following fields:
POST
/
visitors
Error
A valid request URL is required to generate request examples{
"arrival": {
"aqActualArrivalTime": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"sysidHost": 12345,
"sysidVisitType": 12345,
"sysidReservation": 12345,
"notes": "...",
"acknowledgements": [
{
"accepted": true,
"sysidConfigAcknowledgement": 12345,
"sysidVisitorAcknowledgement": 12345
},
{
"accepted": true,
"sysidConfigAcknowledgement": 12345,
"sysidVisitorAcknowledgement": 12345
}
],
"sysidVisitCreator": 12345,
"aqActualDepartureTime": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"sysidVenue": 12345,
"visitType": "SiteVisit",
"aqArrivalTime": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"sysidVisitorArrival": 12345,
"coVisitors": [
{
"visitorName": "...",
"sysidVisitorArrivalCoVisitor": 12345
},
{
"visitorName": "...",
"sysidVisitorArrivalCoVisitor": 12345
}
],
"aqDepartureTime": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"sysidVisitor": 12345,
"coVisitorCount": 12345,
"sysidAltHost": 12345,
"sysidActionType": 12345,
"readOnlyActions": [
{
"aqActionTime": {},
"sysidActionType": 12345,
"sysidVisitorAction": 12345,
"sysidUserPerformer": 12345
},
{
"aqActionTime": {},
"sysidActionType": 12345,
"sysidVisitorAction": 12345,
"sysidUserPerformer": 12345
}
]
},
"visitor": {
"sysidVisitor": 12345,
"country": "...",
"sysidLanguage": 12345,
"firstName": "...",
"active": true,
"lastName": "...",
"visitorImages": [
{
"displayOrder": 12345,
"imageSource": "...",
"height": 12345,
"thumbnailSource": "...",
"sysidVisitorImage": 12345,
"defaultImage": true,
"width": 12345
},
{
"displayOrder": 12345,
"imageSource": "...",
"height": 12345,
"thumbnailSource": "...",
"sysidVisitorImage": 12345,
"defaultImage": true,
"width": 12345
}
],
"company": "...",
"designation": "...",
"emailAddress": "...",
"phoneNumber": "...",
"address": "..."
}
}Body
application/json
: CreateVisitorData. See VisitorData and VisitorArrival
Show child attributes
Show child attributes
Example:
{
"aqActualArrivalTime": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"sysidHost": 12345,
"sysidVisitType": 12345,
"sysidReservation": 12345,
"notes": "...",
"acknowledgements": [
{
"accepted": true,
"sysidConfigAcknowledgement": 12345,
"sysidVisitorAcknowledgement": 12345
},
{
"accepted": true,
"sysidConfigAcknowledgement": 12345,
"sysidVisitorAcknowledgement": 12345
}
],
"sysidVisitCreator": 12345,
"aqActualDepartureTime": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"sysidVenue": 12345,
"visitType": "SiteVisit",
"aqArrivalTime": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"sysidVisitorArrival": 12345,
"coVisitors": [
{
"visitorName": "...",
"sysidVisitorArrivalCoVisitor": 12345
},
{
"visitorName": "...",
"sysidVisitorArrivalCoVisitor": 12345
}
],
"aqDepartureTime": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"sysidVisitor": 12345,
"coVisitorCount": 12345,
"sysidAltHost": 12345,
"sysidActionType": 12345,
"readOnlyActions": [
{
"aqActionTime": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"sysidActionType": 12345,
"sysidVisitorAction": 12345,
"sysidUserPerformer": 12345
},
{
"aqActionTime": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"sysidActionType": 12345,
"sysidVisitorAction": 12345,
"sysidUserPerformer": 12345
}
]
}
Show child attributes
Show child attributes
Example:
{
"sysidVisitor": 12345,
"country": "...",
"sysidLanguage": 12345,
"firstName": "...",
"active": true,
"lastName": "...",
"visitorImages": [
{
"displayOrder": 12345,
"imageSource": "...",
"height": 12345,
"thumbnailSource": "...",
"sysidVisitorImage": 12345,
"defaultImage": true,
"width": 12345
},
{
"displayOrder": 12345,
"imageSource": "...",
"height": 12345,
"thumbnailSource": "...",
"sysidVisitorImage": 12345,
"defaultImage": true,
"width": 12345
}
],
"company": "...",
"designation": "...",
"emailAddress": "...",
"phoneNumber": "...",
"address": "..."
}
Response
201 - application/json
CreateVisitorData created.
com.agilquest.phoenix.shared.data.visitor.VisitorData com.agilquest.phoenix.shared.data.visitor.VisitorArrival
Show child attributes
Show child attributes
Example:
{
"aqActualArrivalTime": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"sysidHost": 12345,
"sysidVisitType": 12345,
"sysidReservation": 12345,
"notes": "...",
"acknowledgements": [
{
"accepted": true,
"sysidConfigAcknowledgement": 12345,
"sysidVisitorAcknowledgement": 12345
},
{
"accepted": true,
"sysidConfigAcknowledgement": 12345,
"sysidVisitorAcknowledgement": 12345
}
],
"sysidVisitCreator": 12345,
"aqActualDepartureTime": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"sysidVenue": 12345,
"visitType": "SiteVisit",
"aqArrivalTime": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"sysidVisitorArrival": 12345,
"coVisitors": [
{
"visitorName": "...",
"sysidVisitorArrivalCoVisitor": 12345
},
{
"visitorName": "...",
"sysidVisitorArrivalCoVisitor": 12345
}
],
"aqDepartureTime": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"sysidVisitor": 12345,
"coVisitorCount": 12345,
"sysidAltHost": 12345,
"sysidActionType": 12345,
"readOnlyActions": [
{
"aqActionTime": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"sysidActionType": 12345,
"sysidVisitorAction": 12345,
"sysidUserPerformer": 12345
},
{
"aqActionTime": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"sysidActionType": 12345,
"sysidVisitorAction": 12345,
"sysidUserPerformer": 12345
}
]
}
Show child attributes
Show child attributes
Example:
{
"sysidVisitor": 12345,
"country": "...",
"sysidLanguage": 12345,
"firstName": "...",
"active": true,
"lastName": "...",
"visitorImages": [
{
"displayOrder": 12345,
"imageSource": "...",
"height": 12345,
"thumbnailSource": "...",
"sysidVisitorImage": 12345,
"defaultImage": true,
"width": 12345
},
{
"displayOrder": 12345,
"imageSource": "...",
"height": 12345,
"thumbnailSource": "...",
"sysidVisitorImage": 12345,
"defaultImage": true,
"width": 12345
}
],
"company": "...",
"designation": "...",
"emailAddress": "...",
"phoneNumber": "...",
"address": "..."
}