SEservicechannel
SiteAudit

Get site audit reports

Returns a site audit report, its part, or several reports for the current subscriber. <br />Required parameters:  • Option 1. auditId. Use to get a site audit report by ID.  • Option 2. The combination of fromDate and toDate. Use to get site audit reports for a specific period. <br />Note: Site audit reports are also known as site planning reports or just audits. See Site Planning Manager for more info.

get/subscribers/current/siteaudit/report

Request

Query parameters

auditIdinteger

The numeric identifier of the site audit report to return.

fromDatestring date-time

The date from which you want to return site audit reports. The format is YYYY-MM-DDThh:mm:ss.sssZ.

toDatestring date-time

The date until which you want to return site audit reports. The format is YYYY-MM-DDThh:mm:ss.sssZ.

countrystring

The two-letter ISO 3166-1 code of the location country.

locationIdinteger

The numeric identifier of the subscriber's property.

areastring

The audited area within the location.

Response

The requested site audit reports are in the response.

TemplateTypeNamestring

The site audit type.

AuditIdinteger

The numeric identifier of the site audit report.

StoreIdstring

The internal identifier of the subscriber’s property.

LocationNamestring

The name of the subscriber’s property.

Regionstring

The region where the property is located.

Districtstring

The district where the property is located.

AreaNamestring

The name of the audited area within the location.

CheckListNamestring

The name of the checklist.

CheckListItemNamestring

The name of the checklist item inspected by the auditor.

CheckListItemDescriptionstring

Detailed instructions for the auditor on how to check or rate the checklist item.

Statusstring

This field is obsolete. Use field "Score" with "PassThreshold" and "RatingSystem" fields please.

Scoreinteger

The score that the auditor gave on the checklist item

PassThresholdinteger

Pass threshold

RatingSystemstring

Rating system

CheckListItemQuantitystring

The quantity of the checklist item or its cost in dollars depending on the Unit.

Unitstring

The unit of measure of the checklist item: Quantity or Dollars.

CheckListDatestring date-time

The date and time when the auditor completed the audit of the checklist item.

TimeOffsetinteger

The UTC offset, or the difference in hours from the UTC time.

UserNamestring

The username of the auditor who uploaded the completed audit.

CheckListItemIdinteger

The numeric identifier of the checklist item.

AuditStartDatestring date-time

The date and time when the auditor started the site audit.

AuditFinishDatestring date-time

The date and time when the auditor completed the site audit.

Changes

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