Help Page Home

POST api/assessments?siteId={siteId}

Creates a new shell assessment.

Required Scopes

Assessment.EditAssessmentAdminData

Request Information

URI Parameters

NameDescriptionTypeAdditional information
siteId

integer

None.

Body Parameters

AssessmentImport
NameDescriptionTypeAdditional information
WorkProviderCode

integer

None.
Authorisation

AuthorisationImport

None.
Claim

ClaimImport

None.
DamageEstimate

DamageEstimateImport

None.
Contacts

Collection of Contact

None.
Policy

PolicyImport

None.
Vehicle

VehicleImport

None.

Request Formats

{
  "WorkProviderCode": 1,
  "Authorisation": {
    "RepairsAuthorised": 0
  },
  "Claim": {
    "DateBookedForRepair": "2026-10-01T01:00:24.437388+01:00",
    "VehicleAtInspectionSite": true,
    "RepairValue": 1.0,
    "DateOfInspection": "2026-10-01T01:00:24.437388+01:00",
    "DateOfAccidentUnknown": true,
    "DateOfDecision": "2026-10-01T01:00:24.437388+01:00",
    "DateOfAccident": "2026-10-01T01:00:24.437388+01:00",
    "ClaimNumber": "sample string 7",
    "RepairValueTBA": true,
    "OtherReference": "sample string 9"
  },
  "DamageEstimate": {
    "Rate": {
      "LabourRate": 1.0,
      "OverallDiscount": 1.1,
      "PaintIndex": 1.1,
      "PaintRate": 1.0,
      "PartsDiscountPcnt": 1.1,
      "PearlescentUpliftPcnt": 1.1
    }
  },
  "Contacts": [
    {
      "ContactType": 0,
      "AbleToAuthorise": 0,
      "Name": "sample string 1",
      "Title": "sample string 2",
      "Forename": "sample string 3",
      "Surname": "sample string 4",
      "EMailAddress": "sample string 5",
      "Line01": "sample string 6",
      "Line02": "sample string 7",
      "Line03": "sample string 8",
      "Line04": "sample string 9",
      "Line05": "sample string 10",
      "PostCode": "sample string 11",
      "TelHome": "sample string 12",
      "TelBusiness": "sample string 13",
      "TelMobile": "sample string 14",
      "TelOther": "sample string 15",
      "Fax": "sample string 16"
    },
    {
      "ContactType": 0,
      "AbleToAuthorise": 0,
      "Name": "sample string 1",
      "Title": "sample string 2",
      "Forename": "sample string 3",
      "Surname": "sample string 4",
      "EMailAddress": "sample string 5",
      "Line01": "sample string 6",
      "Line02": "sample string 7",
      "Line03": "sample string 8",
      "Line04": "sample string 9",
      "Line05": "sample string 10",
      "PostCode": "sample string 11",
      "TelHome": "sample string 12",
      "TelBusiness": "sample string 13",
      "TelMobile": "sample string 14",
      "TelOther": "sample string 15",
      "Fax": "sample string 16"
    }
  ],
  "Policy": {
    "ExcessValue": 1.0,
    "ExcessValueTBA": true,
    "PolicyNumber": "sample string 3",
    "VATPortionPayable": 4.1,
    "VATStatus": 0
  },
  "Vehicle": {
    "BodyColour": "sample string 1",
    "MonthOfRegistration": 1,
    "YearOfRegistration": 1,
    "Odometer": 1,
    "OdometerTBA": true,
    "Registration": "sample string 2",
    "Vin": "sample string 3",
    "FuelType": 0,
    "VehicleImported": 0
  }
}

