SiteAudit

Get site audit by Id

get/subscribers/current/siteaudit/{auditId}

Request

Base URL
https://sb2api.servicechannel.com/v3
Auth
OAuth 2
Authorization codehttps://sb2login.servicechannel.com/oauth/authorize
Token URLhttps://sb2login.servicechannel.com/oauth/token
TypeScript
https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/docs/subscribers/current/siteaudit/:auditId/get.ts
A function with typed inputs. Its response is checked against the schema.

auditIdinteger required

The numeric identifier of the site audit to return.

The requested site audit info is in the response.

Idinteger

Unique numeric identifier of the site audit.

StoreIdinteger

Unique numeric identifier of the location where the site audit was conducted.

UserIdinteger

Unique numeric identifier of the user (auditor) who conducted the site audit.

UserNamestring

Display name of the user (auditor) who conducted the site audit.

TemplateTypeIdinteger

Unique numeric identifier of the template that was used to complete the site audit. The template determines the audit type.

StartDatestring date-time

Date and time when the user started the audit in the SC Mobile app or in Service Automation. The format is YYYY-MM-DDThh:mm:ss.ss.

FinishDatestring date-time

Date and time when the site audit was completed. The format is YYYY-MM-DDThh:mm:ss.ss.

FinishDateStrstring

Date when the site audit was completed. The format is MMM DD, YYYY.

Status'Undefined' | 'Open' | 'Completed'

Unique numeric identifier of the status. Possible response values: • 1: The site audit status is Open. • 2: The site audit status is Completed.

Emailsstring

Email address(es) to which the audit results were sent out by the auditor upon completing the audit.

No recorded changes to this operation across all 1 revision of this API.