### GET /api/v{version}/Site Source: https://api.rapidglobal.com/swagger/v1/swagger.json Get the all the sites for the authenticated package. Requires a version path parameter. ```APIDOC ## GET /api/v{version}/Site ### Description Get the all the sites for the authenticated package. ### Method GET ### Endpoint /api/v{version}/Site ### Parameters #### Path Parameters - **version** (string) - Required - The API version. ### Response #### Success Response (200) - **[Response Schema Not Specified]** - OK ``` -------------------------------- ### Get Site Configuration Source: https://api.rapidglobal.com/swagger/v1/swagger.json Retrieves the existing RapidGo configuration for a specific site. ```APIDOC ## GET /api/v{version}/Site/{siteId} ### Description Get the existing RapidGo configuration for a site. ### Method GET ### Endpoint /api/v{version}/Site/{siteId} ### Parameters #### Path Parameters - **siteId** (integer) - Required - The ID of the site. - **version** (string) - Required - The API version. ### Response #### Success Response (200) - **RapidGoSiteConfigurationDto** - The RapidGo site configuration details. ``` -------------------------------- ### Get Categories Source: https://api.rapidglobal.com/swagger/v1/swagger.json Retrieves a list of all categories for the authenticated package. ```APIDOC ## GET /api/v{version}/RapidAuditor/Category ### Description Retrieves a list of all categories for the authenticated package. ### Method GET ### Endpoint /api/v{version}/RapidAuditor/Category ### Parameters #### Path Parameters - **version** (string) - Required - The API version. ### Response #### Success Response (200) - **array of CategoryDao** - A list of category objects. #### Response Example { "example": "response body" } ``` -------------------------------- ### Get All Departments Source: https://api.rapidglobal.com/swagger/v1/swagger.json Retrieves a list of all departments for the authenticated package, specified by the API version. ```APIDOC ## GET /api/v{version}/Location/Department ### Description Get the all the Departments for the authenticated package. ### Method GET ### Endpoint /api/v{version}/Location/Department ### Parameters #### Path Parameters - **version** (string) - Required - The API version. ### Response #### Success Response (200) - **array of DepartmentDto** - A list of departments. ``` -------------------------------- ### GET /api/v{version}/Site/Info/{siteId} Source: https://api.rapidglobal.com/swagger/v1/swagger.json Retrieves detailed information for a specific site, including key cabinet system details. ```APIDOC ## GET /api/v{version}/Site/Info/{siteId} ### Description Retrieves detailed information for a specific site, including key cabinet system details. ### Method GET ### Endpoint /api/v{version}/Site/Info/{siteId} ### Parameters #### Path Parameters - **siteId** (integer) - Required - The unique identifier of the site to retrieve information for. - **version** (string) - Required - API version. ### Response #### Success Response (200) - The response will contain the site information details. #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### Get All States Source: https://api.rapidglobal.com/swagger/v1/swagger.json Retrieves a list of all states for the authenticated package, specified by the API version. ```APIDOC ## GET /api/v{version}/Location/State ### Description Get the all the states for the authenticated package. ### Method GET ### Endpoint /api/v{version}/Location/State ### Parameters #### Path Parameters - **version** (string) - Required - The API version. ### Response #### Success Response (200) - **array of StateDto** - A list of states. ``` -------------------------------- ### Get All Admin Roles Source: https://api.rapidglobal.com/swagger/v1/swagger.json Fetches a list of all available admin roles within the system. ```APIDOC ## GET /api/v{version}/Admin/Roles ### Description Retrieves all the admin roles. ### Method GET ### Endpoint /api/v{version}/Admin/Roles ### Parameters #### Path Parameters - **version** (string) - Required - The API version. ### Response #### Success Response (200) - **array of RoleGroupDto** - A list of admin role groups. ``` -------------------------------- ### Get All Divisions Source: https://api.rapidglobal.com/swagger/v1/swagger.json Retrieves a list of all divisions for the authenticated package, specified by the API version. ```APIDOC ## GET /api/v{version}/Location/Division ### Description Get the all the divisions for the authenticated package. ### Method GET ### Endpoint /api/v{version}/Location/Division ### Parameters #### Path Parameters - **version** (string) - Required - The API version. ### Response #### Success Response (200) - **array of DivisionDto** - A list of divisions. ``` -------------------------------- ### Get Site by ID Source: https://api.rapidglobal.com/swagger/v1/swagger.json Retrieves details of a specific site using its unique ID. ```APIDOC ## GET /api/v{version}/Site/{id} ### Description Retrieves details of a specific site using its unique ID. ### Method GET ### Endpoint /api/v{version}/Site/{id} ### Parameters #### Path Parameters - **id** (number) - Required - The ID of the site to retrieve. - **version** (string) - Required - The API version. ### Response #### Success Response (200) - **(GetSiteDto)** - The details of the requested site. ``` -------------------------------- ### Get All SubAdmins Source: https://api.rapidglobal.com/swagger/v1/swagger.json Retrieves a list of all sub-administrators associated with the authenticated package. Requires the API version as a path parameter. ```APIDOC ## GET /api/v{version}/Admin/SubAdmin ### Description Get the all the subadmins for the authenticated package. ### Method GET ### Endpoint /api/v{version}/Admin/SubAdmin ### Parameters #### Path Parameters - **version** (string) - Required - The API version. ### Response #### Success Response (200) - Returns an array of GetSubAdminDto objects. #### Response Example [ { "id": "string", "emailAddress": "string", "name": "string", "businessId": "string", "employeeId": "string", "isActive": true } ] ``` -------------------------------- ### Get Webhook Events Source: https://api.rapidglobal.com/swagger/index.html Retrieves a list of all available webhook events that a user can subscribe to. ```APIDOC ## GET /api/v{version}/Webhook/Events ### Description Get the all web hook events a user can subscribe to. ### Method GET ### Endpoint /api/v{version}/Webhook/Events ``` -------------------------------- ### GET /api/v{version}/WorkorderForm/{id} Source: https://api.rapidglobal.com/swagger/v1/swagger.json Retrieves a specific workorder form by its ID. ```APIDOC ## GET /api/v{version}/WorkorderForm/{id} ### Description Retrieves a specific workorder form by its ID. ### Method GET ### Endpoint /api/v{version}/WorkorderForm/{id} ### Parameters #### Path Parameters - **id** (number) - Required - The ID of the workorder form to retrieve. - **version** (string) - Required - The version of the API. ### Response #### Success Response (200) - **GetWorkorderFormDto** - The details of the workorder form. ``` -------------------------------- ### Get All Learner Types Source: https://api.rapidglobal.com/swagger/v1/swagger.json Retrieves a list of all learner types associated with the company for a given API version. ```APIDOC ## GET /api/v{version}/LearnerType ### Description Get all learner types given a company id. ### Method GET ### Endpoint /api/v{version}/LearnerType ### Parameters #### Path Parameters - **version** (string) - Required - The API version. ### Response #### Success Response (200) - **array of LearnerTypeDto** - A list of learner types. ``` -------------------------------- ### GET /api/v{version}/Inductee/GetInducteeProfileImage/{id} Source: https://api.rapidglobal.com/swagger/v1/swagger.json Fetches the profile image for a specific inductee using their ID. ```APIDOC ## GET /api/v{version}/Inductee/GetInducteeProfileImage/{id} ### Description Retrieves the profile image of an inductee. The inductee is identified by their unique ID. ### Method GET ### Endpoint /api/v{version}/Inductee/GetInducteeProfileImage/{id} ### Parameters #### Path Parameters - **id** (number) - Required - The unique identifier of the inductee whose profile image is to be retrieved. - **version** (string) - Required - The API version. ### Response #### Success Response (200) - **string** - The profile image data, typically a URL or base64 encoded string. ``` -------------------------------- ### GET /api/v{version}/WorkorderForm/WorkorderLog/{id} Source: https://api.rapidglobal.com/swagger/v1/swagger.json Retrieves the workorder log for a given workorder form ID. ```APIDOC ## GET /api/v{version}/WorkorderForm/WorkorderLog/{id} ### Description Retrieves the workorder log for a given workorder form ID. ### Method GET ### Endpoint /api/v{version}/WorkorderForm/WorkorderLog/{id} ### Parameters #### Path Parameters - **id** (number) - Required - The ID of the workorder form for which to retrieve the log. - **version** (string) - Required - The version of the API. ### Response #### Success Response (200) - **Array of WorkorderFormLogItemDao** - A list of log items for the workorder form. ``` -------------------------------- ### Get Form Answers Source: https://api.rapidglobal.com/swagger/v1/swagger.json Retrieves a set of answers for a given form, identified by its form answer ID and version. ```APIDOC ## GET /api/v{version}/FormAnswer/{formAnswerId} ### Description Get a Form set of answers given an form answer id. ### Method GET ### Endpoint /api/v{version}/FormAnswer/{formAnswerId} ### Parameters #### Path Parameters - **formAnswerId** (integer) - Required - - **version** (string) - Required - ### Response #### Success Response (200) - **(array of FormFieldAnswerDto)** - ``` -------------------------------- ### Get Contractor Auto Login URL Source: https://api.rapidglobal.com/swagger/v1/swagger.json Retrieves the Rapid Contractor Auto Login URL for a specified contractor ID. ```APIDOC ## GET /api/v{version}/Contractor/GetRapidContractorAutoLoginUrl/{id} ### Description Get the Rapid Contractor Auto Login Url for specified id. ### Method GET ### Endpoint /api/v{version}/Contractor/GetRapidContractorAutoLoginUrl/{id} ### Parameters #### Path Parameters - **id** (integer) - Required - The ID of the contractor. - **version** (string) - Required - The API version. ### Response #### Success Response (200) - **string** - The auto login URL. #### Response Example "http://example.com/auto-login-url" ``` -------------------------------- ### Create Site Source: https://api.rapidglobal.com/swagger/v1/swagger.json Creates a new site with the provided site details. ```APIDOC ## POST /api/v{version}/Site/Create ### Description Creates a new site with the provided site details. ### Method POST ### Endpoint /api/v{version}/Site/Create ### Parameters #### Path Parameters - **version** (string) - Required - The API version. #### Request Body - **(SiteDto)** - Required - The details of the new site to create. ``` -------------------------------- ### Create Site Configuration Source: https://api.rapidglobal.com/swagger/v1/swagger.json Creates or overwrites the RapidGo configuration for a specific site. ```APIDOC ## POST /api/v{version}/Site/{siteId} ### Description Create or overwrite the RapidGo configuration for a site. ### Method POST ### Endpoint /api/v{version}/Site/{siteId} ### Parameters #### Path Parameters - **siteId** (integer) - Required - Site ID. - **version** (string) - Required - The API version. ### Request Body - **RapidGoSiteConfigurationDto** - The Rapid Go site configuration model. ### Response #### Success Response (200) - **RapidGoSiteConfigurationDto** - The updated RapidGo site configuration details. ``` -------------------------------- ### Get Type Of Works Source: https://api.rapidglobal.com/swagger/v1/swagger.json Retrieves the types of works associated with a given personnel type ID. This endpoint allows filtering by personnel type to get specific work categories. ```APIDOC ## GET /api/v{version}/Contractor/GetTypeOfWorks/{personnelTypeId} ### Description Get the type of works given the personnel type id. ### Method GET ### Endpoint /api/v{version}/Contractor/GetTypeOfWorks/{personnelTypeId} ### Parameters #### Path Parameters - **personnelTypeId** (integer) - Required - - **version** (string) - Required - ### Response #### Success Response (200) - **Array of TypeOfWorkDto** #### Response Example { "example": "[\n {\n \"id\": 0,\n \"name\": \"string\"\n }\n]" } ``` -------------------------------- ### Get Workorder Source: https://api.rapidglobal.com/swagger/index.html Retrieves a specific workorder by its ID. ```APIDOC ## GET /api/v{version}/Workorder/{id} ### Description Get a workorder. ### Method GET ### Endpoint /api/v{version}/Workorder/{id} #### Path Parameters - **id** (string) - Required - The ID of the workorder to retrieve. ``` -------------------------------- ### Get Types of Works Source: https://api.rapidglobal.com/swagger/v1/swagger.json Retrieves all available types of works. ```APIDOC ## GET /api/v{version}/Contractor/GetTypeOfWorks ### Description Get the all the type of works available. ### Method GET ### Endpoint /api/v{version}/Contractor/GetTypeOfWorks ### Parameters #### Path Parameters - **version** (string) - Required - The API version. ### Response #### Success Response (200) - **Array of TypeOfWorkDto objects** #### Response Example [ { "example": "TypeOfWorkDto object example" } ] ``` -------------------------------- ### POST /api/v{version}/RapidAccessEntry/SignIn Source: https://api.rapidglobal.com/swagger/v1/swagger.json Creates an entry record in the Rapid Global Visitor Access system. ```APIDOC ## POST /api/v{version}/RapidAccessEntry/SignIn ### Description Creates an entry record in Rapid Global Visitor Access system. ### Method POST ### Endpoint /api/v{version}/RapidAccessEntry/SignIn ### Parameters #### Path Parameters - **version** (string) - Required - API version #### Request Body - **body** (SignInModelDto) - Required - The model for signing in. ### Response #### Success Response (200) - **body** (GetEntryLogDto) - OK ``` -------------------------------- ### Get Incident Source: https://api.rapidglobal.com/swagger/v1/swagger.json Retrieves the details of a specific incident given its ID. ```APIDOC ## GET /api/v{version}/Incident/{id} ### Description Gets Incident details given an id. Information included: ### Method GET ### Endpoint /api/v{version}/Incident/{id} ### Parameters #### Path Parameters - **id** (number) - Required - - **version** (string) - Required - ### Response #### Success Response (200) - **(Incident details)** - ``` -------------------------------- ### Get Workorder Form Source: https://api.rapidglobal.com/swagger/index.html Retrieves a specific workorder form by its ID. ```APIDOC ## GET /api/v{version}/WorkorderForm/{id} ### Description Get a workorder form. ### Method GET ### Endpoint /api/v{version}/WorkorderForm/{id} #### Path Parameters - **id** (string) - Required - The ID of the workorder form to retrieve. ``` -------------------------------- ### POST /api/v{version}/SiteHost/UploadBulkHosts Source: https://api.rapidglobal.com/swagger/v1/swagger.json Bulk Upload a list of hosts. Please limit the upload to 3000 records at a time. ```APIDOC ## POST /api/v{version}/SiteHost/UploadBulkHosts ### Description Bulk Upload a list of hosts. Please limit the upload to 3000 records at a time. ### Method POST ### Endpoint /api/v{version}/SiteHost/UploadBulkHosts ### Parameters #### Path Parameters - **version** (string) - Required - API version #### Request Body - **(array of HostBulkInfoDto)** - Required - A list of hosts to upload. ### Response #### Success Response (200) - **(GetHostDtoBulkActionResult)** - OK ``` -------------------------------- ### Get Workorder by ID Source: https://api.rapidglobal.com/swagger/v1/swagger.json Retrieves a specific workorder using its unique identifier. ```APIDOC ## GET /api/v{version}/Workorder/{id} ### Description Get a workorder given an id ### Method GET ### Endpoint /api/v{version}/Workorder/{id} ### Parameters #### Path Parameters - **id** (number) - Required - - **version** (string) - Required - ### Response #### Success Response (200) - **schema** (GetWorkorderDto) - ``` -------------------------------- ### Site Configuration Source: https://api.rapidglobal.com/swagger/v1/swagger.json This section details the configuration options available for a specific site, allowing for customization of features such as evacuation plans, custom forms, and printer settings. ```APIDOC ## Site Configuration Options ### Description Allows for the configuration of various site-specific features, including the display of evacuation plans and custom forms for sign-in/sign-out, as well as enabling label and document printers. ### Properties - **showEvacuationPlan** (boolean) - Show/Hide the Evacuation Plan when signing in. The map is uploaded via Rapid Access - Site Info - Site Activation. - **showEntryForm** (boolean) - Show/Hide the Custom Form feature for signing in. - **showExitForm** (boolean) - Show/Hide the Custom Form feature for signing out. - **enableLabelPrinter** (boolean) - Enables the label printer. - **enableDocumentPrinter** (boolean) - Enables the document printer. ``` -------------------------------- ### Create SubAdmin Source: https://api.rapidglobal.com/swagger/v1/swagger.json Creates a new sub-administrator within the Rapid Global system. Requires the API version as a path parameter and the new sub-admin details in the request body. ```APIDOC ## POST /api/v{version}/Admin/SubAdmin/Create ### Description Create a new sub admin in the Rapid Global system. ### Method POST ### Endpoint /api/v{version}/Admin/SubAdmin/Create ### Parameters #### Path Parameters - **version** (string) - Required - The API version. #### Request Body - **emailAddress** (string) - Required - The email address of the new sub-admin. - **name** (string) - Required - The name of the new sub-admin. - **businessId** (string) - Required - The business ID for the new sub-admin. - **employeeId** (string) - Required - The employee ID for the new sub-admin. ### Request Example ```json { "emailAddress": "new.admin@example.com", "name": "New Admin Name", "businessId": "biz789", "employeeId": "emp012" } ``` ### Response #### Success Response (200) - Returns the created GetSubAdminDto object. #### Response Example ```json { "id": "string", "emailAddress": "string", "name": "string", "businessId": "string", "employeeId": "string", "isActive": true } ``` ``` -------------------------------- ### Get Likelihoods Source: https://api.rapidglobal.com/swagger/v1/swagger.json Retrieves a list of likelihoods. Supports filtering by active status. ```APIDOC ## GET /api/v{version}/Incident/Likelihoods ### Description Retrieves a list of likelihoods. Supports filtering by active status. ### Method GET ### Endpoint /api/v{version}/Incident/Likelihoods ### Parameters #### Query Parameters - **activeOnly** (boolean) - Optional - Whether to include only active Likelihoods (default is true). #### Path Parameters - **version** (string) - Required - The version of the API. ### Response #### Success Response (200) - **LikelihoodDto** (array) - A list of likelihood data transfer objects. #### Response Example ```json [ { "id": "string", "name": "string", "active": true } ] ``` ``` -------------------------------- ### SignInModelDto Source: https://api.rapidglobal.com/swagger/v1/swagger.json Defines the data structure for user sign-in, including required fields like name and site ID, and optional fields for contact information. ```APIDOC ## SignInModelDto ### Description Represents the model for user sign-in information. ### Required Properties - **firstName** (string, minLength: 1) - The first name of the user. - **lastName** (string, minLength: 1) - The last name of the user. - **siteId** (integer, format: int64) - The ID of the site. - **timeIn** (string) - The time of sign-in. ### Optional Properties - **securityId** (string, nullable) - The security ID of the user. - **inducteeId** (integer, format: int64, nullable) - The ID of the inductee. - **mobile** (string, nullable) - The mobile number of the user. - **email** (string, nullable) - The email address of the user. - **companyName** (string, nullable) - The name of the company the user is associated with. ``` -------------------------------- ### POST /api/v{version}/Sine/CheckIn Source: https://api.rapidglobal.com/swagger/v1/swagger.json Endpoint for site compliance. Requires a version path parameter and an empty request body. ```APIDOC ## POST /api/v{version}/Sine/CheckIn ### Description Endpoint for site compliance. ### Method POST ### Endpoint /api/v{version}/Sine/CheckIn ### Parameters #### Path Parameters - **version** (string) - Required - The API version. ### Response #### Success Response (200) - **SineCheckInResponse** - The response object for Sine check-in. ``` -------------------------------- ### Get Severities Source: https://api.rapidglobal.com/swagger/v1/swagger.json Retrieves a list of severities. Supports filtering by active status. ```APIDOC ## GET /api/v{version}/Incident/Severities ### Description Retrieves a list of severities. Supports filtering by active status. ### Method GET ### Endpoint /api/v{version}/Incident/Severities ### Parameters #### Query Parameters - **activeOnly** (boolean) - Optional - Whether to include only active Severities (default is true). #### Path Parameters - **version** (string) - Required - The version of the API. ### Response #### Success Response (200) - **SeverityDto** (array) - A list of severity data transfer objects. #### Response Example ```json [ { "id": "string", "name": "string", "active": true } ] ``` ``` -------------------------------- ### SiteHost Operations Source: https://api.rapidglobal.com/swagger/v1/swagger.json Uploads files to be processed by RapidGlobal. ```APIDOC ## SiteHost Operations ### Description Uploads files to be processed by RapidGlobal. ### Method Not specified in source. ### Endpoint Not specified in source. ### Parameters Not specified in source. ### Request Example Not specified in source. ### Response Not specified in source. ``` -------------------------------- ### SiteHost Operations Source: https://api.rapidglobal.com/swagger/index.html Operations for uploading files and searching for hosts. ```APIDOC ## POST /api/v{version}/SiteHost/Search ### Description Search for hosts given a filter object. ### Method POST ### Endpoint /api/v{version}/SiteHost/Search ``` ```APIDOC ## POST /api/v{version}/SiteHost/UploadBulkHosts ### Description Bulk Upload a list of hosts. ### Method POST ### Endpoint /api/v{version}/SiteHost/UploadBulkHosts ``` -------------------------------- ### Invite Contractor Source: https://api.rapidglobal.com/swagger/v1/swagger.json Invites a new contractor to the Rapid Global system. ```APIDOC ## POST /api/v{version}/Contractor/Invite ### Description Invite a new contractor in the Rapid Global system. ### Method POST ### Endpoint /api/v{version}/Contractor/Invite ### Parameters #### Path Parameters - **version** (string) - Required - The API version. #### Request Body - **InviteContractorDto object** - Required - The data for inviting a contractor. ### Request Example { "example": "InviteContractorDto object example" } ### Response #### Success Response (200) - **GetContractorDto object** #### Response Example { "example": "GetContractorDto object example" } ``` -------------------------------- ### Create Auditor Admin Source: https://api.rapidglobal.com/swagger/v1/swagger.json Creates a new administrator in the Auditor system. ```APIDOC ## POST /api/v{version}/Auditor/Admin/Create ### Description Creates a new admin in Auditor. ### Method POST ### Endpoint /api/v{version}/Auditor/Admin/Create ### Parameters #### Query Parameters - **version** (string) - Required - The API version. #### Request Body - **Mobile** (string) - Optional - The administrator's mobile phone number. - **MobileCountryCode** (string) - Optional - The country code of the mobile phone number. - **RoleIds** (array of integers) - Optional - The IDs of the roles to be assigned to the administrator. - **StateIds** (array of integers) - Optional - The ID of the states to be assigned to the administrator. Assigns all child areas and sites. - **AreaIds** (array of integers) - Optional - The ID of the areas to be assigned to the administrator. Assigns all child sites associated with the selected area(s). - **SiteIds** (array of integers) - Optional - The ID of the sites to be assigned to the administrator. - **AllEmailsReciever** (boolean) - Optional - If set to TRUE, the admin will receive emails relating to all audits, tasks and actions that are created and updated. Defaults to FALSE. - **RecieveAuditVersionEmails** (boolean) - Optional - Set to TRUE to receive emails when an audit template is updated. Defaults to FALSE. - **RecieveNonCompliantEmails** (boolean) - Optional - Set to TRUE to receive emails regarding non-compliant responses. Defaults to FALSE. - **DoNotDisturbFrom** (string) - Optional - Sets the start time for the 'Do Not Disturb' period (24-hour format). - **DoNotDisturbTo** (string) - Optional - Sets the end time for the 'Do Not Disturb' period (24-hour format). - **TimeZoneId** (string) - Optional - Sets the time zone for the 'Do Not Disturb' period. ### Response #### Success Response (200) - **AuditorAdminDto** (object) - Contains the created administrator details. ``` -------------------------------- ### POST /api/v{version}/RapidAccessEntry/Compliance Source: https://api.rapidglobal.com/swagger/v1/swagger.json Returns user compliance status against a site. Requires a version path parameter and a SiteAccessComplianceRequest in the request body. ```APIDOC ## POST /api/v{version}/RapidAccessEntry/Compliance ### Description Returns user compliance status against a site. ### Method POST ### Endpoint /api/v{version}/RapidAccessEntry/Compliance ### Parameters #### Path Parameters - **version** (string) - Required - The API version. #### Request Body - **SiteAccessComplianceRequest** - Required - The request object for site compliance. ### Response #### Success Response (200) - **SiteAccessComplianceResponseDto** - The response object containing site access compliance details. ``` -------------------------------- ### Get Inductee Custom Values Source: https://api.rapidglobal.com/swagger/v1/swagger.json Retrieves the custom values associated with a specific inductee. ```APIDOC ## GET /api/v{version}/Inductee/GetInducteeCustomValues/{id} ### Description Get the Inductee custom values. ### Method GET ### Endpoint /api/v{version}/Inductee/GetInducteeCustomValues/{id} ### Parameters #### Path Parameters - **id** (number) - Required - Inductee Id - **version** (string) - Required - API version #### Response #### Success Response (200) - **additionalProperties** (string) - Description of custom field values ``` -------------------------------- ### Get Auditor Roles Source: https://api.rapidglobal.com/swagger/v1/swagger.json Retrieves a list of all available auditor roles for the authenticated package. ```APIDOC ## GET /api/v{version}/Auditor/Admin/Roles ### Description Retrieves a list of all available auditor roles for the authenticated package. ### Method GET ### Endpoint /api/v{version}/Auditor/Admin/Roles ### Parameters #### Path Parameters - **version** (string) - Required - The API version. ### Response #### Success Response (200) - **array of AuditorAdminRoleDto** - A list of auditor role objects. #### Response Example { "example": "response body" } ``` -------------------------------- ### Create Webhook Source: https://api.rapidglobal.com/swagger/index.html Creates a new webhook endpoint receiver for subscribing to events. ```APIDOC ## POST /api/v{version}/Webhook/Create ### Description Create a web hook endpoint receiver. ### Method POST ### Endpoint /api/v{version}/Webhook/Create ``` -------------------------------- ### GET /api/v{version}/Investigation/{id} Source: https://api.rapidglobal.com/swagger/v1/swagger.json Retrieves the details of a specific investigation given its ID. ```APIDOC ## GET /api/v{version}/Investigation/{id} ### Description Retrieves the details of a specific investigation given its ID. ### Method GET ### Endpoint /api/v{version}/Investigation/{id} ### Parameters #### Path Parameters - **id** (number) - Required - - **version** (string) - Required - ### Response #### Success Response (200) - **IncidentDto** (object) - ``` -------------------------------- ### Update Site Configuration Source: https://api.rapidglobal.com/swagger/v1/swagger.json Updates an existing RapidGo configuration for a specific site. ```APIDOC ## PUT /api/v{version}/Site/{siteId} ### Description Update an existing RapidGo configuration for a site. ### Method PUT ### Endpoint /api/v{version}/Site/{siteId} ### Parameters #### Path Parameters - **siteId** (integer) - Required - The ID of the site. - **version** (string) - Required - The API version. ### Request Body - **UpdateRapidGoSiteConfigurationDto** - The update model for RapidGo site configuration. ### Response #### Success Response (200) - **RapidGoSiteConfigurationDto** - The updated RapidGo site configuration details. ``` -------------------------------- ### Get Mechanism of Injuries Source: https://api.rapidglobal.com/swagger/v1/swagger.json Retrieves a list of mechanism of injuries. Supports filtering by active status. ```APIDOC ## GET /api/v{version}/Incident/MechanismOfInjuries ### Description Retrieves a list of mechanism of injuries. Supports filtering by active status. ### Method GET ### Endpoint /api/v{version}/Incident/MechanismOfInjuries ### Parameters #### Query Parameters - **activeOnly** (boolean) - Optional - Whether to include only active mechanism of injuries (default is true). #### Path Parameters - **version** (string) - Required - The version of the API. ### Response #### Success Response (200) - **MechanismInjuryDto** (array) - A list of mechanism injury data transfer objects. #### Response Example ```json [ { "id": "string", "name": "string", "active": true } ] ``` ``` -------------------------------- ### Site Operations Source: https://api.rapidglobal.com/swagger/v1/swagger.json Operations that allow to fetch sites. ```APIDOC ## Site Operations ### Description Operations that allow to fetch sites. ### Method Not specified in source. ### Endpoint Not specified in source. ### Parameters Not specified in source. ### Request Example Not specified in source. ### Response Not specified in source. ``` -------------------------------- ### Get Nature of Injuries Source: https://api.rapidglobal.com/swagger/v1/swagger.json Retrieves a list of nature of injuries. Supports filtering by active status. ```APIDOC ## GET /api/v{version}/Incident/NatureOfInjuries ### Description Retrieves a list of nature of injuries. Supports filtering by active status. ### Method GET ### Endpoint /api/v{version}/Incident/NatureOfInjuries ### Parameters #### Query Parameters - **activeOnly** (boolean) - Optional - Whether to include only active nature of injuries (default is true). #### Path Parameters - **version** (string) - Required - The version of the API. ### Response #### Success Response (200) - **NatureInjuryDto** (array) - A list of nature injury data transfer objects. #### Response Example ```json [ { "id": "string", "name": "string", "active": true } ] ``` ``` -------------------------------- ### Get Body Locations Source: https://api.rapidglobal.com/swagger/v1/swagger.json Retrieves a list of body locations. Optionally filters for only active locations. ```APIDOC ## GET /api/v{version}/Incident/BodyLocations ### Description Gets the list of body locations. You can filter the results to include only active body locations. ### Method GET ### Endpoint /api/v{version}/Incident/BodyLocations ### Parameters #### Query Parameters - **activeOnly** (boolean) - Optional - Whether to include only active body locations (default is true). #### Path Parameters - **version** (string) - Required - The API version. ### Response #### Success Response (200) - **schema** (array of BodilyLocationDto) - A list of body location data. #### Error Response (500) - Internal Server Error ``` -------------------------------- ### Sine Operations Source: https://api.rapidglobal.com/swagger/v1/swagger.json Retrieve Compliance. ```APIDOC ## Sine Operations ### Description Retrieve Compliance. ### Method Not specified in source. ### Endpoint Not specified in source. ### Parameters Not specified in source. ### Request Example Not specified in source. ### Response Not specified in source. ``` -------------------------------- ### Get Contractor Work Regions Source: https://api.rapidglobal.com/swagger/v1/swagger.json Retrieves the work regions associated with a specific contractor ID. ```APIDOC ## GET /api/v{version}/Contractor/WorkRegions/{contractorId} ### Description Get the work regions for a given contractor ID. ### Method GET ### Endpoint /api/v{version}/Contractor/WorkRegions/{contractorId} ### Parameters #### Path Parameters - **contractorId** (integer) - Required - The ID of the contractor. - **version** (string) - Required - The API version. ### Response #### Success Response (200) - **Array of CompanyWorkRegionDao objects** #### Response Example [ { "example": "CompanyWorkRegionDao object example" } ] ``` -------------------------------- ### Get Contractor by ID Source: https://api.rapidglobal.com/swagger/v1/swagger.json Retrieves a specific contractor's details using their unique identifier. ```APIDOC ## GET /api/v{version}/Contractor/{id} ### Description Get a Contractor given an id. ### Method GET ### Endpoint /api/v{version}/Contractor/{id} ### Parameters #### Path Parameters - **id** (number) - Required - - **version** (string) - Required - ### Response #### Success Response (200) - **(object)** - #### Response Example { "example": "response body" } ``` -------------------------------- ### Add Workorder Source: https://api.rapidglobal.com/swagger/index.html Inserts a new workorder into the system. ```APIDOC ## POST /api/v{version}/Workorder/Add ### Description Insert a new workorder. ### Method POST ### Endpoint /api/v{version}/Workorder/Add ``` -------------------------------- ### RapidGo Site Configuration DTO Source: https://api.rapidglobal.com/swagger/v1/swagger.json Details the configuration object for RapidGo sites, including site name, activation status, sign-in URLs, and options for government check-ins and location-based sign-ins. ```APIDOC ## RapidGoSiteConfigurationDto ### Description Represents the configuration settings for a RapidGo enabled site. ### Properties - **name** (string, nullable, readOnly) - The name of the site. - **activationDate** (string, format: date-time, nullable, readOnly) - The date and time when the site was activated. - **siteSignInUrl** (string, nullable, readOnly) - The URL for site sign-in. - **siteEnabled** (boolean) - Indicates if the site is enabled. - **showGovernmentCheckInUrl** (boolean) - Indicates whether to show the government check-in URL. - **governmentCheckInUrl** (string, nullable) - The URL for government check-in. - **allowLocationBasedSignIn** (boolean) - Allows sign-in based on user location. - **allowedQrCodeType** (QrCodeType) - The type of QR code allowed for sign-in. - **unverifiedDocumentsMessage** (string, nullable) - The message to display when a user signs in with unverified documents. If left blank, a default message will be shown. - **invalidEntryFormMessage** (string, nullable) - The message to display when a user fails sign-in due to incorrect entry form answers. If left blank, a default message will be shown. - **learnerTypeConfigurations** (array of RapidGoLearnerTypeConfigurationDto, nullable) - Configuration for learner types. ``` -------------------------------- ### Get Audit Details Source: https://api.rapidglobal.com/swagger/v1/swagger.json Retrieves detailed information for a specific audit using its unique identifier. ```APIDOC ## GET /api/v{version}/RapidAuditor/Audit/{auditId} ### Description Retrieve information for a particular Audit. ### Method GET ### Endpoint /api/v{version}/RapidAuditor/Audit/{auditId} ### Parameters #### Path Parameters - **auditId** (integer) - Required - The ID of the audit to retrieve. - **version** (string) - Required - The API version. ### Response #### Success Response (200) - **RapidAuditorAuditDto** (object) - The audit data. ``` -------------------------------- ### Get Workorder Form Log Source: https://api.rapidglobal.com/swagger/index.html Retrieves the workorder log for a given workorder form ID. ```APIDOC ## GET /api/v{version}/WorkorderForm/WorkorderLog/{id} ### Description Get a workorder log for given workorder form id. ### Method GET ### Endpoint /api/v{version}/WorkorderForm/WorkorderLog/{id} #### Path Parameters - **id** (string) - Required - The ID of the workorder form for which to retrieve the log. ``` -------------------------------- ### Site Operations Source: https://api.rapidglobal.com/swagger/index.html Operations for fetching, creating, updating, and searching for sites and their related information. ```APIDOC ## GET /api/v{version}/Site ### Description Get the all the sites for the authenticated package. ### Method GET ### Endpoint /api/v{version}/Site ``` ```APIDOC ## GET /api/v{version}/Site/{id} ### Description Get site given a site id. ### Method GET ### Endpoint /api/v{version}/Site/{id} ``` ```APIDOC ## POST /api/v{version}/Site/Search ### Description Search for sites given a filter object. ### Method POST ### Endpoint /api/v{version}/Site/Search ``` ```APIDOC ## POST /api/v{version}/Site/Create ### Description Create a new site. ### Method POST ### Endpoint /api/v{version}/Site/Create ``` ```APIDOC ## PUT /api/v{version}/Site/{siteId} ### Description Update an existing Site. ### Method PUT ### Endpoint /api/v{version}/Site/{siteId} ``` ```APIDOC ## GET /api/v{version}/Site/Info/{siteId} ### Description Retrieves detailed information for a specific site, including key cabinet system details. ### Method GET ### Endpoint /api/v{version}/Site/Info/{siteId} ``` ```APIDOC ## PUT /api/v{version}/Site/Info/{siteId} ### Description Update site related info. ### Method PUT ### Endpoint /api/v{version}/Site/Info/{siteId} ``` ```APIDOC ## POST /api/v{version}/Site/Info/Search ### Description Searches for site information based on the provided filter criteria. Each result includes detailed site information and the associated key cabinet system type. ### Method POST ### Endpoint /api/v{version}/Site/Info/Search ``` ```APIDOC ## GET /api/v{version}/Site/RapidGo/{siteId} ### Description Get the existing RapidGo configuration for a site. ### Method GET ### Endpoint /api/v{version}/Site/RapidGo/{siteId} ``` ```APIDOC ## POST /api/v{version}/Site/RapidGo/{siteId} ### Description Create or overwrite the RapidGo configuration for a site. ### Method POST ### Endpoint /api/v{version}/Site/RapidGo/{siteId} ``` ```APIDOC ## PUT /api/v{version}/Site/RapidGo/{siteId} ### Description Update an existing RapidGo configuration for a site. ### Method PUT ### Endpoint /api/v{version}/Site/RapidGo/{siteId} ``` -------------------------------- ### PUT /api/v{version}/Site/Info/{siteId} Source: https://api.rapidglobal.com/swagger/v1/swagger.json Updates site-related information. ```APIDOC ## PUT /api/v{version}/Site/Info/{siteId} ### Description Update site related info. ### Method PUT ### Endpoint /api/v{version}/Site/Info/{siteId} ### Parameters #### Path Parameters - **siteId** (integer) - Required - . - **version** (string) - Required - API version. ### Request Body - **(object)** - Required - . ### Request Example ```json { "example": "request body" } ``` ### Response #### Success Response (200) - OK ``` -------------------------------- ### Get Sub Audit Details Source: https://api.rapidglobal.com/swagger/v1/swagger.json Retrieves detailed information for a specific sub-audit using its unique identifier. ```APIDOC ## GET /api/v{version}/RapidAuditor/Audit/SubAudit/{subAuditId} ### Description Retrieve information for a particular Sub Audit. ### Method GET ### Endpoint /api/v{version}/RapidAuditor/Audit/SubAudit/{subAuditId} ### Parameters #### Path Parameters - **subAuditId** (integer) - Required - The ID of the sub-audit to retrieve. - **version** (string) - Required - The API version. ### Response #### Success Response (200) - **RapidAuditorSubAuditDto** (object) - The sub-audit data. ``` -------------------------------- ### POST /api/v{version}/Workorder Source: https://api.rapidglobal.com/swagger/v1/swagger.json Creates a new workorder. Requires a PostWorkorderDto object in the request body. ```APIDOC ## POST /api/v{version}/Workorder ### Description Creates a new workorder. ### Method POST ### Endpoint /api/v{version}/Workorder ### Parameters #### Path Parameters - **version** (string) - Required - The version of the API. #### Request Body - **PostWorkorderDto** - Required - The data for creating a new workorder. ### Response #### Success Response (200) - **GetWorkorderDto** - The details of the created workorder. ``` -------------------------------- ### Incident Operations Source: https://api.rapidglobal.com/swagger/index.html Operations that allow to search incidents, search CorrectiveActions, get incident, and save incident. ```APIDOC ## POST /api/v{version}/Incident/Search ### Description Search for incidentIds given a filter object. ### Method POST ### Endpoint /api/v{version}/Incident/Search ``` ```APIDOC ## POST /api/v{version}/Incident/CorrectiveAction/Search ### Description Search for Corrective Actions given a filter object. ### Method POST ### Endpoint /api/v{version}/Incident/CorrectiveAction/Search ``` ```APIDOC ## GET /api/v{version}/Incident/{id} ### Description Get an Incident. ### Method GET ### Endpoint /api/v{version}/Incident/{id} ``` ```APIDOC ## POST /api/v{version}/Incident/Create ### Description Create a new incident. ### Method POST ### Endpoint /api/v{version}/Incident/Create ``` ```APIDOC ## GET /api/v{version}/Incident/CategoryTypes ### Description Gets the list of available categories and types. ### Method GET ### Endpoint /api/v{version}/Incident/CategoryTypes ``` ```APIDOC ## GET /api/v{version}/Incident/BodyLocations ### Description Gets the list of body locations. ### Method GET ### Endpoint /api/v{version}/Incident/BodyLocations ``` ```APIDOC ## GET /api/v{version}/Incident/NatureOfInjuries ### Description Gets the list of nature of injuries. ### Method GET ### Endpoint /api/v{version}/Incident/NatureOfInjuries ``` ```APIDOC ## GET /api/v{version}/Incident/MechanismOfInjuries ### Description Gets the list of mechanism of injuries. ### Method GET ### Endpoint /api/v{version}/Incident/MechanismOfInjuries ``` ```APIDOC ## GET /api/v{version}/Incident/Severities ### Description Gets the list of Severities. ### Method GET ### Endpoint /api/v{version}/Incident/Severities ``` ```APIDOC ## GET /api/v{version}/Incident/Likelihoods ### Description Gets the list of Likelihoods. ### Method GET ### Endpoint /api/v{version}/Incident/Likelihoods ``` ```APIDOC ## POST /api/v{version}/Incident/Location/Search ### Description Search for locations given a filter object. ### Method POST ### Endpoint /api/v{version}/Incident/Location/Search ```