Docy

Visit uses the appropriate HTTP verbs to denote the associated action. For each endpoint in this documentation, the supported verbs are listed. Where write/update/delete operations are not supported, this action can only be performed in Visit Create’s online interface.

GET

Read-only operation to return a resource. A successful GET response will return the requested data, with an HTTP 200 status code. Most VISIT endpoints support GET operations as a minimum.

POST

Creates a new resource through the API. A POST request corresponds to a database ‘create’ operation. When working with the JSON API, the URL will contain the event ID that the resource is to be generated under. For a successful POST, the API key in use must have access to the specified event, and the JSON body content must contain the minimum mandatory fields for creation of the new item.

PUT

Updates an existing resource through the API. A PUT request corresponds to a database ‘update’ operation. When working with the JSON API, it will be required to specify the unique ID of the existing resource to be updated. The JSON body content needs to contain only the fields to be updated. Fields not supplied in the request will retain their existing values.

DELETE

Where supported, the DELETE command corresponds to a database ‘delete’ operation. The requested URL will contain the ID of the resource to be removed.

CONTENTS