README

The SafetyCulture API gives you direct access to your data in the SafetyCulture platform.

This PHP package is automatically generated by the Swagger Codegen project:

API version: 1.0.0
Build package: io.swagger.codegen.languages.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/georgicon/swagger-iauditor.git"
    }
  ],
  "require": {
    "georgicon/swagger-iauditor": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/SwaggerClient-php/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\ActionsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$action_id = "action_id_example"; // string | The action identifier

try {
    $apiInstance->actionsActionIdDelete($action_id);
} catch (Exception $e) {
    echo 'Exception when calling ActionsApi->actionsActionIdDelete: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://localhost

Class	Method	HTTP request	Description
ActionsApi	actionsActionIdDelete	DELETE /actions/{actionId}	Delete an Action
ActionsApi	actionsActionIdGet	GET /actions/{actionId}	Retrieve the details of an existing Action
ActionsApi	actionsActionIdPut	PUT /actions/{actionId}	Update an existing Action
ActionsApi	actionsPost	POST /actions	Create an Action
ActionsApi	actionsSearchPost	POST /actions/search	Search for actions given a range of criteria
AuditsApi	auditsAuditIdDeepLinkPost	POST /audits/{auditId}/deep_link	Generate a link to the audit
AuditsApi	auditsAuditIdExportPost	POST /audits/{auditId}/export	Export an audit report
AuditsApi	auditsAuditIdExportsExportIdFilenameGet	GET /audits/{auditId}/exports/{exportId}/{filename}	Download an audit report
AuditsApi	auditsAuditIdExportsExportIdGet	GET /audits/{auditId}/exports/{exportId}	Check the status of the export request submitted earlier
AuditsApi	auditsAuditIdGet	GET /audits/{auditId}	Get a particular audit
AuditsApi	auditsAuditIdMediaMediaIdGet	GET /audits/{auditId}/media/{mediaId}	Get a media item associated with an audit
AuditsApi	auditsAuditIdPut	PUT /audits/{auditId}	Updates a particular audit
AuditsApi	auditsAuditIdSharePost	POST /audits/{auditId}/share	Share an audit
AuditsApi	auditsAuditIdWebReportLinkDelete	DELETE /audits/{auditId}/web_report_link	Delete the link to the web report of the audit
AuditsApi	auditsAuditIdWebReportLinkGet	GET /audits/{auditId}/web_report_link	Retrieve a link to the web report of the audit
AuditsApi	auditsPost	POST /audits	Start an audit
AuditsApi	auditsSearchGet	GET /audits/search	Search modified audits
AuthApi	authPost	POST /auth	Create an API authorization token
BatchApi	batchPost	POST /batch	A batch endpoint that sends multiple requests in a single call
ExportProfilesApi	exportProfilesIdGet	GET /export_profiles/{id}	Get a particular export profile
ExportProfilesApi	exportProfilesSearchGet	GET /export_profiles/search	Get a list of available export profiles
GroupsApi	groupsGet	GET /groups	Lists all the groups in an org
GroupsApi	groupsGroupIdUsersGet	GET /groups/{group_id}/users	Lists all the users
GroupsApi	groupsGroupIdUsersPost	POST /groups/{group_id}/users	Adds a user to a group
GroupsApi	groupsPost	POST /groups	Create a group
GroupsApi	groupsRoleIdUsersUserIdDelete	DELETE /groups/{role_id}/users/{user_id}	Removes a user from the group with the specified role ID
ResponseSetsApi	responseSetsGet	GET /response_sets	Retrieves all response sets in the requesting user's organisation
ResponseSetsApi	responseSetsIdDelete	DELETE /response_sets/{id}	Deletes a response set with the specified response ID
ResponseSetsApi	responseSetsIdGet	GET /response_sets/{id}	Retrieves the response set with the given response set ID
ResponseSetsApi	responseSetsIdPut	PUT /response_sets/{id}	Updates a response set
ResponseSetsApi	responseSetsIdResponsesPost	POST /response_sets/{id}/responses	Creates a response
ResponseSetsApi	responseSetsIdResponsesResponseIdDelete	DELETE /response_sets/{id}/responses/{responseId}	Deletes a response
ResponseSetsApi	responseSetsIdResponsesResponseIdPut	PUT /response_sets/{id}/responses/{responseId}	Updates a response
ResponseSetsApi	responseSetsPost	POST /response_sets	Creates a new response set
ShareApi	shareConnectionsGet	GET /share/connections	Get the organisations and groups associated with the authenticated user
TemplatesApi	templatesSearchGet	GET /templates/search	Search modified templates
UsersApi	usersPost	POST /users	Adds a new user to the organisation of the requesting user
UsersApi	usersSearchPost	POST /users/search	Looks up user information
UsersApi	usersUserIdGet	GET /users/{user_id}	Looks up user information by user ID
UsersApi	usersUserIdPut	PUT /users/{user_id}	Updates user details such as username (email address), first name and last name
WorkflowsApi	workflowsGet	GET /workflows	Retrieves all registered workflows
WorkflowsApi	workflowsPost	POST /workflows	Registers a new workflow
WorkflowsApi	workflowsWorkflowIdDelete	DELETE /workflows/{workflow_id}	Deletes a specified workflow
WorkflowsApi	workflowsWorkflowIdGet	GET /workflows/{workflow_id}	Retrieves a specified workflow
WorkflowsApi	workflowsWorkflowIdPut	PUT /workflows/{workflow_id}	Updates a specified workflow

Documentation For Models

Documentation For Authorization

All endpoints do not require authorization.

georgicon / swagger-iauditor

Maintainers

Details