GET api/assessments/{id}/summary

Get an assessment summary by its unique or composite ID. Note: this action will not create a lock on the assessment, which should be carried out previously if updates are to be made to the resource later.

Required Scopes

Assessment.MainIndex

Request Information

URI Parameters

Name	Description	Type	Additional information
id	Either a guid (the OBID of the assessment) or composite key ({Originator}-{AssessmentNumber}).	string	Required

Body Parameters

None.

Response Information

Resource Description

An assessment summary.

AssessmentSummary

Name	Type	Additional information
AssessmentNumber	string	None.
ClaimReference	string	None.
Originator	string	None.
CreationDate	date	None.
WorkProviderCode	string	None.
WorkProvider	string	None.
GrandTotalExcVat	decimal number	None.
GrandTotalIncVat	decimal number	None.
TotalPartsAmt	decimal number	None.
TotalLabourAmt	decimal number	None.
IncidentDate	date	None.
BookedInForRepair	date	None.
ISOCode	string	None.
LastUpdated	date	None.
Manufacturer	string	None.
MenuBrandName	string	None.
Model	string	None.
Id	globally unique identifier	None.
PolicyNumber	string	None.
Registration	string	None.
RepairerName	string	None.
SalvageCategory	string	None.
State	string	None.
Status	string	None.
VehicleType	string	None.
VehicleRegMonth	integer	None.
VehicleRegYear	integer	None.
VinInternationalUsed	boolean	None.
AssignedTo	string	None.
AssignedToDescription	string	None.
PartCount	integer	None.
PartNumbers	string	None.

{
  "AssessmentNumber": "sample string 1",
  "ClaimReference": "sample string 2",
  "Originator": "sample string 3",
  "CreationDate": "2026-10-01T00:59:32.9805191+01:00",
  "WorkProviderCode": "sample string 4",
  "WorkProvider": "sample string 5",
  "GrandTotalExcVat": 1.0,
  "GrandTotalIncVat": 1.0,
  "TotalPartsAmt": 1.0,
  "TotalLabourAmt": 1.0,
  "IncidentDate": "2026-10-01T00:59:32.9805191+01:00",
  "BookedInForRepair": "2026-10-01T00:59:32.9805191+01:00",
  "ISOCode": "sample string 6",
  "LastUpdated": "2026-10-01T00:59:32.9805191+01:00",
  "Manufacturer": "sample string 7",
  "MenuBrandName": "sample string 8",
  "Model": "sample string 9",
  "Id": "89434a55-4a20-42e0-a43d-b84432192172",
  "PolicyNumber": "sample string 11",
  "Registration": "sample string 12",
  "RepairerName": "sample string 13",
  "SalvageCategory": "sample string 14",
  "State": "sample string 15",
  "Status": "sample string 16",
  "VehicleType": "sample string 17",
  "VehicleRegMonth": 18,
  "VehicleRegYear": 19,
  "VinInternationalUsed": true,
  "AssignedTo": "sample string 20",
  "AssignedToDescription": "sample string 21",
  "PartCount": 22,
  "PartNumbers": "sample string 23"
}

<AssessmentSummary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AudaAPI.Models">
  <AssessmentNumber>sample string 1</AssessmentNumber>
  <AssignedTo>sample string 20</AssignedTo>
  <AssignedToDescription>sample string 21</AssignedToDescription>
  <BookedInForRepair>2026-10-01T00:59:32.9805191+01:00</BookedInForRepair>
  <ClaimReference>sample string 2</ClaimReference>
  <CreationDate>2026-10-01T00:59:32.9805191+01:00</CreationDate>
  <GrandTotalExcVat>1</GrandTotalExcVat>
  <GrandTotalIncVat>1</GrandTotalIncVat>
  <ISOCode>sample string 6</ISOCode>
  <Id>89434a55-4a20-42e0-a43d-b84432192172</Id>
  <IncidentDate>2026-10-01T00:59:32.9805191+01:00</IncidentDate>
  <LastUpdated>2026-10-01T00:59:32.9805191+01:00</LastUpdated>
  <Manufacturer>sample string 7</Manufacturer>
  <MenuBrandName>sample string 8</MenuBrandName>
  <Model>sample string 9</Model>
  <Originator>sample string 3</Originator>
  <PartCount>22</PartCount>
  <PartNumbers>sample string 23</PartNumbers>
  <PolicyNumber>sample string 11</PolicyNumber>
  <Registration>sample string 12</Registration>
  <RepairerName>sample string 13</RepairerName>
  <SalvageCategory>sample string 14</SalvageCategory>
  <State>sample string 15</State>
  <Status>sample string 16</Status>
  <TotalLabourAmt>1</TotalLabourAmt>
  <TotalPartsAmt>1</TotalPartsAmt>
  <VehicleRegMonth>18</VehicleRegMonth>
  <VehicleRegYear>19</VehicleRegYear>
  <VehicleType>sample string 17</VehicleType>
  <VinInternationalUsed>true</VinInternationalUsed>
  <WorkProvider>sample string 5</WorkProvider>
  <WorkProviderCode>sample string 4</WorkProviderCode>
</AssessmentSummary>