Help Page Home

GET api/assessments/{id}/report?reportCode={reportCode}

Gets a PDF report for an assessment. Note: this does not create a lock on the assessment.

Required Scopes

Assessment.Detail+ImageAccess

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The unique ID of the assessment.

globally unique identifier

Required

reportCode

The report definition code. Call GET /api/reports for a list of available values. Defaults to "MOBILEFULL" if no report code specified.

string

Default value is MOBILEFULL

Body Parameters

None.

Response Information

Resource Description

A PDF of the report.

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.