Post visitorssearchvisitors

Error

A valid request URL is required to generate request examples

{
  "views": [
    {
      "visitorLastName": "...",
      "company": "...",
      "hostLastName": "...",
      "printVisitorBadge": true,
      "sysidVisitType": 12345,
      "hostFirstName": "...",
      "sysidHost": 12345,
      "aqScheduledDeparture": {
        "discriminator": "AqDate",
        "hour": 12345,
        "tzIdValue": "...",
        "year": 12345,
        "month": 12345,
        "dayOfMonth": 12345,
        "minute": 12345,
        "noEndDate": true
      },
      "sysidVisitor": 12345,
      "venueName": "...",
      "phoneNumber": "...",
      "sysidArrival": 12345,
      "emailAddress": "...",
      "altHostLastName": "...",
      "altHostFirstName": "...",
      "visitorFirstName": "...",
      "images": [
        {
          "defaultImage": true,
          "width": 12345,
          "sysidVisitorImage": 12345,
          "height": 12345,
          "displayOrder": 12345,
          "imageSource": "...",
          "sysidVisitor": 12345,
          "thumbnailSource": "..."
        },
        {
          "defaultImage": true,
          "width": 12345,
          "sysidVisitorImage": 12345,
          "height": 12345,
          "displayOrder": 12345,
          "imageSource": "...",
          "sysidVisitor": 12345,
          "thumbnailSource": "..."
        }
      ],
      "aqScheduledArrival": {
        "discriminator": "AqDate",
        "hour": 12345,
        "tzIdValue": "...",
        "year": 12345,
        "month": 12345,
        "dayOfMonth": 12345,
        "minute": 12345,
        "noEndDate": true
      },
      "sysidAltHost": 12345,
      "aqArrivalTime": {
        "discriminator": "AqDate",
        "hour": 12345,
        "tzIdValue": "...",
        "year": 12345,
        "month": 12345,
        "dayOfMonth": 12345,
        "minute": 12345,
        "noEndDate": true
      },
      "sysidVenue": 12345,
      "sysidAction": 12345,
      "aqDepartureTime": {
        "discriminator": "AqDate",
        "hour": 12345,
        "tzIdValue": "...",
        "year": 12345,
        "month": 12345,
        "dayOfMonth": 12345,
        "minute": 12345,
        "noEndDate": true
      }
    },
    {
      "visitorLastName": "...",
      "company": "...",
      "hostLastName": "...",
      "printVisitorBadge": true,
      "sysidVisitType": 12345,
      "hostFirstName": "...",
      "sysidHost": 12345,
      "aqScheduledDeparture": {
        "discriminator": "AqDate",
        "hour": 12345,
        "tzIdValue": "...",
        "year": 12345,
        "month": 12345,
        "dayOfMonth": 12345,
        "minute": 12345,
        "noEndDate": true
      },
      "sysidVisitor": 12345,
      "venueName": "...",
      "phoneNumber": "...",
      "sysidArrival": 12345,
      "emailAddress": "...",
      "altHostLastName": "...",
      "altHostFirstName": "...",
      "visitorFirstName": "...",
      "images": [
        {
          "defaultImage": true,
          "width": 12345,
          "sysidVisitorImage": 12345,
          "height": 12345,
          "displayOrder": 12345,
          "imageSource": "...",
          "sysidVisitor": 12345,
          "thumbnailSource": "..."
        },
        {
          "defaultImage": true,
          "width": 12345,
          "sysidVisitorImage": 12345,
          "height": 12345,
          "displayOrder": 12345,
          "imageSource": "...",
          "sysidVisitor": 12345,
          "thumbnailSource": "..."
        }
      ],
      "aqScheduledArrival": {
        "discriminator": "AqDate",
        "hour": 12345,
        "tzIdValue": "...",
        "year": 12345,
        "month": 12345,
        "dayOfMonth": 12345,
        "minute": 12345,
        "noEndDate": true
      },
      "sysidAltHost": 12345,
      "aqArrivalTime": {
        "discriminator": "AqDate",
        "hour": 12345,
        "tzIdValue": "...",
        "year": 12345,
        "month": 12345,
        "dayOfMonth": 12345,
        "minute": 12345,
        "noEndDate": true
      },
      "sysidVenue": 12345,
      "sysidAction": 12345,
      "aqDepartureTime": {
        "discriminator": "AqDate",
        "hour": 12345,
        "tzIdValue": "...",
        "year": 12345,
        "month": 12345,
        "dayOfMonth": 12345,
        "minute": 12345,
        "noEndDate": true
      }
    }
  ],
  "hasAdditional": true,
  "nextStartRow": 12345
}

POST

visitors

Error

A valid request URL is required to generate request examples

