FEATURE

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.

< BACK
API

Overview

The API allows sales companies to push all repository data and viewing analytics to their database in real-time. By integrating with ThoroughRepository, sales companies can effortlessly manage and analyze their data.

VIEW API SPEC DOC

Sale Company Api Specifications

Overview

This 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 Authorization 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 Unauthorized: Missing or invalid authentication token.
  • 400 Bad Request

OK (200) Response Example

 

[

  {

    "saleId": "string",

    "saleName": "string"

  }

]

 

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 Unauthorized: Missing or invalid authentication token.
  • 400 Bad Request

OK (200) Response Example

 

[

  {

    "saleEntryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

    "consignorId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

    "lotNumber": "string",

    "userFullName": "string",

    "consignorName": "string",

    "organizationName": "string",

    "viewingDateTime": "2024-07-18T03:13:27.025Z",

    "clientName": "string",

    "wasViewedOnline": true,

    "xRayDuration": "string",

    "videoDuration": "string",

    "saleName": "string",

    "location": "string",

    "saleImageUrl": "string",

    "startDate": "2024-07-18T03:13:27.025Z"

  }

]