Error

A valid request URL is required to generate request examples

{
  "sysidVenue": 12345,
  "acknowledgements": [
    {
      "acknowledgeType": "EveryCheckIn",
      "sysidVenueVisitorConfigAcknowledgement": 12345,
      "aqDisplayTo": {
        "discriminator": "AqDate",
        "hour": 12345,
        "tzIdValue": "...",
        "year": 12345,
        "month": 12345,
        "dayOfMonth": 12345,
        "minute": 12345,
        "noEndDate": true
      },
      "sysidAcknowledgementType": 12345,
      "label": "...",
      "display": true,
      "languages": [
        {
          "plainText": "...",
          "sysidLanguage": 12345,
          "urlLink": "...",
          "urlText": "...",
          "sysidVenueVisitorConfigAcknowledgementText": 12345
        },
        {
          "plainText": "...",
          "sysidLanguage": 12345,
          "urlLink": "...",
          "urlText": "...",
          "sysidVenueVisitorConfigAcknowledgementText": 12345
        }
      ],
      "required": true,
      "aqDisplayFrom": {
        "discriminator": "AqDate",
        "hour": 12345,
        "tzIdValue": "...",
        "year": 12345,
        "month": 12345,
        "dayOfMonth": 12345,
        "minute": 12345,
        "noEndDate": true
      },
      "displayOrder": 12345
    },
    {
      "acknowledgeType": "EveryCheckIn",
      "sysidVenueVisitorConfigAcknowledgement": 12345,
      "aqDisplayTo": {
        "discriminator": "AqDate",
        "hour": 12345,
        "tzIdValue": "...",
        "year": 12345,
        "month": 12345,
        "dayOfMonth": 12345,
        "minute": 12345,
        "noEndDate": true
      },
      "sysidAcknowledgementType": 12345,
      "label": "...",
      "display": true,
      "languages": [
        {
          "plainText": "...",
          "sysidLanguage": 12345,
          "urlLink": "...",
          "urlText": "...",
          "sysidVenueVisitorConfigAcknowledgementText": 12345
        },
        {
          "plainText": "...",
          "sysidLanguage": 12345,
          "urlLink": "...",
          "urlText": "...",
          "sysidVenueVisitorConfigAcknowledgementText": 12345
        }
      ],
      "required": true,
      "aqDisplayFrom": {
        "discriminator": "AqDate",
        "hour": 12345,
        "tzIdValue": "...",
        "year": 12345,
        "month": 12345,
        "dayOfMonth": 12345,
        "minute": 12345,
        "noEndDate": true
      },
      "displayOrder": 12345
    }
  ],
  "sysidVenueVisitorConfig": 12345,
  "emailNotifications": true,
  "managers": [
    {
      "sysidVenueVisitorConfigManager": 12345,
      "sysidUser": 12345
    },
    {
      "sysidVenueVisitorConfigManager": 12345,
      "sysidUser": 12345
    }
  ],
  "selfCheckIn": true,
  "isPackageDeliveryIncluded": true,
  "meetingTypes": [
    {
      "badgeFields": [
        {
          "sysidVisitorBadgeField": 12345,
          "sysidFieldType": 12345
        },
        {
          "sysidVisitorBadgeField": 12345,
          "sysidFieldType": 12345
        }
      ],
      "required": true,
      "autoPrintBadge": true,
      "sysidVisitType": 12345,
      "closingTexts": [
        {
          "text": "...",
          "sysidVenueVisitorClosingMessage": 12345,
          "sysidLanguage": 12345
        },
        {
          "text": "...",
          "sysidVenueVisitorClosingMessage": 12345,
          "sysidLanguage": 12345
        }
      ],
      "actions": [
        {
          "sysidVisitorActionType": 12345,
          "sysidVenueVisitorConfigAction": 12345
        },
        {
          "sysidVisitorActionType": 12345,
          "sysidVenueVisitorConfigAction": 12345
        }
      ],
      "visitType": "Meeting",
      "sysidVenueVisitorConfigMeetingType": 12345,
      "hosts": [
        {
          "sysidAltHost": 12345,
          "sysidVenueVisitorConfigHost": 12345,
          "sysidHost": 12345
        },
        {
          "sysidAltHost": 12345,
          "sysidVenueVisitorConfigHost": 12345,
          "sysidHost": 12345
        }
      ]
    },
    {
      "badgeFields": [
        {
          "sysidVisitorBadgeField": 12345,
          "sysidFieldType": 12345
        },
        {
          "sysidVisitorBadgeField": 12345,
          "sysidFieldType": 12345
        }
      ],
      "required": true,
      "autoPrintBadge": true,
      "sysidVisitType": 12345,
      "closingTexts": [
        {
          "text": "...",
          "sysidVenueVisitorClosingMessage": 12345,
          "sysidLanguage": 12345
        },
        {
          "text": "...",
          "sysidVenueVisitorClosingMessage": 12345,
          "sysidLanguage": 12345
        }
      ],
      "actions": [
        {
          "sysidVisitorActionType": 12345,
          "sysidVenueVisitorConfigAction": 12345
        },
        {
          "sysidVisitorActionType": 12345,
          "sysidVenueVisitorConfigAction": 12345
        }
      ],
      "visitType": "ServiceProvider",
      "sysidVenueVisitorConfigMeetingType": 12345,
      "hosts": [
        {
          "sysidAltHost": 12345,
          "sysidVenueVisitorConfigHost": 12345,
          "sysidHost": 12345
        },
        {
          "sysidAltHost": 12345,
          "sysidVenueVisitorConfigHost": 12345,
          "sysidHost": 12345
        }
      ]
    }
  ],
  "enabled": true,
  "detailsFields": [
    {
      "notes": "...",
      "sysidVisitorDetailsField": 12345,
      "sysidFieldType": 12345,
      "required": true
    },
    {
      "notes": "...",
      "sysidVisitorDetailsField": 12345,
      "sysidFieldType": 12345,
      "required": true
    }
  ],
  "printVisitorBadge": true,
  "welcomeTexts": [
    {
      "sysidVenueVisitorWelcomeMessage": 12345,
      "sysidLanguage": 12345,
      "text": "..."
    },
    {
      "sysidVenueVisitorWelcomeMessage": 12345,
      "sysidLanguage": 12345,
      "text": "..."
    }
  ]
}