{
  "views": [
    {
      "visitorLastName": "...",
      "company": "...",
      "hostLastName": "...",
      "printVisitorBadge": true,
      "sysidVisitType": 12345,
      "hostFirstName": "...",
      "sysidHost": 12345,
      "aqScheduledDeparture": {
        "discriminator": "AqDate",
        "hour": 12345,
        "tzIdValue": "...",
        "year": 12345,
        "month": 12345,
        "dayOfMonth": 12345,
        "minute": 12345,
        "noEndDate": true
      },
      "sysidVisitor": 12345,
      "venueName": "...",
      "phoneNumber": "...",
      "sysidArrival": 12345,
      "emailAddress": "...",
      "altHostLastName": "...",
      "altHostFirstName": "...",
      "visitorFirstName": "...",
      "images": [
        {
          "defaultImage": true,
          "width": 12345,
          "sysidVisitorImage": 12345,
          "height": 12345,
          "displayOrder": 12345,
          "imageSource": "...",
          "sysidVisitor": 12345,
          "thumbnailSource": "..."
        },
        {
          "defaultImage": true,
          "width": 12345,
          "sysidVisitorImage": 12345,
          "height": 12345,
          "displayOrder": 12345,
          "imageSource": "...",
          "sysidVisitor": 12345,
          "thumbnailSource": "..."
        }
      ],
      "aqScheduledArrival": {
        "discriminator": "AqDate",
        "hour": 12345,
        "tzIdValue": "...",
        "year": 12345,
        "month": 12345,
        "dayOfMonth": 12345,
        "minute": 12345,
        "noEndDate": true
      },
      "sysidAltHost": 12345,
      "aqArrivalTime": {
        "discriminator": "AqDate",
        "hour": 12345,
        "tzIdValue": "...",
        "year": 12345,
        "month": 12345,
        "dayOfMonth": 12345,
        "minute": 12345,
        "noEndDate": true
      },
      "sysidVenue": 12345,
      "sysidAction": 12345,
      "aqDepartureTime": {
        "discriminator": "AqDate",
        "hour": 12345,
        "tzIdValue": "...",
        "year": 12345,
        "month": 12345,
        "dayOfMonth": 12345,
        "minute": 12345,
        "noEndDate": true
      }
    },
    {
      "visitorLastName": "...",
      "company": "...",
      "hostLastName": "...",
      "printVisitorBadge": true,
      "sysidVisitType": 12345,
      "hostFirstName": "...",
      "sysidHost": 12345,
      "aqScheduledDeparture": {
        "discriminator": "AqDate",
        "hour": 12345,
        "tzIdValue": "...",
        "year": 12345,
        "month": 12345,
        "dayOfMonth": 12345,
        "minute": 12345,
        "noEndDate": true
      },
      "sysidVisitor": 12345,
      "venueName": "...",
      "phoneNumber": "...",
      "sysidArrival": 12345,
      "emailAddress": "...",
      "altHostLastName": "...",
      "altHostFirstName": "...",
      "visitorFirstName": "...",
      "images": [
        {
          "defaultImage": true,
          "width": 12345,
          "sysidVisitorImage": 12345,
          "height": 12345,
          "displayOrder": 12345,
          "imageSource": "...",
          "sysidVisitor": 12345,
          "thumbnailSource": "..."
        },
        {
          "defaultImage": true,
          "width": 12345,
          "sysidVisitorImage": 12345,
          "height": 12345,
          "displayOrder": 12345,
          "imageSource": "...",
          "sysidVisitor": 12345,
          "thumbnailSource": "..."
        }
      ],
      "aqScheduledArrival": {
        "discriminator": "AqDate",
        "hour": 12345,
        "tzIdValue": "...",
        "year": 12345,
        "month": 12345,
        "dayOfMonth": 12345,
        "minute": 12345,
        "noEndDate": true
      },
      "sysidAltHost": 12345,
      "aqArrivalTime": {
        "discriminator": "AqDate",
        "hour": 12345,
        "tzIdValue": "...",
        "year": 12345,
        "month": 12345,
        "dayOfMonth": 12345,
        "minute": 12345,
        "noEndDate": true
      },
      "sysidVenue": 12345,
      "sysidAction": 12345,
      "aqDepartureTime": {
        "discriminator": "AqDate",
        "hour": 12345,
        "tzIdValue": "...",
        "year": 12345,
        "month": 12345,
        "dayOfMonth": 12345,
        "minute": 12345,
        "noEndDate": true
      }
    }
  ],
  "hasAdditional": true,
  "nextStartRow": 12345
}

Body

application/json

VisitorViewCriteria to use for searching.

startRow

integer<int32>

required

maxRows

integer<int32>

required

sortAscending

boolean

required

phoneNumber

string

sysidVisitTypes

integer[]

includeActionTypes

integer[]

scheduledDateRange

DateRangeData · object

Show child attributes

Example:

{
  "startTime": {
    "discriminator": "AqDate",
    "hour": 12345,
    "tzIdValue": "...",
    "year": 12345,
    "month": 12345,
    "dayOfMonth": 12345,
    "minute": 12345,
    "noEndDate": true
  },
  "endTime": {
    "discriminator": "AqDate",
    "hour": 12345,
    "tzIdValue": "...",
    "year": 12345,
    "month": 12345,
    "dayOfMonth": 12345,
    "minute": 12345,
    "noEndDate": true
  }
}

visitorEmail

string

hostName

string

visitorName

string

sortColumn

enum<string>

Available options:

STATUS,

VISITOR_NAME,

HOST_NAME,

COMPANY,

VISIT_TYPE,

PHONE_NUMBER,

SCHEDULED_ARRIVAL,

SCHEDULED_DEPARTURE,

ACTUAL_ARRIVAL,

ACTUAL_DEPARTURE

sysidVenue

integer<int32>

company

string

Response

201 - application/json

Wrapper of VisitorView values.

com.agilquest.phoenix.shared.data.rest.wrapper.VisitorViewWrapper

hasAdditional

boolean

required

nextStartRow

integer<int32>

required

views

VisitorView · object[]

Show child attributes

Reserve REST API

Reserve Authentication API

Reserve Criteria

Reserve Constants

Body

Response