Manuals

You can use this dedicated endpoint to fetch all manuals for a specific model. Alternatively, you can fetch all manuals for a model from the Model Details endpoint.

Endpoint

{{base_url}}/gateway/{{partner}}/oems/{{oem}}/manuals

Example URL

Get manuals for model with UUID 4700F488-63A8-43CE-9F73-49B7D59BE3BE

https://test.hub.bluontoolbox.com/uat/gateway/partner123/oems/4700F488-63A8-43CE-9F73-49B7D59BE3BE/manuals

Example Curl

curl -X 'GET' \
  'https://test.hub.bluontoolbox.com/uat/gateway/partner123/oems/4700F488-63A8-43CE-9F73-49B7D59BE3BE/manuals' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer [YOUR_TOKEN]' \
  -H 'X-CSRF-TOKEN: '

Example Response

{
  "data": [
    {
      "id": "E70F882C-AD7A-46C4-8533-61668987D8C5",
      "url": "https://assets-bluon-prod.sfo3.cdn.digitaloceanspaces.com/oems/service_facts/b3fb8bc9-9a1d-46cd-9902-bf2670f537c9/GM_GSX_PS_RS6200006r62_2015.pdf",
      "type": "service_facts",
      "description": "Service Facts",
      "url_preview_image": "https://api-uat.sfo3.digitaloceanspaces.com/112390/GM_GSX_PS_RS6200006r62_2015.png",
      "total_pages": 285
    },
    {
      "id": "7D6F373C-DA15-43A0-B2E4-93DA8AD1B555",
      "url": "https://assets-bluon-prod.sfo3.cdn.digitaloceanspaces.com/oems/iom/adbc01f3-6d80-4fca-8b1e-54da5997bb04/gsx_series.pdf",
      "type": "iom",
      "description": "IOM",
      "url_preview_image": "https://api-uat.sfo3.digitaloceanspaces.com/113518/gsx_series.png",
      "total_pages": 12
    },
    {
      "id": "A282CBB6-A7E5-41ED-9A51-FD9094BDEB41",
      "url": "https://assets-bluon-prod.sfo3.cdn.digitaloceanspaces.com/oems/wiring_diagram/05787efa-9256-4ef7-8c1a-e4366303ddc8/GM_GSX_PS_RS6200006r62_2015_Wiring.pdf",
      "type": "wiring_diagram",
      "description": "Wiring Diagram",
      "url_preview_image": "https://api-uat.sfo3.digitaloceanspaces.com/117923/GM_GSX_PS_RS6200006r62_2015_Wiring.png",
      "total_pages": 3
    }
  ]
}

Parameters

NameTypeRequiredDescription
{partner}string (path)requiredyour partner slug
oemstring (path)requiredmodel UUID

Types of Manuals

Here's the types of documentation we provide (where available)

IOMInstallation, Operation, and Maintenance
DiagnosticTroubleshooting
Operation ManualOperating Instructions
Product DataProduct Specifications
Parts ManualsDocs for compressors, boards, t-stats, etc
Controls ManualsDocs for controls, including programming manuals
Owner's ManualOwner's Manual
Wiring DiagramExtracted for convenience
Service FactsService Information
Service BulletinsNotes from the OEM
MiscAccessories, submittals, supplements, brochures, etc.