Help Page Home

GET api/assessments/{id}/images/{sequence}

Get an image header for a given assessment and sequence number

Required Scopes

Assessment.Detail+ImageAccess

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The unique ID of the assessment.

globally unique identifier

Required

sequence

The sequence number of the image.

integer

Required

Body Parameters

None.

Response Information

Resource Description

ImageHeader
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.

CreatedDate

date

None.

DisplayOrder

integer

None.

SequenceNumber

integer

None.

Comments

string

None.

Response Formats

{
  "Id": "f2b20a32-069e-48ee-9362-fb3721c10c9b",
  "CreatedDate": "2026-10-01T01:01:06.1140554+01:00",
  "DisplayOrder": 1,
  "SequenceNumber": 1,
  "Comments": "sample string 2"
}
<ImageHeader xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AudaAPI.Models">
  <Comments>sample string 2</Comments>
  <CreatedDate>2026-10-01T01:01:06.1140554+01:00</CreatedDate>
  <DisplayOrder>1</DisplayOrder>
  <Id>f2b20a32-069e-48ee-9362-fb3721c10c9b</Id>
  <SequenceNumber>1</SequenceNumber>
</ImageHeader>