API Integration
Our API enables sales companies to seamlessly consume repository data and viewing analytics in real-time, ensuring up-to-date information in their databases.
With endpoints for retrieving sales lists and associated studies, our API supports comprehensive data access and management.
Overview
The below information document describes the endpoints and methods for the Sales API. The API allows clients to get a list of sales and associated studies. Bearer token authentication is required for all endpoints.
Authentication
All requests must include a valid bearer token in the authorisation header.
Endpoints
API - https://api.thoroughrepository.com
1. /api/Inspections/sales
Method: GET
-
Description: Retrieves a list of all sales.
-
Request Header:
-
Authorization: Bearer <token>
-
Responses:
-
200 OK: Successfully retrieved list of studies.
-
Body: List of sale objects.
-
-
401 Unauthorised: Missing or invalid authentication token.
-
400 Bad Request
OK (200) Response Example
2. /api/Inspections/{saleId}/viewlog
Method: GET
-
Description: Retrieves a list of studies associated with a specific sale.
-
Request Header:
-
Authorization: Bearer <token>
-
-
Path Parameters:
-
saleId (string): The ID of the sale.
-
Responses:
-
200 OK: Successfully retrieved list of studies.
-
Body: Array of study viewing log objects.
-
-
401 Unauthorised: Missing or invalid authentication token.
-
400 Bad Request
OK (200) Response Example
