{ "swagger": "2.0", "info": { "version": "v1", "title": "WaiverFile API" }, "host": "api.waiverfile.com", "schemes": [ "https" ], "paths": { "/api/v1/GetSubscribersByDate": { "get": { "tags": [ "SMS" ], "summary": "Get a list of SMS subscribers by opt-in date. Dates should be in UTC.", "operationId": "SMS_GetSubscribersByDate", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "apiKey", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "siteID", "in": "query", "description": "", "required": true, "type": "string", "format": "uuid" }, { "name": "startDateUTC", "in": "query", "description": "", "required": true, "type": "string", "format": "date-time" }, { "name": "endDateUTC", "in": "query", "description": "", "required": true, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/GetOptedOutSubscribersByOptOutDate": { "get": { "tags": [ "SMS" ], "summary": "Get a list of SMS subscribers who have opted out by opt-out date. Run this on intervals to monitor for any subscribers that have opted out. Dates should be in UTC.", "operationId": "SMS_GetOptedOutSubscribersByOptOutDate", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "apiKey", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "siteID", "in": "query", "description": "", "required": true, "type": "string", "format": "uuid" }, { "name": "startDateUTC", "in": "query", "description": "", "required": true, "type": "string", "format": "date-time" }, { "name": "endDateUTC", "in": "query", "description": "", "required": true, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/subscribe/newwaiver": { "post": { "tags": [ "Subscription" ], "summary": "Subscribe to the New Waiver trigger", "operationId": "Subscription_newwaiver", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "targetUrl", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "apiKey", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "siteID", "in": "query", "description": "", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/deletesubscribe/newwaiver": { "delete": { "tags": [ "Subscription" ], "summary": "Delete subscription to New Waiver trigger", "operationId": "Subscription_deletenewwaiver", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/subscribe/newevent": { "post": { "tags": [ "Subscription" ], "summary": "Subscribe to the New Event trigger", "operationId": "Subscription_newevent", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "targetUrl", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "apiKey", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "siteID", "in": "query", "description": "", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/deletesubscribe/newevent": { "delete": { "tags": [ "Subscription" ], "summary": "Delete subscription to New Event trigger", "operationId": "Subscription_deletenewevent", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/subscribe/newcheckin": { "post": { "tags": [ "Subscription" ], "summary": "Subscribe to the New Checkin trigger", "operationId": "Subscription_newcheckin", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "targetUrl", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "apiKey", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "siteID", "in": "query", "description": "", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/deletesubscribe/newcheckin": { "delete": { "tags": [ "Subscription" ], "summary": "Delete subscription to New Checkin trigger", "operationId": "Subscription_deletenewcheckin", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/subscribe/newqrscan": { "post": { "tags": [ "Subscription" ], "summary": "Subscribe to the New Successful QR Scan trigger", "operationId": "Subscription_newqrscan", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "targetUrl", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "apiKey", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "siteID", "in": "query", "description": "", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/deletesubscribe/newqrscan": { "delete": { "tags": [ "Subscription" ], "summary": "Delete subscription to the New Successful QR Scan trigger", "operationId": "Subscription_newqrscan", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/subscribe/editwaiver": { "post": { "tags": [ "Subscription" ], "summary": "Subscribe to the Edit Waiver trigger", "operationId": "Subscription_editwaiver", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "targetUrl", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "apiKey", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "siteID", "in": "query", "description": "", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/deletesubscribe/editwaiver": { "delete": { "tags": [ "Subscription" ], "summary": "Delete subscription to New Waiver trigger", "operationId": "Subscription_deleteeditwaiver", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/subscribe/editevent": { "post": { "tags": [ "Subscription" ], "summary": "Subscribe to the Edit Event trigger", "operationId": "Subscription_editevent", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "targetUrl", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "apiKey", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "siteID", "in": "query", "description": "", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/deletesubscribe/editevent": { "delete": { "tags": [ "Subscription" ], "summary": "Delete subscription to New Event trigger", "operationId": "Subscription_deleteeditevent", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/subscribe/editcheckin": { "post": { "tags": [ "Subscription" ], "summary": "Subscribe to the Edit Checkin trigger", "operationId": "Subscription_editcheckin", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "targetUrl", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "apiKey", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "siteID", "in": "query", "description": "", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/deletesubscribe/editcheckin": { "delete": { "tags": [ "Subscription" ], "summary": "Delete subscription to Edit Checkin trigger", "operationId": "Subscription_deleteeditcheckin", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/sampledata/newwaiver": { "get": { "tags": [ "Subscription" ], "summary": "Get a sample set of recent waiver data.", "operationId": "Subscription_samplenewwaivers", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "apiKey", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "siteID", "in": "query", "description": "", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/sampledata/editwaiver": { "get": { "tags": [ "Subscription" ], "summary": "Get a sample set of recent waiver data.", "operationId": "Subscription_sampleeditwaiver", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "apiKey", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "siteID", "in": "query", "description": "", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/sampledata/newevent": { "get": { "tags": [ "Subscription" ], "summary": "Get a sample set of recent waiver data.", "operationId": "Subscription_samplenewevent", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "apiKey", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "siteID", "in": "query", "description": "", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/sampledata/newcheckin": { "get": { "tags": [ "Subscription" ], "summary": "Get a sample set of recent waiver data.", "operationId": "Subscription_samplenewcheckin", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "apiKey", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "siteID", "in": "query", "description": "", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/GetEventsByDateRange": { "get": { "tags": [ "WaiverEvent" ], "summary": "Get a list of events by date range. Dates should be in UTC.", "operationId": "WaiverEvent_GetEventsByDateRange", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "apiKey", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "siteID", "in": "query", "description": "", "required": true, "type": "string", "format": "uuid" }, { "name": "startDateUTC", "in": "query", "description": "", "required": true, "type": "string", "format": "date-time" }, { "name": "endDateUTC", "in": "query", "description": "", "required": true, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/GetEventsByCategory": { "get": { "tags": [ "WaiverEvent" ], "summary": "Returns a list of events filtered by event category ID and date.", "operationId": "WaiverEvent_GetEventsByCategory", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "apiKey", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "siteID", "in": "query", "description": "", "required": true, "type": "string", "format": "uuid" }, { "name": "eventCategoryID", "in": "query", "description": "", "required": true, "type": "string", "format": "uuid" }, { "name": "startDateUTC", "in": "query", "description": "", "required": true, "type": "string", "format": "date-time" }, { "name": "endDateUTC", "in": "query", "description": "", "required": true, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/GetUpcomingEvents": { "get": { "tags": [ "WaiverEvent" ], "summary": "Get a list of upcoming events", "operationId": "WaiverEvent_GetUpcomingEvents", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "apiKey", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "siteID", "in": "query", "description": "", "required": true, "type": "string", "format": "uuid" }, { "name": "startDateUTC", "in": "query", "description": "", "required": true, "type": "string", "format": "date-time" }, { "name": "endDateUTC", "in": "query", "description": "", "required": true, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/GetWaiversForEvent": { "get": { "tags": [ "WaiverEvent" ], "summary": "Get waivers collected for event", "operationId": "WaiverEvent_GetWaiversForEvent", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "apiKey", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "siteID", "in": "query", "description": "", "required": true, "type": "string", "format": "uuid" }, { "name": "waiverEventID", "in": "query", "description": "", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/GetEventCategories": { "get": { "tags": [ "WaiverEvent" ], "summary": "Returns a list of available event categories.", "operationId": "WaiverEvent_GetEventCategories", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "apiKey", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "siteID", "in": "query", "description": "", "required": true, "type": "string", "format": "uuid" }, { "name": "includeDisabledCategories", "in": "query", "description": "When true, includes categories with a status of disabled.", "required": true, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/EvtPing": { "post": { "tags": [ "WaiverEvent" ], "summary": "Ping test", "operationId": "WaiverEvent_EvtPing", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "val", "in": "body", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/InsertEvent": { "post": { "tags": [ "WaiverEvent" ], "summary": "Inserts new event", "operationId": "WaiverEvent_InsertEvent", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "eventPack", "in": "body", "description": "Data pack", "required": true, "schema": { "$ref": "#/definitions/CreateEventPack" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/RemoveEventManagers": { "post": { "tags": [ "WaiverEvent" ], "summary": "Removes access to specified event for the email addrsses listed.", "operationId": "WaiverEvent_RemoveEventManagers", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "apiKey", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "siteID", "in": "query", "description": "", "required": true, "type": "string", "format": "uuid" }, { "name": "eventID", "in": "query", "description": "", "required": true, "type": "string", "format": "uuid" }, { "name": "emailAddresses", "in": "query", "description": "List of email addresses separated by commas or line breaks. Each person will have their manager access revoked for specified event.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/InviteEventManagers": { "post": { "tags": [ "WaiverEvent" ], "summary": "Invite new event managers to an event. Event manages can log in and view a list of signees and participants. Visible fields can be configured in account settings.", "operationId": "WaiverEvent_InviteEventManagers", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "apiKey", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "siteID", "in": "query", "description": "", "required": true, "type": "string", "format": "uuid" }, { "name": "eventID", "in": "query", "description": "", "required": true, "type": "string", "format": "uuid" }, { "name": "emailAddresses", "in": "query", "description": "List of email addresses separated by commas or line breaks. Each person will be invited to be an event manager.", "required": true, "type": "string" }, { "name": "managerEmailMessage", "in": "query", "description": "Message to be added in the body of the invitation email. Optional.", "required": true, "type": "string" }, { "name": "skipSendingEmailIfAccountExists", "in": "query", "description": "If true, skips sending the email invitation if the account already exists.", "required": true, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/UpdateEvent": { "post": { "tags": [ "WaiverEvent" ], "summary": "Update an existing event", "operationId": "WaiverEvent_UpdateEvent", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "apiKey", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "siteID", "in": "query", "description": "", "required": true, "type": "string", "format": "uuid" }, { "name": "eventID", "in": "query", "description": "", "required": true, "type": "string", "format": "uuid" }, { "name": "eventName", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "dateStart", "in": "query", "description": "", "required": true, "type": "string", "format": "date-time" }, { "name": "dateEnd", "in": "query", "description": "", "required": true, "type": "string", "format": "date-time" }, { "name": "isAllDay", "in": "query", "description": "Set to true for an all-day event (no time specified)", "required": true, "type": "boolean" }, { "name": "eventCategoryID", "in": "query", "description": "The ID of the event category. To set no category, use an empty Guid (00000000-0000-0000-0000-000000000000)", "required": true, "type": "string", "format": "uuid" }, { "name": "waiverFormIDs", "in": "body", "description": "List of Waiver Form ID's for this event. Leave empty to attach all active forms.", "required": true, "schema": { "type": "array", "items": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/InsertOrUpdateEvent": { "post": { "tags": [ "WaiverEvent" ], "summary": "Insert or Update a Waiver Event", "operationId": "WaiverEvent_InsertOrUpdateEvent", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "apiKey", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "siteID", "in": "query", "description": "", "required": true, "type": "string", "format": "uuid" }, { "name": "newEvent", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/WaiverEvent" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "deprecated": true } }, "/api/v1/CreateEvent": { "get": { "tags": [ "WaiverEvent" ], "summary": "", "operationId": "WaiverEvent_CreateEvent", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "apiKey", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "siteID", "in": "query", "description": "", "required": true, "type": "string", "format": "uuid" }, { "name": "eventName", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "dateStart", "in": "query", "description": "", "required": true, "type": "string", "format": "date-time" }, { "name": "dateEnd", "in": "query", "description": "", "required": true, "type": "string", "format": "date-time" }, { "name": "waiverFormIDs", "in": "query", "description": "List of ID's of waiver forms that should be set up. Leave blank and all forms will be enabled.", "required": true, "type": "array", "items": { "type": "string", "format": "uuid" }, "collectionFormat": "multi" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "deprecated": true } }, "/api/v1/DeleteEvent": { "get": { "tags": [ "WaiverEvent" ], "summary": "Delete an event", "operationId": "WaiverEvent_DeleteEvent", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "apiKey", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "siteID", "in": "query", "description": "", "required": true, "type": "string", "format": "uuid" }, { "name": "eventID", "in": "query", "description": "", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/InsertEventCategory": { "post": { "tags": [ "WaiverEvent" ], "summary": "Insert new event category", "operationId": "WaiverEvent_InsertEventCategory", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "apiKey", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "siteID", "in": "query", "description": "", "required": true, "type": "string", "format": "uuid" }, { "name": "name", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "active", "in": "query", "description": "When true, creates the category with an active status. Otherwise status wil be set to disabled.", "required": true, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/UpdateEventCategory": { "post": { "tags": [ "WaiverEvent" ], "summary": "Updates an existing event category ID", "operationId": "WaiverEvent_UpdateEventCategory", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "apiKey", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "siteID", "in": "query", "description": "", "required": true, "type": "string", "format": "uuid" }, { "name": "eventCategoryID", "in": "query", "description": "", "required": true, "type": "string", "format": "uuid" }, { "name": "name", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "active", "in": "query", "description": "", "required": true, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/DeleteEventCategory": { "post": { "tags": [ "WaiverEvent" ], "summary": "Deletes the event category", "operationId": "WaiverEvent_DeleteEventCategory", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "apiKey", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "siteID", "in": "query", "description": "", "required": true, "type": "string", "format": "uuid" }, { "name": "eventCategoryID", "in": "query", "description": "", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/Ping": { "get": { "tags": [ "WaiverFile" ], "summary": "Check that the service is live.", "operationId": "WaiverFile_Ping", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "apiKey", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "siteID", "in": "query", "description": "", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/GetSiteDetails": { "get": { "tags": [ "WaiverFile" ], "summary": "Get your WaiverSite details", "operationId": "WaiverFile_GetSiteDetails", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "apiKey", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "siteID", "in": "query", "description": "", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/GetWaiverPDF": { "get": { "tags": [ "WaiverFile" ], "summary": "Get an individual waiver as a PDF", "operationId": "WaiverFile_GetWaiverPDF", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "apiKey", "in": "query", "required": true, "type": "string" }, { "name": "siteID", "in": "query", "required": true, "type": "string", "format": "uuid" }, { "name": "waiverID", "in": "query", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/GetWaiver": { "get": { "tags": [ "WaiverFile" ], "summary": "Get an individual waiver", "operationId": "WaiverFile_GetWaiver", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "apiKey", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "siteID", "in": "query", "description": "", "required": true, "type": "string", "format": "uuid" }, { "name": "waiverID", "in": "query", "description": "", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/GetWaiverLite": { "get": { "tags": [ "WaiverFile" ], "summary": "Get an individual waiver with only the collected form data, no waiver agreement text or event info included.", "operationId": "WaiverFile_GetWaiverLite", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "apiKey", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "siteID", "in": "query", "description": "", "required": true, "type": "string", "format": "uuid" }, { "name": "waiverID", "in": "query", "description": "", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/SearchWaivers": { "get": { "tags": [ "WaiverFile" ], "summary": "Search Waivers", "operationId": "WaiverFile_SearchWaivers", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "apiKey", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "siteID", "in": "query", "description": "", "required": true, "type": "string", "format": "uuid" }, { "name": "terms", "in": "query", "description": "", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/GetWaiversByReferenceID": { "get": { "tags": [ "WaiverFile" ], "summary": "Returns a list of waivers based on the specified reference ID's. Pass in specific reference ID's or a value to refIDAny which will check all 3 fields.", "operationId": "WaiverFile_GetWaiversByReferenceID", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "apiKey", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "siteID", "in": "query", "description": "", "required": true, "type": "string", "format": "uuid" }, { "name": "refID1", "in": "query", "description": "Checks the Reference ID 1 Field", "required": false, "type": "string" }, { "name": "refID2", "in": "query", "description": "Checks the Reference ID 2 Field", "required": false, "type": "string" }, { "name": "refID3", "in": "query", "description": "Checks the Reference ID 3 Field", "required": false, "type": "string" }, { "name": "refIDAny", "in": "query", "description": "Checks all reference ID fields. Any matches returned.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/GetAllWaiversByDateRangePageCount": { "get": { "tags": [ "WaiverFile" ], "summary": "Get the number of waivers in the specified date range. Use this to determine the number of pages of data to be returned.", "operationId": "WaiverFile_GetWaiversByDateRangeRecordCount", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "apiKey", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "siteID", "in": "query", "description": "", "required": true, "type": "string", "format": "uuid" }, { "name": "startDate", "in": "query", "description": "", "required": true, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "", "required": true, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/GetWaiverData": { "get": { "tags": [ "WaiverFile" ], "summary": "GetWaiverData. Returns a page of waiver data.", "operationId": "WaiverFile_GetWaiverData", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "apiKey", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "siteID", "in": "query", "description": "", "required": true, "type": "string", "format": "uuid" }, { "name": "startDate", "in": "query", "description": "", "required": true, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "", "required": true, "type": "string", "format": "date-time" }, { "name": "includeCustomColumns", "in": "query", "description": "When true, includes custom form fields from all waiver forms. Otherwise only standard fields are included.", "required": true, "type": "boolean" }, { "name": "consolidateParticipants", "in": "query", "description": "When true, returns distinct waiver records with a list of participant names in a single column, separated by commas. Additional participant information not included. For full participant information, use false.", "required": true, "type": "boolean" }, { "name": "pageIndex", "in": "query", "description": "", "required": true, "type": "integer", "format": "int32" }, { "name": "pageSize", "in": "query", "description": "Maximum 500", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/GetWaiverDataCount": { "get": { "tags": [ "WaiverFile" ], "summary": "GetWaiverDataCount. Returns the count of records to expect when preparing to use GetWaiverData()", "operationId": "WaiverFile_GetWaiverDataCount", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "apiKey", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "siteID", "in": "query", "description": "", "required": true, "type": "string", "format": "uuid" }, { "name": "startDate", "in": "query", "description": "", "required": true, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "", "required": true, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/GetAllWaiversByDateRange": { "get": { "tags": [ "WaiverFile" ], "summary": "GetAllWaiversByDateRange. Returns a page of waiver data.", "operationId": "WaiverFile_GetAllWaiversByDateRange", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "apiKey", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "siteID", "in": "query", "description": "", "required": true, "type": "string", "format": "uuid" }, { "name": "startDate", "in": "query", "description": "", "required": true, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "", "required": true, "type": "string", "format": "date-time" }, { "name": "pageIndex", "in": "query", "description": "", "required": true, "type": "integer", "format": "int32" }, { "name": "pageSize", "in": "query", "description": "Maximum 500", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/GetAllWaiversByDateRangeLite": { "get": { "tags": [ "WaiverFile" ], "summary": "GetAllWaiversByDateRangeLite. Returns a page of waiver data. Only the collected form data, no waiver agreement text or event info included.", "operationId": "WaiverFile_GetAllWaiversByDateRangeLite", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "apiKey", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "siteID", "in": "query", "description": "", "required": true, "type": "string", "format": "uuid" }, { "name": "startDate", "in": "query", "description": "", "required": true, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "", "required": true, "type": "string", "format": "date-time" }, { "name": "pageIndex", "in": "query", "description": "", "required": true, "type": "integer", "format": "int32" }, { "name": "pageSize", "in": "query", "description": "Maximum 500", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/GetActiveWaiverForms": { "get": { "tags": [ "WaiverFile" ], "summary": "Get Active Waiver Forms", "operationId": "WaiverFile_GetActiveWaiverForms", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "apiKey", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "siteID", "in": "query", "description": "", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/GetAllWaiverForms": { "get": { "tags": [ "WaiverFile" ], "summary": "Get All Waiver Forms including deleted", "operationId": "WaiverFile_GetAllWaiverForms", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "apiKey", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "siteID", "in": "query", "description": "", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } } }, "definitions": { "CreateEventPack": { "description": "Package of details", "type": "object", "properties": { "EventName": { "description": "", "type": "string" }, "DateStart": { "format": "date-time", "description": "", "type": "string" }, "DateEnd": { "format": "date-time", "description": "", "type": "string" }, "IsAllDay": { "description": "Set to true for an all-day event (no time specified)", "type": "boolean" }, "EventCategoryID": { "format": "uuid", "description": "The ID of the event category. Optional.", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "ManagerEmailList": { "description": "List of email addresses separated by commas. Each will receive an email invite to access the event manager screen and see a list of signees and participants.", "type": "string" }, "ManagerEmailMessage": { "description": "Text that will be inserted in the body of the email message to each event manager.", "type": "string" }, "WaiverFormIDList": { "description": "List of Waiver Form ID's for this event. Leave empty to attach all active forms.", "type": "string" }, "EventLocation": { "description": "Event Location. Optional.", "type": "string" }, "SigningCutoff": { "format": "date-time", "description": "Cutoff date. Optional.", "type": "string" }, "MaxParticipants": { "format": "int32", "description": "Maximum allowed participants", "type": "integer" }, "WorkflowIDList": { "description": "List of Waiver Form ID's for this event. Leave empty to attach all active forms.", "type": "string" }, "APIKey": { "description": "API Key", "type": "string" }, "SiteID": { "format": "uuid", "description": "Site ID", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "WaiverEvent": { "type": "object", "properties": { "_WPObjectStatus": { "format": "int32", "enum": [ 0, 1, 2, 3 ], "type": "integer" }, "_waivers": { "type": "array", "items": { "$ref": "#/definitions/Waiver" } }, "_waiverForms": { "type": "array", "items": { "$ref": "#/definitions/WaiverForm" } }, "_managerIDs": { "type": "array", "items": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } }, "_extraParticipants": { "type": "array", "items": { "$ref": "#/definitions/WaiverParticipantEvent" } }, "_numSignedWaivers": { "format": "int32", "type": "integer" }, "k__BackingField": { "$ref": "#/definitions/WaiverEventCategory" }, "_timesAdjustedForLocalRendering": { "type": "boolean" }, "me": { "$ref": "#/definitions/SWaiverEvent" }, "_workflowIDs": { "type": "array", "items": { "$ref": "#/definitions/WaiverEventWorkflowBase" } }, "_waiverEventFormIDs": { "type": "array", "items": { "$ref": "#/definitions/WaiverEventFormBase" } }, "k__BackingField": { "$ref": "#/definitions/WaiverEventSettings" }, "_timeLabel": { "type": "string" }, "_timeLabelLine1": { "type": "string" }, "_timeLabelLine2": { "type": "string" } } }, "Waiver": { "type": "object", "properties": { "_WPObjectStatus": { "format": "int32", "enum": [ 0, 1, 2, 3 ], "type": "integer" }, "_participants": { "type": "array", "items": { "$ref": "#/definitions/WaiverParticipant" } }, "k__BackingField": { "$ref": "#/definitions/WaiverEmailVerify" }, "_images": { "type": "array", "items": { "$ref": "#/definitions/WaiverImage" } }, "_attachments": { "type": "array", "items": { "$ref": "#/definitions/WaiverAttachment" } }, "_waiverEvent": { "$ref": "#/definitions/WaiverEvent" }, "_waiverFormInstance": { "$ref": "#/definitions/WaiverFormInstance" }, "_waiverForm": { "$ref": "#/definitions/WaiverForm" }, "_device": { "$ref": "#/definitions/WFAPIDevice" }, "k__BackingField": { "$ref": "#/definitions/WaiverOriginalData" }, "_signatures": { "type": "array", "items": { "$ref": "#/definitions/WFSignature2" } }, "k__BackingField": { "type": "string" }, "k__BackingField": { "type": "boolean" }, "k__BackingField": { "type": "boolean" }, "fieldsDoc": { "type": "array", "items": { "type": "object" } }, "_wpe_list": { "type": "array", "items": { "$ref": "#/definitions/WaiverParticipantEvent" } }, "k__BackingField": { "type": "string" }, "me": { "$ref": "#/definitions/SWaiver" }, "_timesAdjustedForLocalRendering": { "type": "boolean" }, "k__BackingField": { "type": "boolean" }, "k__BackingField": { "type": "boolean" }, "valsDoc": { "$ref": "#/definitions/XDocument" } } }, "WaiverForm": { "type": "object", "properties": { "_WPObjectStatus": { "format": "int32", "enum": [ 0, 1, 2, 3 ], "type": "integer" }, "_currentInstance": { "$ref": "#/definitions/WaiverFormInstance" }, "k__BackingField": { "$ref": "#/definitions/WorkflowStepForm" }, "me": { "$ref": "#/definitions/SWaiverForm" } } }, "WaiverParticipantEvent": { "type": "object", "properties": { "me": { "$ref": "#/definitions/SWaiverParticipantEvent" }, "_WPObjectStatus": { "format": "int32", "enum": [ 0, 1, 2, 3 ], "type": "integer" }, "_participant": { "$ref": "#/definitions/WaiverParticipant" }, "k__BackingField": { "type": "boolean" }, "_signedByName": { "type": "string" }, "_signedByNameFirst": { "type": "string" } } }, "WaiverEventCategory": { "type": "object", "properties": { "_WPObjectStatus": { "format": "int32", "enum": [ 0, 1, 2, 3 ], "type": "integer" }, "me": { "$ref": "#/definitions/SWaiverEventCategory" } } }, "SWaiverEvent": { "type": "object", "properties": { "waiverEventID": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "siteID": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "name": { "type": "string" }, "dateStart": { "format": "date-time", "type": "string" }, "dateEnd": { "format": "date-time", "type": "string" }, "isDeleted": { "type": "boolean" }, "lastModified": { "format": "date-time", "type": "string" }, "created": { "format": "date-time", "type": "string" }, "isAllDay": { "type": "boolean" }, "waiverEventRecurringID": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "categoryID": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "numWaiverForms": { "format": "int32", "type": "integer" }, "maxParts": { "format": "int32", "type": "integer" }, "headcount": { "format": "int32", "type": "integer" }, "spotsRemaining": { "format": "int32", "type": "integer" }, "settingsXml": { "type": "string" }, "managerEmailList": { "type": "string" } } }, "WaiverEventWorkflowBase": { "type": "object", "properties": { "WaiverEventID": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "WorkflowID": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "WaiverEventFormBase": { "type": "object", "properties": { "WaiverEventID": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "WaiverFormID": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "WaiverEventSettings": { "type": "object", "properties": { "MaxParticipants": { "format": "int32", "type": "integer" }, "Location": { "type": "string" }, "SigningCutoff": { "format": "date-time", "type": "string" }, "Description": { "type": "string" } } }, "WaiverParticipant": { "type": "object", "properties": { "WaiverParticipantID": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "WaiverID": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "ParticipantName": { "type": "string" }, "ParticipantNameFirst": { "type": "string" }, "DOB": { "type": "string" }, "IsCheckedIn": { "type": "boolean" }, "ValuesXml": { "type": "string" }, "IsSignee": { "type": "boolean" } } }, "WaiverEmailVerify": { "type": "object", "properties": { "me": { "$ref": "#/definitions/SWaiverEmailVerify" }, "_WPObjectStatus": { "format": "int32", "enum": [ 0, 1, 2, 3 ], "type": "integer" } } }, "WaiverImage": { "type": "object", "properties": { "_WPObjectStatus": { "format": "int32", "enum": [ 0, 1, 2, 3 ], "type": "integer" }, "k__BackingField": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "k__BackingField": { "type": "string" }, "_timesAdjustedForLocalRendering": { "type": "boolean" }, "me": { "$ref": "#/definitions/SWaiverImage" }, "_blobInfo": { "$ref": "#/definitions/WaiverImageBlobInfo" }, "k__BackingField": { "type": "array", "items": { "$ref": "#/definitions/NameValuePairXML" } } } }, "WaiverAttachment": { "type": "object", "properties": { "me": { "$ref": "#/definitions/SWaiverAttachment" }, "_WPObjectStatus": { "format": "int32", "enum": [ 0, 1, 2, 3 ], "type": "integer" }, "_timesAdjustedForLocalRendering": { "type": "boolean" }, "k__BackingField": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "k__BackingField": { "$ref": "#/definitions/WPUser" }, "_blobInfo": { "$ref": "#/definitions/WaiverImageBlobInfo" } } }, "WaiverFormInstance": { "type": "object", "properties": { "_WPObjectStatus": { "format": "int32", "enum": [ 0, 1, 2, 3 ], "type": "integer" }, "_labels": { "type": "array", "items": { "$ref": "#/definitions/WaiverSiteLabel" } }, "_doc": { "$ref": "#/definitions/XDocument" }, "fieldsDoc": { "$ref": "#/definitions/XDocument" }, "participantFieldsDoc": { "$ref": "#/definitions/XDocument" }, "_preventUpdate": { "type": "boolean" }, "me": { "$ref": "#/definitions/SWaiverFormInstance" } } }, "WFAPIDevice": { "type": "object", "properties": { "DeviceID": { "format": "int64", "type": "integer" }, "DeviceName": { "type": "string" }, "InternalAPIKeyID": { "format": "int64", "type": "integer" }, "DetailsXml": { "type": "string" } } }, "WaiverOriginalData": { "type": "object", "properties": { "k__BackingField": { "$ref": "#/definitions/SWaiver" }, "k__BackingField": { "type": "array", "items": { "$ref": "#/definitions/WaiverParticipant" } }, "k__BackingField": { "format": "int32", "type": "integer" } } }, "WFSignature2": { "type": "object", "properties": { "_WPObjectStatus": { "format": "int32", "enum": [ 0, 1, 2, 3 ], "type": "integer" }, "me": { "$ref": "#/definitions/SWFSignature2" }, "k__BackingField": { "type": "array", "items": { "format": "int32", "type": "integer" } } } }, "SWaiver": { "type": "object", "properties": { "waiverID": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "siteID": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "waiverEventID": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "waiverTextID": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "waiverFormInstanceID": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "dateSigned": { "format": "date-time", "type": "string" }, "address": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "phone": { "type": "string" }, "dOB": { "type": "string" }, "email": { "type": "string" }, "signedName": { "type": "string" }, "signedNameFirst": { "type": "string" }, "wPUserID": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "wPSMSMobileNumID": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "clientIP": { "type": "string" }, "fieldsXml": { "type": "string" }, "valuesXml": { "type": "string" }, "age": { "format": "int32", "type": "integer" }, "dateAttending": { "format": "date-time", "type": "string" }, "waiverFormID": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "hasSignature": { "type": "boolean" }, "optIn": { "type": "boolean" }, "clientType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4 ], "type": "integer" }, "waiverIsDeleted": { "type": "boolean" }, "deviceID": { "format": "int64", "type": "integer" }, "originalData": { "type": "string" }, "originalDataVerified": { "type": "boolean" }, "workflowStepID": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "workflowSessionID": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "isWorkflowSessionPrimary": { "type": "boolean" }, "referenceID1": { "type": "string" }, "referenceID2": { "type": "string" }, "referenceID3": { "type": "string" }, "bookingID": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "XDocument": { "type": "object", "properties": { "Declaration": { "$ref": "#/definitions/XDeclaration" }, "DocumentType": { "$ref": "#/definitions/XDocumentType", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17 ], "type": "integer", "readOnly": true }, "Root": { "$ref": "#/definitions/XElement", "readOnly": true }, "FirstNode": { "$ref": "#/definitions/XNode", "readOnly": true }, "LastNode": { "$ref": "#/definitions/XNode", "readOnly": true }, "NextNode": { "$ref": "#/definitions/XNode", "readOnly": true }, "PreviousNode": { "$ref": "#/definitions/XNode", "readOnly": true }, "BaseUri": { "type": "string", "readOnly": true }, "Document": { "$ref": "#/definitions/XDocument", "readOnly": true }, "Parent": { "$ref": "#/definitions/XElement", "readOnly": true } } }, "WorkflowStepForm": { "type": "object", "properties": { "_WPObjectStatus": { "format": "int32", "enum": [ 0, 1, 2, 3 ], "type": "integer" }, "me": { "$ref": "#/definitions/SWorkflowStepForm" }, "k__BackingField": { "$ref": "#/definitions/WorkflowStepFormDetail" } } }, "SWaiverForm": { "type": "object", "properties": { "iD": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "siteID": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "name": { "type": "string" }, "questions": { "type": "string" }, "numParticipantsPerForm": { "format": "int32", "type": "integer" }, "minAge": { "format": "int32", "type": "integer" }, "agreementLabelText": { "type": "string" }, "fieldInclude_Email": { "type": "boolean" }, "fieldInclude_Address": { "type": "boolean" }, "fieldInclude_Phone": { "type": "boolean" }, "fieldInclude_DOB": { "type": "boolean" }, "fieldRequire_Email": { "type": "boolean" }, "fieldRequire_Address": { "type": "boolean" }, "fieldRequire_Phone": { "type": "boolean" }, "fieldRequire_DOB": { "type": "boolean" }, "minAgeParticipant": { "format": "int32", "type": "integer" }, "fieldInclude_DOB_Participant": { "type": "boolean" }, "fieldRequire_DOB_Participant": { "type": "boolean" }, "generalAdm_show": { "type": "boolean" }, "generalAdm_require": { "type": "boolean" }, "dashIconColor": { "type": "string" }, "created": { "format": "date-time", "type": "string" }, "lastModified": { "format": "date-time", "type": "string" }, "lastModifiedBy": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "status": { "format": "int32", "enum": [ 0, 1, 2, 3 ], "type": "integer" }, "leadInText": { "type": "string" }, "includeSignature": { "type": "boolean" }, "allowSigningForSomeoneElse": { "type": "boolean" }, "maxAgeParticipant": { "format": "int32", "type": "integer" }, "options": { "type": "string" } } }, "SWaiverParticipantEvent": { "type": "object", "properties": { "iD": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "waiverParticipantID": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "waiverEventID": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "dateSaved": { "format": "date-time", "type": "string" }, "savedBy": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "isIncluded": { "type": "boolean" }, "isCurrent": { "type": "boolean" }, "isCheckedIn": { "type": "boolean" } } }, "SWaiverEventCategory": { "type": "object", "properties": { "iD": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "siteID": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "status": { "format": "int32", "enum": [ 0, 1, 2 ], "type": "integer" }, "orderNum": { "format": "int32", "type": "integer" }, "name": { "type": "string" } } }, "SWaiverEmailVerify": { "type": "object", "properties": { "waiverID": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "requestLastSent": { "format": "date-time", "type": "string" }, "codeExpires": { "format": "date-time", "type": "string" }, "code": { "type": "string" }, "verifiedOn": { "format": "date-time", "type": "string" }, "typeTwiceVerified": { "type": "boolean" }, "verifyStatus": { "format": "int32", "enum": [ 0, 1, 2 ], "type": "integer" } } }, "SWaiverImage": { "type": "object", "properties": { "iD": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "waiverID": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "fileSizeKB": { "format": "int32", "type": "integer" }, "blobData": { "type": "string" }, "dateTaken": { "format": "date-time", "type": "string" }, "metaData": { "type": "string" }, "uploadStatus": { "format": "int32", "enum": [ 0, 1, 2, 3, 4 ], "type": "integer" }, "isBillable": { "type": "boolean" }, "stepID": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "WaiverImageBlobInfo": { "type": "object", "properties": { "Filename": { "type": "string" }, "OriginalFilename": { "type": "string" }, "Extension": { "type": "string" }, "Uri": { "type": "string" }, "Filesize": { "type": "string" } } }, "NameValuePairXML": { "type": "object", "properties": { "k__BackingField": { "type": "string" }, "k__BackingField": { "type": "string" } } }, "SWaiverAttachment": { "type": "object", "properties": { "iD": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "waiverID": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "fileSizeKB": { "format": "int32", "type": "integer" }, "blobData": { "type": "string" }, "dateCreated": { "format": "date-time", "type": "string" }, "metaData": { "type": "string" }, "uploadStatus": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6 ], "type": "integer" }, "wPUserID": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "attachmentStepID": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "WPUser": { "type": "object", "properties": { "passwordHashMode_old": { "format": "int32", "enum": [ 0, 1 ], "type": "integer" }, "passwordChanged": { "type": "boolean" }, "_rolesFetched": { "type": "boolean" }, "me": { "$ref": "#/definitions/SUser" }, "k__BackingField": { "type": "string" }, "k__BackingField": { "type": "string" }, "k__BackingField": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "k__BackingField": { "format": "int32", "enum": [ 0, 1, 2, 3 ], "type": "integer" }, "k__BackingField": { "type": "array", "items": { "$ref": "#/definitions/Role" } }, "k__BackingField": { "type": "array", "items": { "$ref": "#/definitions/WPUserGroup" } } } }, "WaiverSiteLabel": { "type": "object", "properties": { "Code": { "type": "string" }, "Name": { "type": "string" }, "DefaultValue": { "type": "string" }, "Value": { "type": "string" }, "IncludeInFormInstanceLabels": { "type": "boolean" }, "CategoryName": { "type": "string" }, "PhaseOut": { "type": "boolean" } } }, "SWaiverFormInstance": { "type": "object", "properties": { "iD": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "waiverFormID": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "dateSaved": { "format": "date-time", "type": "string" }, "isCurrent": { "type": "boolean" }, "agreementText": { "type": "string" }, "fieldsXml": { "type": "string" }, "participantFieldsXml": { "type": "string" }, "options": { "type": "string" }, "savedBy": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "labelData": { "type": "string" } } }, "SWFSignature2": { "type": "object", "properties": { "iD": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "sigData": { "type": "string" }, "waiverID": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "entryType": { "format": "int32", "enum": [ 0, 1 ], "type": "integer" } } }, "XDeclaration": { "type": "object", "properties": { "Encoding": { "type": "string" }, "Standalone": { "type": "string" }, "Version": { "type": "string" } } }, "XDocumentType": { "type": "object", "properties": { "InternalSubset": { "type": "string" }, "Name": { "type": "string" }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17 ], "type": "integer", "readOnly": true }, "PublicId": { "type": "string" }, "SystemId": { "type": "string" }, "NextNode": { "$ref": "#/definitions/XNode", "readOnly": true }, "PreviousNode": { "$ref": "#/definitions/XNode", "readOnly": true }, "BaseUri": { "type": "string", "readOnly": true }, "Document": { "$ref": "#/definitions/XDocument", "readOnly": true }, "Parent": { "$ref": "#/definitions/XElement", "readOnly": true } } }, "XElement": { "type": "object", "properties": { "FirstAttribute": { "$ref": "#/definitions/XAttribute", "readOnly": true }, "HasAttributes": { "type": "boolean", "readOnly": true }, "HasElements": { "type": "boolean", "readOnly": true }, "IsEmpty": { "type": "boolean", "readOnly": true }, "LastAttribute": { "$ref": "#/definitions/XAttribute", "readOnly": true }, "Name": { "type": "object" }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17 ], "type": "integer", "readOnly": true }, "Value": { "type": "string" }, "FirstNode": { "$ref": "#/definitions/XNode", "readOnly": true }, "LastNode": { "$ref": "#/definitions/XNode", "readOnly": true }, "NextNode": { "$ref": "#/definitions/XNode", "readOnly": true }, "PreviousNode": { "$ref": "#/definitions/XNode", "readOnly": true }, "BaseUri": { "type": "string", "readOnly": true }, "Document": { "$ref": "#/definitions/XDocument", "readOnly": true }, "Parent": { "$ref": "#/definitions/XElement", "readOnly": true } } }, "XNode": { "type": "object", "properties": { "NextNode": { "$ref": "#/definitions/XNode", "readOnly": true }, "PreviousNode": { "$ref": "#/definitions/XNode", "readOnly": true }, "BaseUri": { "type": "string", "readOnly": true }, "Document": { "$ref": "#/definitions/XDocument", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17 ], "type": "integer", "readOnly": true }, "Parent": { "$ref": "#/definitions/XElement", "readOnly": true } } }, "SWorkflowStepForm": { "type": "object", "properties": { "stepID": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "waiverFormID": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "orderNum": { "format": "int32", "type": "integer" }, "isRequired": { "type": "boolean" }, "settingsXml": { "type": "string" } } }, "WorkflowStepFormDetail": { "type": "object", "properties": {} }, "SUser": { "type": "object", "properties": { "login_Name": { "type": "string" }, "password": { "type": "string" }, "passwordRaw": { "type": "string" }, "first_Name": { "type": "string" }, "middle_Name": { "type": "string" }, "last_Name": { "type": "string" }, "email_Address": { "type": "string" }, "company_name": { "type": "string" }, "verification_strings": { "$ref": "#/definitions/VerificationStringBlock" }, "verification_string_expires": { "format": "date-time", "type": "string" }, "status": { "format": "int32", "enum": [ 1, 2, 3, 4, 5 ], "type": "integer" }, "verified_Email": { "type": "boolean" }, "verified_ImageText": { "type": "boolean" }, "created": { "format": "date-time", "type": "string" }, "last_Login": { "format": "date-time", "type": "string" }, "strdetails": { "type": "string" }, "isSpecialty": { "type": "boolean" }, "timeZone": { "type": "string" }, "customPropertiesXml": { "type": "string" }, "passwordScore": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, -1 ], "type": "integer" }, "passwordExpires": { "format": "date-time", "type": "string" }, "lockoutExpires": { "format": "date-time", "type": "string" }, "passwordLastChanged": { "format": "date-time", "type": "string" }, "passwordHashMode": { "format": "int32", "enum": [ 0, 1 ], "type": "integer" } } }, "Role": { "type": "object", "properties": { "k__BackingField": { "type": "string" }, "k__BackingField": { "type": "string" }, "k__BackingField": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "k__BackingField": { "format": "int32", "enum": [ 0, 1, 2, 3 ], "type": "integer" }, "me": { "$ref": "#/definitions/SRole" } } }, "WPUserGroup": { "type": "object", "properties": { "k__BackingField": { "type": "string" }, "k__BackingField": { "type": "string" }, "k__BackingField": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "k__BackingField": { "format": "int32", "enum": [ 0, 1, 2, 3 ], "type": "integer" }, "me": { "$ref": "#/definitions/SGroup" } } }, "XAttribute": { "type": "object", "properties": { "IsNamespaceDeclaration": { "type": "boolean", "readOnly": true }, "Name": { "type": "object", "readOnly": true }, "NextAttribute": { "$ref": "#/definitions/XAttribute", "readOnly": true }, "NodeType": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17 ], "type": "integer", "readOnly": true }, "PreviousAttribute": { "$ref": "#/definitions/XAttribute", "readOnly": true }, "Value": { "type": "string" }, "BaseUri": { "type": "string", "readOnly": true }, "Document": { "$ref": "#/definitions/XDocument", "readOnly": true }, "Parent": { "$ref": "#/definitions/XElement", "readOnly": true } } }, "VerificationStringBlock": { "type": "object", "properties": { "str1": { "type": "string" }, "str2": { "type": "string" }, "str3": { "type": "string" } } }, "SRole": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "active": { "type": "boolean" } } }, "SGroup": { "type": "object", "properties": { "_name": { "type": "string" }, "_description": { "type": "string" }, "_active": { "type": "boolean" } } } }, "securityDefinitions": { "apiKey": { "type": "apiKey", "description": "API Key Authentication", "name": "apiKey", "in": "header" } } }