Skip to main content

Visitor

Overview

API methods for CRUD operations for Visitor Requests.

Methods

APIDescription
GET api/Visitor/GetAllVisitorRequestsReturns a list of VisitorViewModels that the API token has rights to view
GET api/Visitor/GetAllVisitorRequestsByFacilityId/{FacilityId}Returns a list of VisitorViewModels from a given Facility that the API token has rights to view
GET api/Visitor/GetAllVisitorRequestsByOccupancyId/{OccupancyId}Returns a list of VisitorViewModels from a given Facility that the API token has rights to view
GET api/Visitor/GetAllVisitorRequestsByHostId/{HostId}Returns a list of VisitorViewModels going to see a particular Host that the API token has rights to view
GET api/Visitor/GetVisitorRequestById/{VisitorRequestId}Returns a single VisitorRequestViewModel if the API token has rights to view it
POST api/Visitor/AddVisitorRequestAdds a single Visitor Request to the system. Returns Success/Error code plus primary key of Visitor Request added.
POST api/Visitor/UpdateVisitorRequestUpdates a single VisitorRequest that is already in the system. Returns Success/Error code.
POST api/Visitor/RemoveVisitorRequest/{VisitorRequestId}Deletes a single VisitorRequest that is already in the system. Returns Success/Error code
GET api/Visitor/GetAllVisitorTypesReturns a list of VisitorViewModels that the API token has rights to view