Additional topics
InternalData
Represents internal data.
| API | Description |
|---|---|
| GET api/internal/assessment/{assessmentId}/images/{imageId}?companyId={companyId} |
Get a specific image. |
| GET api/internal/assessment/{id}?companyId={companyId} |
Get a specific assessment. |
| GET api/internal/search?vehicleRegistration={vehicleRegistration} |
Get a list of internal data relating to a specific vehicle registration. Note: the registration number must be 3 or more characters in length. |
| GET api/internal/summarysearch?vehicleRegistration={vehicleRegistration} |
Get a list of internal data relating to a specific vehicle registration. Note: the registration number must be 3 or more characters in length. |
| POST api/internal/search/restricted?vehicleRegistration={vehicleRegistration} |
Get a list of internal data relating to a specific vehicle registration. Note: the registration number must be 3 or more characters in length. |
| POST api/internal/search?vehicleRegistration={vehicleRegistration} |
Get a list of internal data relating to a specific vehicle registration. Note: the registration number must be 3 or more characters in length. |
| POST api/internal/summarysearch?vehicleRegistration={vehicleRegistration} |
Get a list of internal data relating to a specific vehicle registration. Note: the registration number must be 3 or more characters in length. |
Workprovider
Represents work providers.
| API | Description |
|---|---|
| GET api/workproviders |
Get configured workproviders. |
| GET api/workproviders/{id} |
Get details about a specific workprovider. |
Company
Represents registered companies; including all systems (e.g. AudaEnterpriseGold, Invoice, Audit, AudaLite, etc.)
| API | Description |
|---|---|
| GET api/companies |
Get a list of all companies registered on the system. |
| GET api/companies/{id} |
Get information about a specific company registered with Solera. |
Terminal
Represents terminals.
| API | Description |
|---|---|
| GET api/sites |
Get details about a company's' sites. |
| GET api/sites/{siteId} |
Get details about a specific site. |
| GET api/users/{id}/terminals |
Gets all the terminals belonging to the specified user. |
Vehicle
For Access to vehicle information by VRN and VIN
| API | Description |
|---|---|
| GET api/vehicle/vin/{vinumber} |
Returns Vehicle Information using VIN Plus - UK |
| GET api/vehicle/vin/{vinumber}/detailed |
Returns Detailed Vehicle Information using VIN Plus |
| GET api/vehicle/vin/{vinumber}/paintcode |
Returns PaintCode Details using VIN Plus - UK |
| GET api/vehicle/vrn/{vehicleRegistration} |
Returns Vehicle Information Note: the registration number must be 3 or more characters in length. |
| POST api/vehicle/valuation |
Returns the CAP valuation for the specified registration and mileage |
| API | Description |
|---|---|
| GET api/mails/{mailId}/report |
Retrieve an AudaMail as a PDF report |
History
Represents claims history for a given car registration.
| API | Description |
|---|---|
| GET api/history?vehicleRegistration={vehicleRegistration} |
Returns the history for a specific vehiclde registration. Note: the registration number must be 3 or more characters in length. |
Supplier
Represents suppliers.
| API | Description |
|---|---|
| DELETE api/users/suppliers/registered/{id} |
De-register a supplier. |
| GET api/users/suppliers/{id} |
Get a specific supplier. |
| GET api/users/suppliers/all |
Get all suppliers. |
| GET api/users/suppliers/registered |
Get all registered suppliers |
| POST api/users/suppliers/{id} |
Create a new supplier. |
| POST api/users/suppliers/{id}/visibility/{visible} |
Set wether a supplier should be hidden from repairers in InPart |
| POST api/users/suppliers/registered/{id}/{status} |
Update the status of a registered supplier. |
| POST api/users/suppliers/registered/{id}?siteId={siteId}&erpId={erpId} |
Register a supplier site. Note: if a supplier site already exists with that ID, the existing record will be updated. |
Notification
Provides access to system notifications and resources to manage subscriptions to notification topics.
| API | Description |
|---|---|
| DELETE api/notifications/subscriptions/{id} |
Delete a subscription |
| GET api/notifications/{subscriptionId} |
Get Notifications for this subscription |
| GET api/notifications/subscriptions |
Get all active subscriptions. |
| GET api/notifications/topics |
Get all topics that can be subscribed to. |
| POST api/notifications/pushsubscriptions |
Create a new push subscription to the specified topic. The subscription can also be used to poll for notifications to allow recovery after downtime on the recieving service. |
| POST api/notifications/raise |
No documentation available. |
| POST api/notifications/subscriptions |
Create a new subscription to the specified topic. |
Calculation
Represents all assessment calculations.
| API | Description |
|---|---|
| GET api/assessments/{id}/calculations |
Get all calculations for a specified assessment. |
| GET api/calculations/{id} |
Get a calculation by its unique ID. |
PartsOrder
Represents parts and parts orders.
| API | Description |
|---|---|
| GET api/parts/orders/{id} |
Get details for a specific parts order. |
| POST api/parts/orders/{id} |
Update a specified parts order. |
| POST api/parts/orders/{id}/part/{partId}/{status} |
Change the status of a part in a given order. |
| POST api/parts/orders/{id}/status?status={status} |
Update the parts order status. |
| POST api/parts/orders/upload |
Upload a parts order. |
| POST api/parts/prices?supplierId={supplierId}&supplierRepairerReference={supplierRepairerReference}&vehicleBrand={vehicleBrand}&assessmentId={assessmentId} |
Get price for parts from a supplier |
User
Represents users, ie. individual user accounts within companies.
| API | Description |
|---|---|
| GET api/companies/{companyCode}/users |
Gets a list of users for the specified company. |
| GET api/users |
Gets a list of all users associated with the company to which the currently authenticated user belongs. |
| GET api/users/{id} |
Get information about a specified user. NOTE: The user being queried must belong to the same company as the calling user. |
| GET api/users/HasAccessPermission?applicationId={applicationId} |
To find if user have access to application specified |
Image
Represents images used for assessment image data.
| API | Description |
|---|---|
| GET api/assessments/{assessmentId}/images/{imageId} |
Get a specific image header for a given assessment. |
| GET api/assessments/{id}/images |
Get a list of images associated with the specified assessment. |
| GET api/assessments/{id}/images/{sequence} |
Get an image header for a given assessment and sequence number |
| GET api/images/{id} |
Get the binary image (JPEG format) for the specified image. |
| POST api/assessments/{id}/images |
Post a new image to a specific assessment. |
ReferenceData
| API | Description |
|---|---|
| GET api/reference/AssessmentLockResult |
Returns the complete list of AssessmentLockResult types |
| GET api/reference/AssessmentState |
Returns the complete list of AssessmentState types |
| GET api/reference/AssessmentType |
Returns the complete list of AssessmentType types |
| GET api/reference/AuthorisationStatus |
Returns the complete list of AuthorisationStatus types |
| GET api/reference/CalculationType |
Returns the complete list of CalculationType types |
| GET api/reference/ContactType |
Returns the complete list of ContactType types |
| GET api/reference/DamageArea |
Returns the complete list of DamageArea types |
| GET api/reference/DamageCondition |
Returns the complete list of DamageCondition types |
| GET api/reference/DamageSeverity |
Returns the complete list of DamageSeverity types |
| GET api/reference/ModelType |
Returns the complete list of ModelType types |
| GET api/reference/RepairMethod |
Returns the complete list of RepairMethod types |
| GET api/reference/VehicleType |
Returns the complete list of VehicleType types |
Assessment
Represents all valid assessments, assessment summaries, assessment full details, assessment searches and reassign functionality.
| API | Description |
|---|---|
| GET api/assessments/{assessmentId}/mails |
Get all mail messages for an assessment. |
| GET api/assessments/{assessmentId}/mails/{mailId} |
Get a specific mail message from an assessment. |
| GET api/assessments/{id} |
Get the specified assessment. Note: a lock will not be created on the assessment. |
| GET api/assessments/{id}/logs |
Get all event logs for the specified assessment. |
| GET api/assessments/{id}/modeloptions |
No documentation available. |
| 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. |
| GET api/assessments/vrn/{registration} |
Retrieves a list of assessments for the logged in user based upon the vehicle registration number supplied. |
| GET api/assessments?filterId={filterId}&userParameterValue={userParameterValue} |
Retrieves a list of assessments for the logged in user, ordered by the most recently updated first. Note: the list is limited to a maximum of 100 if no filter criterium is supplied. The optional FilterId and userParameterValue will be supplied by Audatex, the operational team can advise on existing filters or set up new ones if required. This method does not use the application default filter. |
| GET api/assessmentsV2?filterId={filterId}&userParameterValue={userParameterValue} |
Retrieves a list of assessments for the logged in user, ordered by the most recently updated first. Note: the list is limited to a maximum of 100 if no filter criterium is supplied. The optional FilterId and userParameterValue will be supplied by Audatex, the operational team can advise on existing filters or set up new ones if required. This method does not use the application default filter. Compared to the /assessments endpoint, this endpoint has performance improvements and the return object contains more fields. |
| POST api/assessments/{id}/complete |
Mark a specified assessment as complete. |
| POST api/assessments/{id}/summary |
Update the assessment with the posted values. Note: if the assessment is reassigned to a user that does not exist, an error will be returned. |
| POST api/assessments/close/{id}?obid={obid} |
No documentation available. |
| POST api/assessments/search |
Retrieves a list of assessments for the logged in user based upon the values in the search parameters supplied. Note: each set of search parameters will be applied to the result set that came before it. This method will use the default application filter, if one has been set up for the application. Valid FieldName in the Search Parameters are any of the elements in the assessment summary return object, for example : AssessmentNumber,Originator, CreationDate or Registration |
| POST api/assessments/searchv2 |
Retrieves a list of assessments for the logged in user based upon the values in the search parameters supplied. Note: each set of search parameters will be applied to the result set that came before it. This method will use the default application filter, if one has been set up for the application. Valid FieldName in the Search Parameters are any of the elements in the assessment summary return object, for example : AssessmentNumber,Originator, CreationDate or Registration |
| POST api/assessments/searchv3 |
Retrieves a list of assessments for the logged in user based upon the values in the search parameters supplied. Assessments will only be returned if they match all specified parameters, null and blank parameters are ignored. The LastUpdated range is restricted to 30 days This method will use the default application filter, if one has been set up for the application. |
| POST api/assessments?siteId={siteId} |
Creates a new shell assessment. |
AssessmentExport
Represents assessment export functionality.
| API | Description |
|---|---|
| GET api/assessments/{id}/exportAxFormat |
Exports an assessment in AxFormat. |
Filter
Represents available filters.
| API | Description |
|---|---|
| GET api/filters/{id} |
Get a specific filter. |
| GET api/filters/{id}/count |
Get the number of jobs and unread jobs in the specified filter available to the current user. |
| GET api/users/me/filters |
Get all filters for the currently logged in user. |
AssessmentImport
Represents assessment export functionality.
| API | Description |
|---|---|
| POST api/assessments/importAxFormat |
Import assessment from AxFormat string. |
| POST v2/api/assessments/importAxFormat |
Import assessment from AxFormat string. |
AssessmentReport
Represents assessment reporting on the system.
| API | Description |
|---|---|
| GET api/assessments/{id}/report?reportCode={reportCode} |
Gets a PDF report for an assessment. Note: this does not create a lock on the assessment. |
| GET api/reports |
Get a list of report definitions for the GET /api/assessments/{id}/report endpoint. |
TotalLoss
| API | Description |
|---|---|
| GET api/tla/cancelQuote/{quoteId} |
No documentation available. |
| GET api/tla/canQuote/{assessmentId} |
No documentation available. |
| POST api/tla/requestQuote |
No documentation available. |
| POST api/tla/updateQuote |
No documentation available. |