<AssessmentImport xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Audatex.NextGen.Services.AssessmentServices.Import">
  <Authorisation>
    <RepairsAuthorised>Uninitialised</RepairsAuthorised>
  </Authorisation>
  <Claim>
    <ClaimNumber>sample string 7</ClaimNumber>
    <DateBookedForRepair>2026-10-01T01:00:24.437388+01:00</DateBookedForRepair>
    <DateOfAccident>2026-10-01T01:00:24.437388+01:00</DateOfAccident>
    <DateOfAccidentUnknown>true</DateOfAccidentUnknown>
    <DateOfDecision>2026-10-01T01:00:24.437388+01:00</DateOfDecision>
    <DateOfInspection>2026-10-01T01:00:24.437388+01:00</DateOfInspection>
    <OtherReference>sample string 9</OtherReference>
    <RepairValue>1</RepairValue>
    <RepairValueTBA>true</RepairValueTBA>
    <VehicleAtInspectionSite>true</VehicleAtInspectionSite>
  </Claim>
  <Contacts xmlns:d2p1="http://schemas.datacontract.org/2004/07/Audatex.NextGen.Common.AssessmentService.Model">
    <d2p1:Contact>
      <d2p1:AbleToAuthorise>Uninitialised</d2p1:AbleToAuthorise>
      <d2p1:ContactType>Uninitialised</d2p1:ContactType>
      <d2p1:EMailAddress>sample string 5</d2p1:EMailAddress>
      <d2p1:Fax>sample string 16</d2p1:Fax>
      <d2p1:Forename>sample string 3</d2p1:Forename>
      <d2p1:Line01>sample string 6</d2p1:Line01>
      <d2p1:Line02>sample string 7</d2p1:Line02>
      <d2p1:Line03>sample string 8</d2p1:Line03>
      <d2p1:Line04>sample string 9</d2p1:Line04>
      <d2p1:Line05>sample string 10</d2p1:Line05>
      <d2p1:Name>sample string 1</d2p1:Name>
      <d2p1:PostCode>sample string 11</d2p1:PostCode>
      <d2p1:Surname>sample string 4</d2p1:Surname>
      <d2p1:TelBusiness>sample string 13</d2p1:TelBusiness>
      <d2p1:TelHome>sample string 12</d2p1:TelHome>
      <d2p1:TelMobile>sample string 14</d2p1:TelMobile>
      <d2p1:TelOther>sample string 15</d2p1:TelOther>
      <d2p1:Title>sample string 2</d2p1:Title>
    </d2p1:Contact>
    <d2p1:Contact>
      <d2p1:AbleToAuthorise>Uninitialised</d2p1:AbleToAuthorise>
      <d2p1:ContactType>Uninitialised</d2p1:ContactType>
      <d2p1:EMailAddress>sample string 5</d2p1:EMailAddress>
      <d2p1:Fax>sample string 16</d2p1:Fax>
      <d2p1:Forename>sample string 3</d2p1:Forename>
      <d2p1:Line01>sample string 6</d2p1:Line01>
      <d2p1:Line02>sample string 7</d2p1:Line02>
      <d2p1:Line03>sample string 8</d2p1:Line03>
      <d2p1:Line04>sample string 9</d2p1:Line04>
      <d2p1:Line05>sample string 10</d2p1:Line05>
      <d2p1:Name>sample string 1</d2p1:Name>
      <d2p1:PostCode>sample string 11</d2p1:PostCode>
      <d2p1:Surname>sample string 4</d2p1:Surname>
      <d2p1:TelBusiness>sample string 13</d2p1:TelBusiness>
      <d2p1:TelHome>sample string 12</d2p1:TelHome>
      <d2p1:TelMobile>sample string 14</d2p1:TelMobile>
      <d2p1:TelOther>sample string 15</d2p1:TelOther>
      <d2p1:Title>sample string 2</d2p1:Title>
    </d2p1:Contact>
  </Contacts>
  <DamageEstimate>
    <Rate>
      <LabourRate>1</LabourRate>
      <OverallDiscount>1.1</OverallDiscount>
      <PaintIndex>1.1</PaintIndex>
      <PaintRate>1</PaintRate>
      <PartsDiscountPcnt>1.1</PartsDiscountPcnt>
      <PearlescentUpliftPcnt>1.1</PearlescentUpliftPcnt>
    </Rate>
  </DamageEstimate>
  <Policy>
    <ExcessValue>1</ExcessValue>
    <ExcessValueTBA>true</ExcessValueTBA>
    <PolicyNumber>sample string 3</PolicyNumber>
    <VATPortionPayable>4.1</VATPortionPayable>
    <VATStatus>Uninitialised</VATStatus>
  </Policy>
  <Vehicle>
    <BodyColour>sample string 1</BodyColour>
    <FuelType>Uninitialised</FuelType>
    <MonthOfRegistration>1</MonthOfRegistration>
    <Odometer>1</Odometer>
    <OdometerTBA>true</OdometerTBA>
    <Registration>sample string 2</Registration>
    <VehicleImported>Yes</VehicleImported>
    <Vin>sample string 3</Vin>
    <YearOfRegistration>1</YearOfRegistration>
  </Vehicle>
  <WorkProviderCode>1</WorkProviderCode>
</AssessmentImport>

Response Information

Resource Description

IHttpActionResult

None.

Response Formats