ServiceChannel SiteAudit API

The SiteAudit API from ServiceChannel — 18 operation(s) for siteaudit.

OpenAPI Specification

servicechannel-siteaudit-api-openapi.yml Raw ↑
swagger: '2.0'
info:
  version: bearer.v1
  title: Fixxbook.Bearer.Api.V1 AfterHours SiteAudit API
  isOdataApi: false
  relativePath: ''
  discoveryPath: docs/bearer.v1
  _isAuthorizedAccess: true
host: sb2fixxbook.servicechannel.com:443
basePath: /api
schemes:
- https
security:
- oauth2: []
tags:
- name: SiteAudit
paths:
  /subscribers/current/locations/{locationId}/siteaudit/templateTypes:
    get:
      tags:
      - SiteAudit
      summary: Get available audit types for specified location
      operationId: GETv3_subscribers_current_locations_{locationId}_siteaudit_templateTypes
      consumes: []
      produces:
      - application/json
      - text/json
      parameters:
      - name: locationId
        in: path
        description: Location identifier
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/System.Object'
      deprecated: false
      x-access: Subscribers
  /subscribers/current/locations/{locationId}/siteaudit/templateTypes/{templateTypeId}/auditInfo:
    get:
      tags:
      - SiteAudit
      summary: Get audit data for specified location and audit type
      description: "Audit can be created from:\r\n            - completed audit data\r\n            - setup (templates) data\r\n            - mixed completed + setup\r\n            How audit data is combined depends on the loaded setup file to the system and/or availability \r\n            of previous finished audit data."
      operationId: GETv3_subscribers_current_locations_{locationId}_siteaudit_templateTypes_{templateTypeId}_auditInfo
      consumes: []
      produces:
      - application/json
      - text/json
      parameters:
      - name: locationId
        in: path
        description: Location identifier
        required: true
        type: integer
        format: int32
      - name: templateTypeId
        in: path
        description: Audit type identifier
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/System.Object'
      deprecated: false
      x-access: Subscribers
    post:
      tags:
      - SiteAudit
      summary: Post (save) completed audit to the database
      operationId: POSTv3_subscribers_current_locations_{locationId}_siteaudit_templateTypes_{templateTypeId}_auditInfo
      consumes:
      - application/json
      - text/json
      produces:
      - application/json
      - text/json
      parameters:
      - name: locationId
        in: path
        description: Location identifier
        required: true
        type: integer
        format: int32
      - name: templateTypeId
        in: path
        description: Audit type identifier
        required: true
        type: integer
        format: int32
      - name: request
        in: body
        description: Completed audit data
        required: true
        schema:
          $ref: '#/definitions/ServiceChannel.Services.Messaging.SiteAudit.AuditDataExternalOld'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/System.Object'
      deprecated: false
      x-access: Subscribers
  /subscribers/current/locations/{locationId}/siteaudit/templateTypes/{templateTypeId}/auditInfoWeighted:
    get:
      tags:
      - SiteAudit
      summary: Get audit data for specified location and audit type for new templates
      description: "Audit can be created from:\r\n            - completed audit data\r\n            - setup (templates) data\r\n            - mixed completed + setup\r\n            How audit data is combined depends on the loaded setup file to the system and/or availability \r\n            of previous finished audit data."
      operationId: GETv3_subscribers_current_locations_{locationId}_siteaudit_templateTypes_{templateTypeId}_auditInfoWeighted
      consumes: []
      produces:
      - application/json
      - text/json
      parameters:
      - name: locationId
        in: path
        description: Location identifier
        required: true
        type: integer
        format: int32
      - name: templateTypeId
        in: path
        description: Audit type identifier
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/System.Object'
      deprecated: false
      x-access: Subscribers
    post:
      tags:
      - SiteAudit
      summary: Post (save) completed audit of new type to the database
      operationId: POSTv3_subscribers_current_locations_{locationId}_siteaudit_templateTypes_{templateTypeId}_auditInfoWeighted
      consumes:
      - application/json
      - text/json
      produces:
      - application/json
      - text/json
      parameters:
      - name: locationId
        in: path
        description: Location identifier
        required: true
        type: integer
        format: int32
      - name: templateTypeId
        in: path
        description: Audit type identifier
        required: true
        type: integer
        format: int32
      - name: request
        in: body
        description: Completed audit data
        required: true
        schema:
          $ref: '#/definitions/ServiceChannel.Services.Messaging.SiteAudit.AuditDataWeightedExternal'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/System.Object'
      deprecated: false
      x-access: Subscribers
  /subscribers/current/locations/auditInfo:
    post:
      tags:
      - SiteAudit
      summary: Save completed audit to the database
      operationId: POSTv3_subscribers_current_locations_auditInfo
      consumes:
      - application/json
      - text/json
      produces:
      - application/json
      - text/json
      parameters:
      - name: request
        in: body
        description: Request object
        required: true
        schema:
          $ref: '#/definitions/ServiceChannel.Services.Messaging.SiteAudit.AuditDataExternal'
      responses:
        '200':
          description: The audit info for the requested location is provided in the response.
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.SiteAudit.SaveAuditDataResponse'
        '400':
          description: "The request is not accepted due to bad syntax, missing parameters, insufficient data, etc.\r\n            <br/>Error codes:\r\n            1010 - Invalid site audit parameters"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '401':
          description: "The request is not authorized.\r\n            <br/>Error codes:\r\n            504 - Missing or incorrect authentication credentials"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '500':
          description: "The server was unable to complete the request due to an internal error.\r\n            <br/>Error codes:\r\n            501 - Unspecified internal server error occurred"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Subscribers
  /subscribers/current/locations/auditinfo:
    get:
      tags:
      - SiteAudit
      summary: Get audit data for specified location and audit type without template information
      description: Setup data for areas-checklist-checklistItems relationship data are not provided in this method.
      operationId: GETv3_subscribers_current_locations_auditinfo?locationId={locationId}&templateId={templateId}
      consumes: []
      produces:
      - application/json
      - text/json
      parameters:
      - name: locationId
        in: query
        description: Location identifier
        required: true
        type: integer
        format: int32
      - name: templateId
        in: query
        description: Audit type identifier
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: The audit info for the requested location is provided in the response.
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.SiteAudit.GetAuditInfo'
        '400':
          description: "The request is not accepted due to bad syntax, missing parameters, insufficient data, etc.\r\n            <br/>Error codes:\r\n            1010 - Invalid site audit parameters"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '401':
          description: "The request is not authorized.\r\n            <br/>Error codes:\r\n            504 - Missing or incorrect authentication credentials"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '500':
          description: "The server was unable to complete the request due to an internal error.\r\n            <br/>Error codes:\r\n            501 - Unspecified internal server error occurred"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Subscribers
  /subscribers/current/locations/auditinfo/checklist/templates:
    get:
      tags:
      - SiteAudit
      summary: Get checklist templates by audit template.
      operationId: GETv3_subscribers_current_locations_auditinfo_checklist_templates?templateId={templateId}
      consumes: []
      produces:
      - application/json
      - text/json
      parameters:
      - name: templateId
        in: query
        description: Audit type identifier
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: Checklist templates are provided in the response.
          schema:
            type: array
            items:
              $ref: '#/definitions/ServiceChannel.Services.Messaging.SiteAudit.CheckListTemplateExternal'
        '400':
          description: "The request is not accepted due to bad syntax, missing parameters, insufficient data, etc.\r\n            <br/>Error codes:\r\n            1010 - Invalid site audit parameters"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '401':
          description: "The request is not authorized.\r\n            <br/>Error codes:\r\n            504 - Missing or incorrect authentication credentials"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '500':
          description: "The server was unable to complete the request due to an internal error.\r\n            <br/>Error codes:\r\n            501 - Unspecified internal server error occurred"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Subscribers
  /subscribers/current/locations/auditinfo/checklistitem/templates:
    get:
      tags:
      - SiteAudit
      summary: Get checklistitem templates by audit template.
      operationId: GETv3_subscribers_current_locations_auditinfo_checklistitem_templates?templateId={templateId}&checkListTemplateId={checkListTemplateId}
      consumes: []
      produces:
      - application/json
      - text/json
      parameters:
      - name: templateId
        in: query
        description: Audit type identifier
        required: true
        type: integer
        format: int32
      - name: checkListTemplateId
        in: query
        description: Check list template identifier
        required: false
        type: integer
        format: int32
      responses:
        '200':
          description: Checklist templates are provided in the response.
          schema:
            type: array
            items:
              $ref: '#/definitions/ServiceChannel.Services.Messaging.SiteAudit.CheckListItemExternal'
        '400':
          description: "The request is not accepted due to bad syntax, missing parameters, insufficient data, etc.\r\n            <br/>Error codes:\r\n            1010 - Invalid site audit parameters"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '401':
          description: "The request is not authorized.\r\n            <br/>Error codes:\r\n            504 - Missing or incorrect authentication credentials"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '500':
          description: "The server was unable to complete the request due to an internal error.\r\n            <br/>Error codes:\r\n            501 - Unspecified internal server error occurred"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Subscribers
  /subscribers/current/siteaudit/checkListItems/{checkListItemId}:
    get:
      tags:
      - SiteAudit
      summary: Get details for specified checklist item
      description: "Details include:\r\n            - comments with attachments\r\n            - workorders\r\n            - quantity"
      operationId: GETv3_subscribers_current_siteaudit_checkListItems_{checkListItemId}
      consumes: []
      produces:
      - application/json
      - text/json
      parameters:
      - name: checkListItemId
        in: path
        description: Identifier of checklist item
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: The requested completed audit list is in the response.
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.SiteAudit.CheckListItemDetailsResponse'
        '401':
          description: "The request is not authorized.\r\n            <br/>Error codes:\r\n            504 - Missing or incorrect authentication credentials"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '500':
          description: "The server was unable to complete the request due to an internal error.\r\n            <br/>Error codes:\r\n            501 - Unspecified internal server error occurred"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Subscribers
  /subscribers/current/siteaudit/audits/completed:
    get:
      tags:
      - SiteAudit
      summary: Get completed site audits
      description: Retrieves a list of completed site audits and their details for the current subscriber.
      operationId: GETv3_subscribers_current_siteaudit_audits_completed?daysPeriod={daysPeriod}
      consumes: []
      produces:
      - application/json
      - text/json
      parameters:
      - name: daysPeriod
        in: query
        description: "Number of days in the past from the current moment. Allows you to find site audits completed over the specified period of time. Any number of days can be entered (no limits).\r\n            <br />When you leave the field empty, the method will return completed audits for the past 365 days."
        required: false
        type: integer
        format: int32
      responses:
        '200':
          description: The list of completed audits is in the response.
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.SiteAudit.CompletedAuditListResponse'
        '401':
          description: "The request is not authorized.\r\n            <br/>Error codes:\r\n            504 &mdash; Missing or incorrect authentication credentials"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '500':
          description: "The server was unable to complete the request due to an internal error.\r\n            <br/>Error codes:\r\n            501 &mdash; Unspecified internal server error occurred"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Subscribers
  /subscribers/current/siteaudit/report:
    get:
      tags:
      - SiteAudit
      summary: Get site audit reports
      description: "Returns a site audit report, its part, or several reports for the current subscriber.\r\n            <br />**Required parameters:**\r\n             • **Option 1**. `auditId`. Use to get a site audit report by ID.\r\n             • **Option 2**. The combination of `fromDate` and `toDate`. Use to get site audit reports for a specific period.\r\n            <br />***Note:*** Site audit reports are also known as *site planning reports* or just *audits*. See [Site Planning Manager](https://servicechannel.atlassian.net/wiki/spaces/SCU/pages/551059548/Site+Planning+Manager) for more info."
      operationId: GETv3_subscribers_current_siteaudit_report?auditId={auditId}&fromDate={fromDate}&toDate={toDate}&country={country}&locationId={locationId}&area={area}
      consumes: []
      produces:
      - application/json
      - text/json
      parameters:
      - name: auditId
        in: query
        description: The numeric identifier of the site audit report to return.
        required: false
        type: integer
        format: int32
      - name: fromDate
        in: query
        description: The date from which you want to return site audit reports. The format is `YYYY-MM-DDThh:mm:ss.sssZ`.
        required: false
        type: string
        format: date-time
      - name: toDate
        in: query
        description: The date until which you want to return site audit reports. The format is `YYYY-MM-DDThh:mm:ss.sssZ`.
        required: false
        type: string
        format: date-time
      - name: country
        in: query
        description: The two-letter [ISO 3166-1 code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the location country.
        required: false
        type: string
      - name: locationId
        in: query
        description: The numeric identifier of the subscriber's property.
        required: false
        type: integer
        format: int32
      - name: area
        in: query
        description: The audited area within the location.
        required: false
        type: string
      responses:
        '200':
          description: The requested site audit reports are in the response.
          schema:
            type: array
            items:
              $ref: '#/definitions/ServiceChannel.Services.Messaging.SiteAudit.AuditReportExternal'
        '400':
          description: "The request is not accepted due to bad syntax, missing parameters, insufficient data, etc.\r\n            <br/>Error codes:\r\n            1010 - Invalid site audit parameters"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '401':
          description: "The request is not authorized.\r\n            <br/>Error codes:\r\n            504 - Missing or incorrect authentication credentials"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '500':
          description: "The server was unable to complete the request due to an internal error.\r\n            <br/>Error codes:\r\n            501 - Unspecified internal server error occurred"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Subscribers
  /subscribers/current/siteaudit/completed/{auditId}:
    get:
      tags:
      - SiteAudit
      summary: Get information on a completed audit
      description: Returns details of a completed site audit.
      operationId: GETv3_subscribers_current_siteaudit_completed_{auditId}
      consumes: []
      produces:
      - application/json
      - text/json
      parameters:
      - name: auditId
        in: path
        description: Unique numeric identifier of the site audit. To get the audit ID, you can run the `GET/subscribers/current/siteaudit/report` method.
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: The requested site audit info is in the response.
          schema:
            $ref: '#/definitions/ServiceChannel.Services.RequestHandlers.SiteAudit.CompletedAuditInfo'
        '400':
          description: "The request is not accepted due to bad syntax, missing parameters, insufficient data, etc.\r\n            <br/>Error codes:\r\n            608 &mdash; Do not have access to the location"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '401':
          description: "The request is not authorized.\r\n            <br/>Error codes:\r\n            504 &mdash; Missing or incorrect authentication credentials"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '404':
          description: "The requested resource does not exist on the server.\r\n            <br/>Error codes:\r\n            1008 &mdash; Audit not found"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '500':
          description: "The server was unable to complete the request due to an internal error.\r\n            <br/>Error codes:\r\n            501 &mdash; Unspecified internal server error occurred"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Subscribers
  /subscribers/current/siteaudit/completed:
    put:
      tags:
      - SiteAudit
      summary: Modify details of a completed audit
      description: "Allows users to update, delete, and add information for completed site audits. The following audit parameters can be modified:\r\n             • `Areas`\r\n             • `CheckLists`\r\n             • `CheckListItems`\r\n             • `WorkOrderIds`\r\n             • `Quantity`\r\n             • `Issues`\r\n             • `Attachments`\r\n            <br />Use the [GET/subscribers/current/siteaudit/completed/{auditId}](https://developer.servicechannel.com/swagger/index.html#/SiteAudit/GETv3_subscribers_current_siteaudit_completed_%7BauditId%7D) method to get the audit you want to modify."
      operationId: PUTv3_subscribers_current_siteaudit_completed
      consumes:
      - application/json
      - text/json
      produces:
      - application/json
      - text/json
      parameters:
      - name: request
        in: body
        description: Request parameters for updating a completed site audit.
        required: true
        schema:
          $ref: '#/definitions/ServiceChannel.Services.Messaging.SiteAudit.UpdatedAuditDataExternal'
      responses:
        '200':
          description: The site audit was successfully updated.
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.SiteAudit.UpdatedCompletedAuditResponse'
        '400':
          description: "The request is not accepted due to bad syntax, missing parameters, insufficient data, etc.\r\n            <br/>Error codes:\r\n            608 &mdash; Do not have access to the location\r\n            1009 &mdash; An error occurred while updating the entries. See the inner exception for details\r\n            1009 &mdash; Validation failed: Site audit must contain at least one checklist item\r\n            1009 &mdash; Validation failed: The range must contain the score\r\n            1009 &mdash; Validation failed: The range must contain the pass threshold value\r\n            1009 &mdash; Unexpected error"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '401':
          description: "The requested resource requires authentication.\r\n            <br/>Error codes:\r\n            504 &mdash; API call rejected by security permissions"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '404':
          description: "The requested resource does not exist on the server.\r\n            <br/>Error codes:\r\n            1008 &mdash; The requested audit was not found"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '500':
          description: "Something went wrong, and the server was unable to complete your request.\r\n            <br/>Error codes:\r\n            501 &mdash; Unspecified internal server error occurred"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Subscribers
    post:
      tags:
      - SiteAudit
      summary: Save completed audit to the database
      operationId: POSTv3_subscribers_current_siteaudit_completed
      consumes:
      - application/json
      - text/json
      produces:
      - application/json
      - text/json
      parameters:
      - name: request
        in: body
        description: Request object
        required: true
        schema:
          $ref: '#/definitions/ServiceChannel.Services.Messaging.SiteAudit.AuditDataExternal'
      responses:
        '201':
          description: The audit with status completed is created
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.SiteAudit.SaveAuditDataResponse'
        '400':
          description: "The request is not accepted due to bad syntax, missing parameters, insufficient data, etc.\r\n            <br/>Error codes:\r\n            608 - Do not have access to the location.\r\n            999 - Invalid site audit linked work orders\r\n            1005 - Save site audit error.\r\n            1007 - Inactive template type.\r\n            1010 - Invalid site audit parameters"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '401':
          description: "The request is not authorized.\r\n            <br/>Error codes:\r\n            504 - Missing or incorrect authentication credentials"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '500':
          description: "The server was unable to complete the request due to an internal error.\r\n            <br/>Error codes:\r\n            501 - Unspecified internal server error occurred"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Subscribers
  /subscribers/current/siteaudit/{auditId}:
    get:
      tags:
      - SiteAudit
      summary: Get site audit by Id
      operationId: GETv3_subscribers_current_siteaudit_{auditId}
      consumes: []
      produces:
      - application/json
      - text/json
      parameters:
      - name: auditId
        in: path
        description: The numeric identifier of the site audit to return.
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: The requested site audit info is in the response.
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.SiteAudit.SavedAuditInfoExternal'
        '400':
          description: "The request is not accepted due to bad syntax, missing parameters, insufficient data, etc.\r\n            <br/>Error codes:\r\n            608 - Do not have access to the location"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '401':
          description: "The request is not authorized.\r\n            <br/>Error codes:\r\n            504 - Missing or incorrect authentication credentials"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '404':
          description: "The requested resource does not exist on the server.\r\n            <br/>Error codes:\r\n            1008 - Audit not found"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '500':
          description: "The server was unable to complete the request due to an internal error.\r\n            <br/>Error codes:\r\n            501 - Unspecified internal server error occurred"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Subscribers
  /subscribers/current/siteaudit/open:
    put:
      tags:
      - SiteAudit
      summary: Update audit with open status
      operationId: PUTv3_subscribers_current_siteaudit_open
      consumes:
      - application/json
      - text/json
      produces:
      - application/json
      - text/json
      parameters:
      - name: request
        in: body
        description: Open audit info
        required: true
        schema:
          $ref: '#/definitions/ServiceChannel.Services.Messaging.SiteAudit.UpdatedAuditDataExternal'
      responses:
        '200':
          description: The site audit with open status is successfully updated.
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.SiteAudit.UpdatedOpenAuditResponse'
        '400':
          description: "The request is not accepted due to bad syntax, missing parameters, insufficient data, etc.\r\n            <br/>Error codes:\r\n            608 - Do not have access to the location.\r\n            1003 - Site audit has already been completed\r\n            1009 - Unexpected error"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '401':
          description: "The request is not authorized.\r\n            <br/>Error codes:\r\n            504 - Missing or incorrect authentication credentials"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '404':
          description: "The requested resource does not exist on the server.\r\n            <br/>Error codes:\r\n            1008 - Audit not found"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '500':
          description: "The server was unable to complete the request due to an internal error.\r\n            <br/>Error codes:\r\n            501 - Unspecified internal server error occurred"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Subscribers
    post:
      tags:
      - SiteAudit
      summary: Save audit with open status to the database
      operationId: POSTv3_subscribers_current_siteaudit_open
      consumes:
      - application/json
      - text/json
      produces:
      - application/json
      - text/json
      parameters:
      - name: request
        in: body
        description: Request object
        required: true
        schema:
          $ref: '#/definitions/ServiceChannel.Services.Messaging.SiteAudit.AuditDataExternal'
      responses:
        '201':
          description: The audit with status open is created
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.SiteAudit.SaveAuditDataResponse'
        '400':
          description: "The request is not accepted due to bad syntax, missing parameters, insufficient data, etc.\r\n            <br/>Error codes:\r\n            601 - Invalid location Id.\r\n            1006 - Save site audit error.\r\n            1010 - Invalid site audit parameters"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '401':
          description: "The request is not authorized.\r\n            <br/>Error codes:\r\n            504 - Missing or incorrect authentication credentials"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '500':
          description: "The server was unable to complete the request due to an internal error.\r\n            <br/>Error codes:\r\n            501 - Unspecified internal server error occurred"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Subscribers
  /subscribers/current/siteaudit/audits/filtered:
    get:
      tags:
      - SiteAudit
      summary: Get the list of filtered site audits
      descripti

# --- truncated at 32 KB (151 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/servicechannel/refs/heads/main/openapi/servicechannel-siteaudit-api-openapi.yml