VisitorService

Get visitorsconfigby arrival

Gets the VenueVisitorConfig for the venue for the Visitor Arrival identified by the passed sysidVisitorArrival

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 Host of the visitor Requestor is a Super Host at the venue This operation returns a VenueVisitorConfig value representing the configuration.

The requesting User must have one of the following rights to perform this task:

This operation returns a VenueVisitorConfig value representing the configuration.

GET

visitors

config

by-arrival

{sysidVisitorArrival}

Error

A valid request URL is required to generate request examples

{
  "sysidVenue": 12345,
  "acknowledgements": [
    {
      "acknowledgeType": "EveryCheckIn",
      "sysidVenueVisitorConfigAcknowledgement": 12345,
      "aqDisplayTo": {
        "discriminator": "AqDate",
        "hour": 12345,
        "tzIdValue": "...",
        "year": 12345,
        "month": 12345,
        "dayOfMonth": 12345,
        "minute": 12345,
        "noEndDate": true
      },
      "sysidAcknowledgementType": 12345,
      "label": "...",
      "display": true,
      "languages": [
        {
          "plainText": "...",
          "sysidLanguage": 12345,
          "urlLink": "...",
          "urlText": "...",
          "sysidVenueVisitorConfigAcknowledgementText": 12345
        },
        {
          "plainText": "...",
          "sysidLanguage": 12345,
          "urlLink": "...",
          "urlText": "...",
          "sysidVenueVisitorConfigAcknowledgementText": 12345
        }
      ],
      "required": true,
      "aqDisplayFrom": {
        "discriminator": "AqDate",
        "hour": 12345,
        "tzIdValue": "...",
        "year": 12345,
        "month": 12345,
        "dayOfMonth": 12345,
        "minute": 12345,
        "noEndDate": true
      },
      "displayOrder": 12345
    },
    {
      "acknowledgeType": "EveryCheckIn",
      "sysidVenueVisitorConfigAcknowledgement": 12345,
      "aqDisplayTo": {
        "discriminator": "AqDate",
        "hour": 12345,
        "tzIdValue": "...",
        "year": 12345,
        "month": 12345,
        "dayOfMonth": 12345,
        "minute": 12345,
        "noEndDate": true
      },
      "sysidAcknowledgementType": 12345,
      "label": "...",
      "display": true,
      "languages": [
        {
          "plainText": "...",
          "sysidLanguage": 12345,
          "urlLink": "...",
          "urlText": "...",
          "sysidVenueVisitorConfigAcknowledgementText": 12345
        },
        {
          "plainText": "...",
          "sysidLanguage": 12345,
          "urlLink": "...",
          "urlText": "...",
          "sysidVenueVisitorConfigAcknowledgementText": 12345
        }
      ],
      "required": true,
      "aqDisplayFrom": {
        "discriminator": "AqDate",
        "hour": 12345,
        "tzIdValue": "...",
        "year": 12345,
        "month": 12345,
        "dayOfMonth": 12345,
        "minute": 12345,
        "noEndDate": true
      },
      "displayOrder": 12345
    }
  ],
  "sysidVenueVisitorConfig": 12345,
  "emailNotifications": true,
  "managers": [
    {
      "sysidVenueVisitorConfigManager": 12345,
      "sysidUser": 12345
    },
    {
      "sysidVenueVisitorConfigManager": 12345,
      "sysidUser": 12345
    }
  ],
  "selfCheckIn": true,
  "isPackageDeliveryIncluded": true,
  "meetingTypes": [
    {
      "badgeFields": [
        {
          "sysidVisitorBadgeField": 12345,
          "sysidFieldType": 12345
        },
        {
          "sysidVisitorBadgeField": 12345,
          "sysidFieldType": 12345
        }
      ],
      "required": true,
      "autoPrintBadge": true,
      "sysidVisitType": 12345,
      "closingTexts": [
        {
          "text": "...",
          "sysidVenueVisitorClosingMessage": 12345,
          "sysidLanguage": 12345
        },
        {
          "text": "...",
          "sysidVenueVisitorClosingMessage": 12345,
          "sysidLanguage": 12345
        }
      ],
      "actions": [
        {
          "sysidVisitorActionType": 12345,
          "sysidVenueVisitorConfigAction": 12345
        },
        {
          "sysidVisitorActionType": 12345,
          "sysidVenueVisitorConfigAction": 12345
        }
      ],
      "visitType": "Meeting",
      "sysidVenueVisitorConfigMeetingType": 12345,
      "hosts": [
        {
          "sysidAltHost": 12345,
          "sysidVenueVisitorConfigHost": 12345,
          "sysidHost": 12345
        },
        {
          "sysidAltHost": 12345,
          "sysidVenueVisitorConfigHost": 12345,
          "sysidHost": 12345
        }
      ]
    },
    {
      "badgeFields": [
        {
          "sysidVisitorBadgeField": 12345,
          "sysidFieldType": 12345
        },
        {
          "sysidVisitorBadgeField": 12345,
          "sysidFieldType": 12345
        }
      ],
      "required": true,
      "autoPrintBadge": true,
      "sysidVisitType": 12345,
      "closingTexts": [
        {
          "text": "...",
          "sysidVenueVisitorClosingMessage": 12345,
          "sysidLanguage": 12345
        },
        {
          "text": "...",
          "sysidVenueVisitorClosingMessage": 12345,
          "sysidLanguage": 12345
        }
      ],
      "actions": [
        {
          "sysidVisitorActionType": 12345,
          "sysidVenueVisitorConfigAction": 12345
        },
        {
          "sysidVisitorActionType": 12345,
          "sysidVenueVisitorConfigAction": 12345
        }
      ],
      "visitType": "ServiceProvider",
      "sysidVenueVisitorConfigMeetingType": 12345,
      "hosts": [
        {
          "sysidAltHost": 12345,
          "sysidVenueVisitorConfigHost": 12345,
          "sysidHost": 12345
        },
        {
          "sysidAltHost": 12345,
          "sysidVenueVisitorConfigHost": 12345,
          "sysidHost": 12345
        }
      ]
    }
  ],
  "enabled": true,
  "detailsFields": [
    {
      "notes": "...",
      "sysidVisitorDetailsField": 12345,
      "sysidFieldType": 12345,
      "required": true
    },
    {
      "notes": "...",
      "sysidVisitorDetailsField": 12345,
      "sysidFieldType": 12345,
      "required": true
    }
  ],
  "printVisitorBadge": true,
  "welcomeTexts": [
    {
      "sysidVenueVisitorWelcomeMessage": 12345,
      "sysidLanguage": 12345,
      "text": "..."
    },
    {
      "sysidVenueVisitorWelcomeMessage": 12345,
      "sysidLanguage": 12345,
      "text": "..."
    }
  ]
}

Path Parameters

sysidVisitorArrival

integer<int32>

required

: Integer ID of the Visitor Arrival used to idntify the VisitorConfig to retrieve

Response

200 - application/json

VenueVisitorConfig data value updated.

com.agilquest.phoenix.shared.data.visitor.VenueVisitorConfig

sysidVenue

integer<int32>

required

emailNotifications

boolean

required

selfCheckIn

boolean

required

isPackageDeliveryIncluded

boolean

required

enabled

boolean

required

printVisitorBadge

boolean

required

acknowledgements

VenueVisitorConfigAcknowledgement · object[]

Show child attributes

sysidVenueVisitorConfig

integer<int32>

managers

VenueVisitorConfigManager · object[]

Show child attributes

meetingTypes

VenueVisitorConfigMeetingType · object[]

Show child attributes

detailsFields

VisitorDetailsField · object[]

Show child attributes

welcomeTexts

VenueVisitorWelcomeMessage · object[]

Show child attributes

Reserve REST API

Reserve Authentication API

Reserve Criteria

Reserve Constants

Get visitorsconfigby arrival

Path Parameters

Response