openapi: 3.1.0 info: version: 0.48.24 termsOfService: https://www.decisiv.com/terms-of-use contact: name: Decisiv Support email: support@decisiv.com url: https://www.decisiv.com title: Asset Management description: Inside of **Decisiv SRM Gateway**, the `Asset Management` module represents all interactions and functionality which an Account registered with a `Fleet subscription` can perform through an API interface. license: name: Proprietary identifier: proprietary url: https://www.decisiv.com/terms-of-use/ servers: - url: https://srm-api.staging.decisivapps.com - url: https://srm-api.decisivapps.com security: - OAuth2AuthorizationCode: [] AccessToken: [] - OAuth2Password: [] AccessToken: [] paths: /asset_management/{srm_account_id}/v1/case_summaries: get: operationId: listCaseSummaries summary: List all case summaries for the requested account description: Returns summaries of case activity. Use the `include=case` parameter to sideload the full case resource alongside each summary. tags: - Case Summaries parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: filter[service_provider.external_reference.srm_account] in: query required: false schema: type: string description: Filter case summaries by the specified service provider SRM account identifier - name: filter[updated_at:gt] in: query required: false schema: type: string description: Timebased filter to list case summaries updated _greater than_ a specified `ISO8601` timestamp. - name: filter[updated_at:gte] in: query required: false schema: type: string description: Timebased filter to list case summaries updated _greater than or equal to_ a specified `ISO8601` timestamp. - name: filter[updated_at:lt] in: query required: false schema: type: string description: Timebased filter to list case summaries updated _less than_ a specified `ISO8601` timestamp. - name: filter[updated_at:lte] in: query required: false schema: type: string description: Timebased filter to list case summaries updated _less than or equal to_ a specified `ISO8601` timestamp. - name: page[number] in: query required: false schema: type: number description: Sets the desired `page` when encountering larger result sets - name: page[size] in: query required: false schema: type: number description: Sets the desired maximum number of results per page - name: include in: query required: false schema: type: array items: type: string enum: - case description: The relationships to be included. responses: '200': description: Returns list of case summaries for the account content: application/vnd.api+json: example: data: - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 type: case_summaries attributes: content: Vehicle arrived with check engine light on. Diagnosed as faulty O2 sensor. Replaced and cleared codes. created_at: '2025-04-07T18:58:31Z' updated_at: '2025-04-07T18:58:31Z' relationships: case: data: type: cases id: e3dd4797-3215-4522-a2a8-7f3ccdb1fd44 schema: $ref: '#/components/schemas/case_summaries' '400': description: This response may occur when an invalid request has been provided to the server. The request may be corrected by the consumer and resubmitted. content: application/vnd.api+json: example: errors: - title: Filter not allowed detail: '''{{filter_name}}'' is not allowed. Valid filters: {{filters_list}}' code: decisiv:filters:001 status: '400' source: parameter: filter[filter_name] schema: $ref: '#/components/schemas/errors_response' '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - status: '404' code: decisiv:resource:001 title: Resource Identifier - Not Found detail: The parent resource could not be found source: parameter: id schema: $ref: '#/components/schemas/errors_response' '424': description: This response may occur when there is an unresolved data dependency or configuration required inside of the Decisiv Platform preventing access to the requested action. content: application/vnd.api+json: example: errors: - title: Failed Dependency detail: Failed Dependency code: '424' status: '424' schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' /asset_management/{srm_account_id}/v1/cases: get: operationId: listCases description: Returns a list of cases for the requested account. summary: List all Case for the requested account tags: - Cases parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: filter[event_timestamps.started_at:lt] in: query required: false schema: type: string description: Timebased filter to list cases started _less than_ a specified `ISO8601` timestamp. - name: filter[event_timestamps.started_at:lte] in: query required: false schema: type: string description: Timebased filter to list cases started _less than or equal to_ a specified `ISO8601` timestamp. - name: filter[event_timestamps.started_at:gt] in: query required: false schema: type: string description: Timebased filter to list cases started _greater than_ a specified `ISO8601` timestamp. - name: filter[event_timestamps.started_at:gte] in: query required: false schema: type: string description: Timebased filter to list cases started _greater than or equal to_ a specified `ISO8601` timestamp. - name: filter[updated_at:gte] in: query required: false schema: type: string format: date-time description: Filter cases last updated _on or after_ the specified `ISO 8601` datetime. - name: filter[updated_at:lte] in: query required: false schema: type: string format: date-time description: Filter cases last updated _on or before_ the specified `ISO 8601` datetime. - name: filter[registered_asset.id] in: query required: false schema: type: string pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ minLength: 36 maxLength: 36 description: Filter cases based upon the specified `Registered Asset` identifier - name: filter[service_provider.id] in: query required: false schema: type: string pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ minLength: 36 maxLength: 36 description: Filter cases based upon the specified `Service Provider` identifier - name: filter[service_provider.external_reference.srm_account] in: query required: false schema: type: string description: Filter cases based upon the specified `Service Provider` srm account identifier - name: filter[event_timestamps.closed_at:exists] in: query required: false schema: type: boolean description: Filter cases by whether a `closed_at` timestamp exists. Use `true` to list only closed cases, or `false` to list only open cases. Must be paired up with either a registered_asset.id filter, a timebased filter, or a service_provider.id filter. - name: filter[closed] in: query required: false deprecated: true schema: type: string description: '**Deprecated** — use `filter[event_timestamps.closed_at:exists]` instead. Filters cases for the given closed, using `true` or `false` for exact matching search. Required to be paired up with either a registered_asset.id filter, a timebased filter, or a service_provider.id filter.' - name: page[number] in: query required: false schema: type: number description: Sets the desired `page` when encountering larger result sets - name: page[size] in: query required: false schema: type: number description: Sets the desired maximum number of results per page - name: include in: query required: false schema: type: array items: type: string enum: - registered_asset - service_provider - estimates - billing_contact - primary_contact description: The relationships to be included. responses: '200': description: Returns list of cases content: application/vnd.api+json: example: data: - id: e3dd4797-3215-4522-a2a8-7f3ccdb1fd44 type: cases attributes: complaint: Check Engine Light continually on invoice: total: 0 number: TR-91324 invoice_date: '2025-04-07' po_number: THX1138 auth_number: FLT2112 ro_number: RO1888 reference_number: 18328893 closed: false repair_status: Diagnosing status: Drop-off event_timestamps: started_at: '2025-04-07T18:58:31Z' requested_appointment_time: '2025-04-07T17:20:31Z' requested_completion_time: '2025-04-07T17:20:31Z' actual_time_to_repair: '2025-04-07T17:20:31Z' estimated_time_to_repair: '2025-04-07T17:20:31Z' followup_time: '2025-04-07T19:58:31Z' asset_arrived: '2025-04-07T16:58:31Z' asset_checked_in: '2025-04-07T17:20:31Z' closed_at: '2025-04-07T17:20:31Z' asset_uptime: '2025-04-07T17:20:31Z' asset_downtime: '2025-04-06T18:58:31Z' asset_information: odometer_value: 61342 odometer_unit: mi unit_number: 42X cargo: unit: null loaded: false load: null breakdown: location: outside Seneca Lodge city: Watkins Glen state: NY created_at: '2025-04-07T18:58:31Z' updated_at: '2025-04-07T18:58:31Z' relationships: estimates: data: [] registered_asset: data: type: registered_assets id: 552fb6b4-bbce-452b-bb60-8f40ca6e8eb3 service_provider: data: type: service_providers id: 49babff7-536d-4262-b267-de66a19452cf assignee: data: type: internal_users id: d60717e2-e303-11ea-86c2-1f9b5bc5281b billing_contact: data: type: contacts id: 3f2a1c9e-6b4d-4e2a-9c1a-7d5f8e2b9a10 primary_contact: data: type: contacts id: 9b6e2b7d-1f4a-4b8e-9d3c-5a7f0e2c8b41 schema: $ref: '#/components/schemas/cases' '400': description: This response may occur when an invalid request has been provided to the server. The request may be corrected by the consumer and resubmitted. content: application/vnd.api+json: example: errors: - title: Filter not allowed detail: '''{{filter_name}}'' is not allowed. Valid filters: {{filters_list}}' code: decisiv:filters:001 status: '400' source: parameter: filter[filter_name] - code: decisiv:filters:010 title: Invalid filter value detail: Invalid filter value `{{invalid_filter}}`. Expected an ISO 8601 timestamp. status: '400' source: parameter: filter[event_timestamps.started_at:gte] schema: $ref: '#/components/schemas/errors_response' '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - status: '404' code: decisiv:resource:001 title: Resource Identifier - Not Found detail: The parent resource could not be found source: parameter: id schema: $ref: '#/components/schemas/errors_response' '424': description: This response may occur when there is an unresolved data dependency or configuration required inside of the Decisiv Platform preventing access to the requested action. content: application/vnd.api+json: example: errors: - title: Failed Dependency detail: Failed Dependency code: '424' status: '424' schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' /asset_management/{srm_account_id}/v1/cases/{id}: get: operationId: getCase description: Returns details for a specific case. summary: List details on a specific case tags: - Cases parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: id in: path description: The resource uuid required: true schema: type: string - name: include in: query required: false schema: type: array items: type: string enum: - registered_asset - service_provider - estimates - billing_contact - primary_contact description: The relationships to be included. responses: '200': description: Show details for requested case content: application/vnd.api+json: example: data: id: e3dd4797-3215-4522-a2a8-7f3ccdb1fd44 type: cases attributes: complaint: Check Engine Light continually on invoice: total: 0 number: TR-91324 invoice_date: '2025-04-07' po_number: THX1138 auth_number: FLT2112 ro_number: RO1888 reference_number: 18328893 closed: false repair_status: Diagnosing status: Drop-off event_timestamps: started_at: '2025-04-07T18:58:31Z' requested_appointment_time: '2025-04-07T17:20:31Z' requested_completion_time: '2025-04-07T17:20:31Z' actual_time_to_repair: '2025-04-07T17:20:31Z' estimated_time_to_repair: '2025-04-07T17:20:31Z' followup_time: '2025-04-07T19:58:31Z' asset_arrived: '2025-04-07T16:58:31Z' asset_checked_in: '2025-04-07T17:20:31Z' closed_at: '2025-04-07T17:20:31Z' asset_uptime: '2025-04-07T17:20:31Z' asset_downtime: '2025-04-06T18:58:31Z' asset_information: odometer_value: 61342 odometer_unit: mi unit_number: 42X cargo: unit: null loaded: false load: null breakdown: location: outside Seneca Lodge city: Watkins Glen state: NY created_at: '2025-04-07T18:58:31Z' updated_at: '2025-04-07T18:58:31Z' relationships: estimates: data: [] registered_asset: data: type: registered_assets id: 552fb6b4-bbce-452b-bb60-8f40ca6e8eb3 service_provider: data: type: service_providers id: 49babff7-536d-4262-b267-de66a19452cf assignee: data: type: internal_users id: d60717e2-e303-11ea-86c2-1f9b5bc5281b billing_contact: data: type: contacts id: 3f2a1c9e-6b4d-4e2a-9c1a-7d5f8e2b9a10 primary_contact: data: type: contacts id: 9b6e2b7d-1f4a-4b8e-9d3c-5a7f0e2c8b41 schema: $ref: '#/components/schemas/case' '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - status: '404' code: decisiv:resource:001 title: Resource Identifier - Not Found detail: The parent resource could not be found source: parameter: id schema: $ref: '#/components/schemas/errors_response' '424': description: This response may occur when there is an unresolved data dependency or configuration required inside of the Decisiv Platform preventing access to the requested action. content: application/vnd.api+json: example: errors: - title: Failed Dependency detail: Failed Dependency code: '424' status: '424' schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' patch: operationId: updateCase description: Updates the specified case with the provided attributes. summary: Updates a case tags: - Cases parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: id in: path description: The resource uuid required: true schema: type: string responses: '200': description: Show the case updated content: application/vnd.api+json: example: data: id: e3dd4797-3215-4522-a2a8-7f3ccdb1fd44 type: cases attributes: complaint: Check Engine Light continually on invoice: total: 0 number: TR-91324 invoice_date: '2025-04-07' po_number: THX1138 auth_number: FLT2112 ro_number: RO1888 reference_number: 18328893 closed: false repair_status: Diagnosing status: Drop-off event_timestamps: started_at: '2025-04-07T18:58:31Z' requested_appointment_time: '2025-04-07T17:20:31Z' requested_completion_time: '2025-04-07T17:20:31Z' actual_time_to_repair: '2025-04-07T17:20:31Z' estimated_time_to_repair: '2025-04-07T17:20:31Z' followup_time: '2025-04-07T19:58:31Z' asset_arrived: '2025-04-07T16:58:31Z' asset_checked_in: '2025-04-07T17:20:31Z' closed_at: '2025-04-07T17:20:31Z' asset_uptime: '2025-04-07T17:20:31Z' asset_downtime: '2025-04-06T18:58:31Z' asset_information: odometer_value: 61342 odometer_unit: mi unit_number: 42X cargo: unit: null loaded: false load: null breakdown: location: outside Seneca Lodge city: Watkins Glen state: NY created_at: '2025-04-07T18:58:31Z' updated_at: '2025-04-07T18:58:31Z' relationships: estimates: data: [] registered_asset: data: type: registered_assets id: 552fb6b4-bbce-452b-bb60-8f40ca6e8eb3 service_provider: data: type: service_providers id: 49babff7-536d-4262-b267-de66a19452cf assignee: data: type: internal_users id: d60717e2-e303-11ea-86c2-1f9b5bc5281b billing_contact: data: type: contacts id: 3f2a1c9e-6b4d-4e2a-9c1a-7d5f8e2b9a10 primary_contact: data: type: contacts id: 9b6e2b7d-1f4a-4b8e-9d3c-5a7f0e2c8b41 schema: $ref: '#/components/schemas/case' '400': description: This response may occur when the request body is missing required keys (e.g. attributes hash) or when a relationship linkage's `type` is not one of `contacts`, `registered_contacts`, `recipients`. content: application/vnd.api+json: schema: $ref: '#/components/schemas/errors_response' examples: Missing required attribute key: value: errors: - status: '400' code: decisiv:request_attributes:001 title: Missing required attribute key detail: Required key not provided in request body source: pointer: /data/attributes Invalid resource type: value: errors: - status: '400' code: decisiv:resource:002 title: Resource type is invalid detail: Resource type is invalid source: pointer: /data/relationships/primary_contact/data/type '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - status: '404' code: decisiv:resource:001 title: Resource Identifier - Not Found detail: The parent resource could not be found source: parameter: id schema: $ref: '#/components/schemas/errors_response' '422': description: Immutable Attribute error / Attribute cannot be updated error / Invalid fleet status value / Contact relationship not found content: application/vnd.api+json: schema: $ref: '#/components/schemas/errors_response' examples: Immutable Attribute error: value: errors: - status: '422' title: Immutable Attribute detail: The resource attribute is immutable through this particular endpoint code: decisiv:request_attributes:005 source: pointer: /data/attributes/ro_number Attribute cannot be updated error: value: errors: - status: '422' title: Immutable Attribute detail: The resource attribute is immutable through this particular endpoint code: decisiv:request_attributes:005 source: pointer: /data/attributes/correction Invalid fleet status: value: errors: - status: '422' code: decisiv:request_attributes:010 title: Invalid Attribute Value detail: 'Invalid status value provided - value must be one of: Working, Pick-up, Drop-off, Complete, Hold (auth), Hold (parts), Hold (information)' source: pointer: /data/attributes/status Contact relationship not found: value: errors: - status: '422' code: decisiv:request_attributes:003 title: Identifier not found detail: Contact not found in database source: pointer: /data/relationships/billing_contact/data/id requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/update_case' examples: Case: value: data: id: e3dd4797-3215-4522-a2a8-7f3ccdb1fd44 type: cases attributes: complaint: Check Engine Light continually on po_number: THX1138 auth_number: FLT2112 status: Drop-off event_timestamps: followup_time: '2025-04-07T18:58:31Z' requested_completion_time: '2025-04-07T18:58:31Z' Case with contact relationships: value: data: id: e3dd4797-3215-4522-a2a8-7f3ccdb1fd44 type: cases attributes: complaint: Check Engine Light continually on po_number: THX1138 auth_number: FLT2112 status: Drop-off relationships: billing_contact: data: type: contacts id: 7da042d2-c47b-4748-ba65-c114adf1cf62 primary_contact: data: type: recipients id: 462d54f5-a1a1-48b5-ac0f-2068259105df /asset_management/{srm_account_id}/v1/cases/{case_id}/attachments: get: operationId: listCaseAttachments description: Returns a list of attachments for the specified case. summary: List all attachments for the requested case tags: - Case Attachments parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: case_id in: path description: The case uuid required: true schema: type: string - name: page[number] in: query required: false schema: type: number description: Sets the desired `page` when encountering larger result sets - name: page[size] in: query required: false schema: type: number description: Sets the desired maximum number of results per page - name: include in: query required: false schema: type: array items: type: string enum: - publisher - subject description: The relationships to be included. responses: '200': description: Returns list of attachments for the case content: application/vnd.api+json: example: data: - id: 0cc1a623-54ec-4e35-83b6-9125657a1baa type: attachments attributes: description: The estimate pdf filename: estimate.pdf size: 123456 format: application/pdf download_url: https://decisiv.net/download_url created_at: '2023-10-01T12:00:00Z' updated_at: '2023-10-01T12:00:00Z' relationships: publisher: data: type: users id: ed1641a8-fa41-478a-bd2e-dd72013096b0 subject: data: type: cases id: e3dd4797-3215-4522-a2a8-7f3ccdb1fd44 schema: $ref: '#/components/schemas/attachments' '400': description: This response may occur when an invalid request has been provided to the server. The request may be corrected by the consumer and resubmitted. content: application/vnd.api+json: example: errors: - title: Filter not allowed detail: '''{{filter_name}}'' is not allowed. Valid filters: {{filters_list}}' code: decisiv:filters:001 status: '400' source: parameter: filter[filter_name] schema: $ref: '#/components/schemas/errors_response' '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - status: '404' code: decisiv:resource:001 title: Resource Identifier - Not Found detail: The parent resource could not be found source: parameter: id schema: $ref: '#/components/schemas/errors_response' '424': description: This response may occur when there is an unresolved data dependency or configuration required inside of the Decisiv Platform preventing access to the requested action. content: application/vnd.api+json: example: errors: - title: Failed Dependency detail: Failed Dependency code: '424' status: '424' schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' post: operationId: createCaseAttachment description: Creates an attachment for the specified case. summary: Creates an attachment for the requested case tags: - Case Attachments parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: case_id in: path description: The case ID required: true schema: type: string - name: X-DECISIV-SILENCE-EVENTS in: header required: false schema: type: array items: type: string enum: - decisiv:asset_management:case:attachment_posted description: Corresponding webhook events which can be muted for the given transaction responses: '201': description: Created an attachment for the case content: application/vnd.api+json: example: data: id: 0cc1a623-54ec-4e35-83b6-9125657a1baa type: attachments attributes: description: The estimate pdf filename: estimate.pdf size: 123456 format: application/pdf download_url: https://decisiv.net/download_url created_at: '2023-10-01T12:00:00Z' updated_at: '2023-10-01T12:00:00Z' relationships: publisher: data: type: users id: ed1641a8-fa41-478a-bd2e-dd72013096b0 subject: data: type: cases id: e3dd4797-3215-4522-a2a8-7f3ccdb1fd44 schema: $ref: '#/components/schemas/attachment' '400': description: Invalid event name to silence / Invalid request attribute / Filename extension does not match / Invalid attribute value content: application/vnd.api+json: schema: $ref: '#/components/schemas/errors_response' examples: Invalid event name to silence: value: errors: - title: Bad Request detail: Invalid value for X-DECISIV-SILENCE-EVENTS header code: decisiv:silence_webhook_events:001 status: '400' Invalid request attribute: value: errors: - status: '400' code: decisiv:request_attributes:009 title: Attribute Not Allowed detail: invalid_attribute is not allowed source: pointer: /data/attributes/invalid_attribute Filename extension does not match: value: errors: - status: '400' code: decisiv:attachments:003 title: Filename extension does not match detail: Filename extension does not match the actual filename. source: pointer: /data/attributes/filename Invalid attribute value: value: errors: - status: '400' code: decisiv:request_attributes:010 title: Invalid Attribute Value detail: Invalid {{attribute_name}} value provided - {{reason}} source: pointer: /data/attributes/{{attribute_name}} '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - status: '404' code: decisiv:resource:001 title: Resource Identifier - Not Found detail: The parent resource could not be found source: parameter: id schema: $ref: '#/components/schemas/errors_response' requestBody: content: multipart/form-data: schema: type: object properties: body: type: string description: 'Data to be sent as a body. **Example:** * {"data": {"type": "attachments","attributes": { "description": "This is a description", "filename": "filename.txt"},"relationships": { "subject": {"data": { "type": "cases", "id": "287b52ce-6429-4319-b8ef-2c3042acfd82"}}}}}}* ' file: type: string format: binary description: File to be uploaded application/vnd.api+json: schema: $ref: '#/components/schemas/create_attachment' examples: Attachment with URL: value: data: type: attachments attributes: description: The estimate pdf url: https://decisiv.net/download_url /asset_management/{srm_account_id}/v1/cases/{case_id}/attachments/{id}: get: operationId: getCaseAttachment description: Returns details for a specific attachment of the specified case. summary: Get a specific attachment for the requested case tags: - Case Attachments parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: case_id in: path description: The case uuid required: true schema: type: string - name: id in: path description: The resource uuid required: true schema: type: string - name: page[number] in: query required: false schema: type: number description: Sets the desired `page` when encountering larger result sets - name: page[size] in: query required: false schema: type: number description: Sets the desired maximum number of results per page - name: include in: query required: false schema: type: array items: type: string enum: - publisher - subject description: The relationships to be included. responses: '200': description: Returns list of cases content: application/vnd.api+json: example: data: id: 0cc1a623-54ec-4e35-83b6-9125657a1baa type: attachments attributes: description: The estimate pdf filename: estimate.pdf size: 123456 format: application/pdf download_url: https://decisiv.net/download_url created_at: '2023-10-01T12:00:00Z' updated_at: '2023-10-01T12:00:00Z' relationships: publisher: data: type: users id: ed1641a8-fa41-478a-bd2e-dd72013096b0 subject: data: type: cases id: e3dd4797-3215-4522-a2a8-7f3ccdb1fd44 schema: $ref: '#/components/schemas/attachment' '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - status: '404' code: decisiv:resource:001 title: Resource Identifier - Not Found detail: The parent resource could not be found source: parameter: id schema: $ref: '#/components/schemas/errors_response' delete: operationId: deleteCaseAttachment description: Deletes an attachment for the specified case. summary: Delete an attachment for the requested case tags: - Case Attachments parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: case_id in: path description: The case uuid required: true schema: type: string - name: id in: path description: The resource uuid required: true schema: type: string responses: '204': description: Deletes an attachment content: {} '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: The resource is read-only and cannot be updated or deleted code: decisiv:resource:003 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - status: '404' code: decisiv:resource:001 title: Resource Identifier - Not Found detail: The parent resource could not be found source: parameter: id schema: $ref: '#/components/schemas/errors_response' /asset_management/{srm_account_id}/v1/contacts: get: operationId: listContacts description: Returns a list of contacts for the requested account. summary: List all Contacts for the fleet tags: - Contacts parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: filter[depot.id] in: query required: false schema: type: string description: List `contacts` belonging to the specified `depot`. - name: page[number] in: query required: false schema: type: number description: Page number - name: page[size] in: query required: false schema: type: number description: Page size - name: sort in: query required: false schema: type: string examples: Ascending: value: first_name summary: Single attribute ascending Descending: value: -first_name summary: Single attribute descending Multiple: value: -first_name,last_name summary: Multiple attributes combined description: 'Sort `contacts` by one or more attributes separated by commas; prefix with `-` for descending order. Valid attributes: `first_name`, `last_name`' - name: include in: query required: false schema: type: array items: type: string enum: - depot description: The relationships to be included. responses: '200': description: Returns list of contacts content: application/vnd.api+json: example: data: - id: 014ee85e-a183-4bf7-b4d7-67e758fa2b2a type: contacts attributes: first_name: John last_name: Doe address1: 9009 Sunset Blvd address2: Door 5 city: West Hollywood state: CA postal_code: '90069' country: US communication: - method_type: email value: john.doe@example.com notify: true - method_type: mobile value: '+1234567890' notify: true notes: Sample notes about the contact relationships: depot: data: id: 73814a82-d26c-4241-8421-a1a622ac9f71 type: depots schema: $ref: '#/components/schemas/contacts' '400': description: Account filter is missing / This response may occur when an invalid request has been provided to the server. The request may be corrected by the consumer and resubmitted. content: application/vnd.api+json: schema: $ref: '#/components/schemas/errors_response' examples: Account filter is missing: value: errors: - title: Required filter is missing detail: 'Required filter must be provided. Valid required filters: srm_account_id' code: decisiv:filters:006 status: '400' source: parameter: filter[srm_account_id] ? This response may occur when an invalid request has been provided to the server. The request may be corrected by the consumer and resubmitted. : value: errors: - title: Filter not allowed detail: '''{{filter_name}}'' is not allowed. Valid filters: {{filters_list}}' code: decisiv:filters:001 status: '400' source: parameter: filter[filter_name] '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '428': description: This response represents requests to a module or endpoint which can not immediately be accessed due to the Account permissions and subscriptions in the Decisiv Platform. content: application/vnd.api+json: example: errors: - status: '428' code: decisiv:access:003 title: Precondition required detail: OAuth Application does not have appropriate provisioning to access this resource schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' post: operationId: createContact description: Creates a new contact for the requested account. summary: Create a Contact tags: - Contacts parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string responses: '201': description: The request has been fulfilled and a new resource is available. content: application/vnd.api+json: example: data: id: 014ee85e-a183-4bf7-b4d7-67e758fa2b2a type: contacts attributes: first_name: John last_name: Doe address1: 9009 Sunset Blvd address2: Door 5 city: West Hollywood state: CA postal_code: '90069' country: US communication: - method_type: email value: john.doe@example.com notify: true - method_type: mobile value: '+1234567890' notify: true notes: Sample notes about the contact relationships: depot: data: id: 73814a82-d26c-4241-8421-a1a622ac9f71 type: depots schema: $ref: '#/components/schemas/contact' '400': description: Account filter is missing / Required key not provided / Required value not provided content: application/vnd.api+json: schema: $ref: '#/components/schemas/errors_response' examples: Account filter is missing: value: errors: - title: Required filter is missing detail: 'Required filter must be provided. Valid required filters: srm_account_id' code: decisiv:filters:006 status: '400' source: parameter: filter[srm_account_id] Required key not provided: value: errors: - status: '400' code: decisiv:request_attributes:001 title: Missing required attribute key detail: Required key not provided in request body source: pointer: /data/attributes/first_name Required value not provided: value: errors: - status: '400' code: decisiv:request_attributes:002 title: Missing required attribute value detail: Required key must be populated source: pointer: /data/attributes '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: Account not found content: application/vnd.api+json: example: errors: - status: '404' title: Record not found source: parameter: srm_account_id schema: $ref: '#/components/schemas/errors_response' '422': description: Email with invalid host / Email with long local part / Email with long domain part / Email with invalid format / Phone number does not begin with + / Phone number has whitespace in it / Phone number has invalid country code or does not conform with E.164 / Phone number has less than 3 chars / Phone number has more than 15 chars content: application/vnd.api+json: schema: $ref: '#/components/schemas/errors_response' examples: Email with invalid host: value: errors: - status: '422' code: decisiv:email:001 title: Invalid Email - Domain Resolution detail: Email domain name could not be resolved by DNS source: pointer: /data/attributes/communication/0/value Email with long local part: value: errors: - status: '422' code: decisiv:email:002 title: Invalid Email - Local Part Length detail: Local-part exceeds maximum length of 64 octets source: pointer: /data/attributes/communication/0/value Email with long domain part: value: errors: - status: '422' code: decisiv:email:003 title: Invalid Email - Domain Length detail: Email domain length exceeds 255 characters source: pointer: /data/attributes/communication/0/value Email with invalid format: value: errors: - status: '422' code: decisiv:email:004 title: Invalid Email - Invalid Syntax detail: Email address does not match correct syntax in RFC 3696 source: pointer: /data/attributes/communication/0/value Phone number does not begin with +: value: errors: - status: '422' code: decisiv:phone:001 title: Invalid Phone Format detail: Phone number must begin with a + character per E.164 standard source: pointer: /data/attributes/communication/1/value Phone number has whitespace in it: value: errors: - status: '422' code: decisiv:phone:002 title: Invalid Phone Format detail: Phone number can not contain spaces source: pointer: /data/attributes/communication/1/value Phone number has invalid country code or does not conform with E.164: value: errors: - status: '422' code: decisiv:phone:003 title: Invalid Phone Format detail: Phone number contains an invalid country code source: pointer: /data/attributes/communication/1/value Phone number has less than 3 chars: value: errors: - status: '422' code: decisiv:phone:004 title: Invalid Phone Format detail: Phone number length does not meet minimum length - must be 3 characters source: pointer: /data/attributes/communication/1/value Phone number has more than 15 chars: value: errors: - status: '422' code: decisiv:phone:005 title: Invalid Phone Format detail: Phone number length exceeds maximum length - can not be longer than 15 characters source: pointer: /data/attributes/communication/1/value '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/contact' examples: Create Contact: value: data: id: 014ee85e-a183-4bf7-b4d7-67e758fa2b2a type: contacts attributes: first_name: John last_name: Doe address1: 9009 Sunset Blvd address2: Door 5 city: West Hollywood state: CA postal_code: '90069' country: US communication: - method_type: email value: john.doe@example.com notify: true - method_type: mobile value: '+1234567890' notify: true notes: Sample notes about the contact relationships: depot: data: id: 73814a82-d26c-4241-8421-a1a622ac9f71 type: depots /asset_management/{srm_account_id}/v1/contacts/{id}: get: operationId: getContact description: Returns details for a specific contact. summary: Retrieves a Contact from the requested Customer tags: - Contacts parameters: - name: srm_account_id in: path required: true schema: type: string - name: id in: path schema: type: string format: uuid description: The resource UUID required: true - name: include in: query required: false schema: type: array items: type: string enum: - depot description: The relationships to be included. responses: '200': description: Returns a contact content: application/vnd.api+json: example: data: id: 014ee85e-a183-4bf7-b4d7-67e758fa2b2a type: contacts attributes: first_name: John last_name: Doe address1: 9009 Sunset Blvd address2: Door 5 city: West Hollywood state: CA postal_code: '90069' country: US communication: - method_type: email value: john.doe@example.com notify: true - method_type: mobile value: '+1234567890' notify: true notes: Sample notes about the contact relationships: depot: data: id: 73814a82-d26c-4241-8421-a1a622ac9f71 type: depots schema: $ref: '#/components/schemas/contact_by_id' '400': description: This response may occur when an invalid request has been provided to the server. The request may be corrected by the consumer and resubmitted. content: application/vnd.api+json: example: errors: - title: Required filter is missing detail: 'Required filter must be provided. Valid required filters: srm_account_id' code: decisiv:filters:006 status: '400' source: parameter: filter[srm_account_id] schema: $ref: '#/components/schemas/errors_response' '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - status: '404' title: Record not found source: parameter: srm_account_id schema: $ref: '#/components/schemas/errors_response' '428': description: This response represents requests to a module or endpoint which can not immediately be accessed due to the Account permissions and subscriptions in the Decisiv Platform. content: application/vnd.api+json: example: errors: - status: '428' code: decisiv:access:003 title: Precondition required detail: OAuth Application does not have appropriate provisioning to access this resource schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' patch: operationId: updateContact description: Updates the specified contact with the provided attributes. summary: Updates a Contact tags: - Contacts parameters: - name: srm_account_id in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: Show the updated Contact content: application/vnd.api+json: example: data: id: 014ee85e-a183-4bf7-b4d7-67e758fa2b2a type: contacts attributes: first_name: John last_name: Doe address1: 9009 Sunset Blvd address2: Door 5 city: West Hollywood state: CA postal_code: '90069' country: US communication: - method_type: email value: john.doe@example.com notify: true - method_type: mobile value: '+1234567890' notify: true notes: Sample notes about the contact relationships: depot: data: id: 73814a82-d26c-4241-8421-a1a622ac9f71 type: depots schema: $ref: '#/components/schemas/contact' '400': description: Path ID mismatch / This response may occur when an invalid request has been provided to the server. The request may be corrected by the consumer and resubmitted. content: application/vnd.api+json: schema: $ref: '#/components/schemas/errors_response' examples: Path ID mismatch: value: errors: - status: '400' code: decisiv:resource:002 title: Invalid JSON:API Resource specified in request detail: '''79327cde-d5ce-4ce6-bdba-eebab125ae2d'' is an invalid resource' source: pointer: /data/id ? This response may occur when an invalid request has been provided to the server. The request may be corrected by the consumer and resubmitted. : value: errors: - title: Required filter is missing detail: 'Required filter must be provided. Valid required filters: srm_account_id' code: decisiv:filters:006 status: '400' source: parameter: filter[srm_account_id] '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - status: '404' title: Record not found source: parameter: srm_account_id schema: $ref: '#/components/schemas/errors_response' '422': description: Extended Asset Attribute Association Exists content: application/vnd.api+json: example: errors: - status: '422' title: Extended Asset Attribute Association Exists detail: The extended asset attribute must be unique for the Extended Attribute and Customer Asset within your Account code: decisiv:extended_asset_attributes:001 source: pointer: /data/relationships schema: $ref: '#/components/schemas/errors_response' '428': description: This response represents requests to a module or endpoint which can not immediately be accessed due to the Account permissions and subscriptions in the Decisiv Platform. content: application/vnd.api+json: example: errors: - status: '428' code: decisiv:access:003 title: Precondition required detail: OAuth Application does not have appropriate provisioning to access this resource schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/contact' examples: Example: value: data: id: 487136d2-c4d6-424c-b018-f1ed8a740c6a type: contacts attributes: first_name: John last_name: Doe address1: 9009 Sunset Blvd address2: Door 5 city: West Hollywood state: CA postal_code: '90069' country: US communication: - method_type: email value: john.doe@example.com notify: true - method_type: mobile value: '+1234567890' notify: true notes: Sample notes about the contact relationships: depot: data: id: 73814a82-d26c-4241-8421-a1a622ac9f71 type: depots delete: operationId: deleteContact description: Deletes the specified contact. summary: Deletes a Contact tags: - Contacts parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: id in: path description: The ID of the Contact required: true schema: type: string responses: '204': description: Successful deletion content: {} '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - status: '404' title: Record not found source: parameter: srm_account_id schema: $ref: '#/components/schemas/errors_response' /asset_management/{srm_account_id}/v1/cases/{case_id}/notes: get: operationId: listCaseNotes description: Retrieves a paginated list of notes for the specified case. summary: List all notes for the requested case tags: - Case Notes parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: case_id in: path description: The case uuid required: true schema: type: string - name: page[number] in: query required: false schema: type: number description: Sets the desired `page` when encountering larger result sets - name: page[size] in: query required: false schema: type: number description: Sets the desired maximum number of results per page - name: include in: query required: false schema: type: array items: type: string enum: - sender - subject - recipients - participants description: The relationships to be included. responses: '200': description: Returns list of notes for the case content: application/vnd.api+json: examples: success: value: data: - id: 17cd5b9d-1f7b-480f-aebb-c72e5df56a0c type: notes attributes: message: This is my note public: false relationships: subject: data: type: cases id: e3dd4797-3215-4522-a2a8-7f3ccdb1fd44 sender: data: type: users id: 2e7cace7-d1a5-4b89-b34c-8fb751296746 recipients: data: - type: recipients id: 23592ac3-cec6-4f5b-849e-3cd046d14eb2 participants: data: - type: participants id: ed1641a8-fa41-478a-bd2e-dd72013096b0 schema: $ref: '#/components/schemas/notes' '400': description: This response may occur when an invalid request has been provided to the server. The request may be corrected by the consumer and resubmitted. content: application/vnd.api+json: examples: invalid_filter: value: errors: - title: Filter not allowed detail: '''{{filter_name}}'' is not allowed. Valid filters: {{filters_list}}' code: decisiv:filters:001 status: '400' source: parameter: filter[filter_name] schema: $ref: '#/components/schemas/errors_response' '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: examples: unauthorized: value: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: examples: forbidden: value: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: examples: not_found: value: errors: - status: '404' code: decisiv:resource:001 title: Resource Identifier - Not Found detail: The parent resource could not be found source: parameter: id schema: $ref: '#/components/schemas/errors_response' '424': description: This response may occur when there is an unresolved data dependency or configuration required inside of the Decisiv Platform preventing access to the requested action. content: application/vnd.api+json: examples: failed_dependency: value: errors: - title: Failed Dependency detail: Failed Dependency code: '424' status: '424' schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: examples: gateway_timeout: value: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' post: operationId: createCaseNote description: Creates a new note for the specified case. summary: Creates a note for the requested case tags: - Case Notes parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: case_id in: path description: The case ID required: true schema: type: string - name: X-DECISIV-SILENCE-EVENTS in: header required: false schema: type: array items: type: string enum: - decisiv:asset_management:case:note_posted description: Corresponding webhook events which can be muted for the given transaction responses: '201': description: Created an note for the case content: application/vnd.api+json: examples: success: value: data: id: 17cd5b9d-1f7b-480f-aebb-c72e5df56a0c type: notes attributes: message: This is my note public: false created_at: '2025-04-07T18:58:31Z' relationships: subject: data: type: cases id: e3dd4797-3215-4522-a2a8-7f3ccdb1fd44 sender: data: type: users id: 2e7cace7-d1a5-4b89-b34c-8fb751296746 recipients: data: - type: recipients id: 23592ac3-cec6-4f5b-849e-3cd046d14eb2 participants: data: - type: participants id: ed1641a8-fa41-478a-bd2e-dd72013096b0 schema: $ref: '#/components/schemas/note' '400': description: This response may occur when an invalid request has been provided to the server. The request may be corrected by the consumer and resubmitted. content: application/vnd.api+json: examples: invalid_filter: value: errors: - title: Filter not allowed detail: '''{{filter_name}}'' is not allowed. Valid filters: {{filters_list}}' code: decisiv:filters:001 status: '400' source: parameter: filter[filter_name] invalid_silence_events: value: errors: - title: Bad Request detail: Invalid value for X-DECISIV-SILENCE-EVENTS header code: decisiv:silence_webhook_events:001 status: '400' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: examples: not_found: value: errors: - status: '404' code: decisiv:resource:001 title: Resource Identifier - Not Found detail: The parent resource could not be found source: parameter: id schema: $ref: '#/components/schemas/errors_response' requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/create_note' examples: Note with recipient: value: data: type: notes attributes: message: This is my note public: false relationships: recipients: - data: type: recipients id: 23592ac3-cec6-4f5b-849e-3cd046d14eb2 - data: type: recipients id: 23592ac3-cec6-4f5b-849e-3cd046d14eb2 /asset_management/{srm_account_id}/v1/cases/{case_id}/notes/{id}: get: operationId: getCaseNote description: Retrieves the details of a specific note by its ID. summary: Shows the requested note tags: - Case Notes parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: case_id in: path description: The case uuid required: true schema: type: string - name: id in: path description: The resource uuid required: true schema: type: string - name: include in: query required: false schema: type: array items: type: string enum: - sender - subject - recipients - participants description: The relationships to be included. responses: '200': description: Returns the note content: application/vnd.api+json: examples: success: value: data: id: 17cd5b9d-1f7b-480f-aebb-c72e5df56a0c type: notes attributes: message: This is my note public: false created_at: '2023-10-01T12:00:00Z' relationships: subject: data: type: cases id: e3dd4797-3215-4522-a2a8-7f3ccdb1fd44 sender: data: type: users id: 2e7cace7-d1a5-4b89-b34c-8fb751296746 recipients: data: - type: recipients id: 23592ac3-cec6-4f5b-849e-3cd046d14eb2 participants: data: - type: participants id: ed1641a8-fa41-478a-bd2e-dd72013096b0 schema: $ref: '#/components/schemas/note' '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: examples: unauthorized: value: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: examples: forbidden: value: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: examples: not_found: value: errors: - status: '404' code: decisiv:resource:001 title: Resource Identifier - Not Found detail: The parent resource could not be found source: parameter: id schema: $ref: '#/components/schemas/errors_response' '424': description: This response may occur when there is an unresolved data dependency or configuration required inside of the Decisiv Platform preventing access to the requested action. content: application/vnd.api+json: examples: failed_dependency: value: errors: - title: Failed Dependency detail: Failed Dependency code: '424' status: '424' schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: examples: gateway_timeout: value: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' /asset_management/{srm_account_id}/v1/cases/{case_id}/send_note_to_provider: post: operationId: sendNoteToProvider description: Creates a note that will be sent to the provider for the specified case. This endpoint is deprecated. deprecated: true summary: Creates a note that will be sent to the provider for the requested case tags: - Case Notes parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: case_id in: path description: The case ID required: true schema: type: string - name: X-DECISIV-SILENCE-EVENTS in: header required: false schema: type: array items: type: string enum: - decisiv:asset_management:case:note_posted description: Corresponding webhook events which can be muted for the given transaction responses: '201': description: Created an note for the case content: application/vnd.api+json: examples: success: value: data: id: 17cd5b9d-1f7b-480f-aebb-c72e5df56a0c type: notes attributes: message: This is my note public: false created_at: '2023-10-01T12:00:00Z' relationships: subject: data: type: cases id: e3dd4797-3215-4522-a2a8-7f3ccdb1fd44 sender: data: type: users id: 2e7cace7-d1a5-4b89-b34c-8fb751296746 recipients: data: - type: recipients id: 23592ac3-cec6-4f5b-849e-3cd046d14eb2 participants: data: - type: participants id: ed1641a8-fa41-478a-bd2e-dd72013096b0 schema: $ref: '#/components/schemas/note' '400': description: This response may occur when an invalid request has been provided to the server. The request may be corrected by the consumer and resubmitted. content: application/vnd.api+json: schema: $ref: '#/components/schemas/errors_response' examples: Filter not allowed: value: errors: - title: Filter not allowed detail: '''{{filter_name}}'' is not allowed. Valid filters: {{filters_list}}' code: decisiv:filters:001 status: '400' source: parameter: filter[filter_name] Invalid silence events header: value: errors: - title: Bad Request detail: Invalid value for X-DECISIV-SILENCE-EVENTS header code: decisiv:silence_webhook_events:001 status: '400' Missing required attribute key: value: errors: - status: '400' code: decisiv:request_attributes:001 title: Missing required attribute key detail: Required key not provided in request body source: pointer: /data/attributes/message Missing required attribute value: value: errors: - status: '400' code: decisiv:request_attributes:002 title: Missing required attribute value detail: Required key must be populated source: pointer: /data/attributes/public Invalid attribute type: value: errors: - status: '400' code: decisiv:request_attributes:004 title: Invalid Attribute Type detail: Invalid type provided for the attribute source: pointer: /data/attributes/public '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - status: '404' code: decisiv:resource:001 title: Resource Identifier - Not Found detail: The parent resource could not be found source: parameter: id schema: $ref: '#/components/schemas/errors_response' '422': description: This response may occur when the request is well-formed but cannot be processed because recipients were provided in a provider note. content: application/vnd.api+json: schema: $ref: '#/components/schemas/errors_response' examples: Attribute Not Allowed: value: errors: - status: '422' code: decisiv:request_attributes:009 title: Attribute Not Allowed detail: recipients is not allowed source: pointer: /data/relationships/recipients requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/create_note_to_provider' examples: Case: value: data: type: notes attributes: message: This is my note public: false /asset_management/{srm_account_id}/v1/cases/{case_id}/participants: get: operationId: listCaseParticipants description: Lists all participants associated with the specified case. summary: Lists the participants for a selected case tags: - Case Participants parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: case_id in: path schema: type: string format: uuid description: The case UUID required: true - name: page[number] in: query required: false schema: type: integer default: 1 minimum: 1 description: Sets the desired `page` when encountering larger result sets - name: page[size] in: query required: false schema: type: integer default: 25 minimum: 1 description: Sets the desired maximum number of results per page responses: '200': description: Returns list of participants for the case content: application/vnd.api+json: example: data: - id: ed1641a8-fa41-478a-bd2e-dd72013096b0 type: participants attributes: name: Dealer Name scopes: - service_provider - billing_customer - shipping_customer schema: $ref: '#/components/schemas/participants' '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - title: Record not found detail: The requested record or one of its relationships could not be found code: '404' status: '404' schema: $ref: '#/components/schemas/errors_response' '424': description: This response may occur when there is an unresolved data dependency or configuration required inside of the Decisiv Platform preventing access to the requested action. content: application/vnd.api+json: example: errors: - title: Failed Dependency detail: Failed Dependency code: '424' status: '424' schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' /asset_management/{srm_account_id}/v1/cases/{case_id}/participants/{id}: get: operationId: getCaseParticipant description: Retrieves details for a specific participant associated with the specified case. summary: List details on a specific Participant tags: - Case Participants parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: case_id in: path schema: type: string format: uuid description: The case UUID required: true - name: id in: path schema: type: string format: uuid description: The resource UUID required: true responses: '200': description: Show details for requested Participant content: application/vnd.api+json: example: data: id: ed1641a8-fa41-478a-bd2e-dd72013096b0 type: participants attributes: name: Dealer Name scopes: - service_provider - billing_customer - shipping_customer schema: $ref: '#/components/schemas/participant' '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - title: Record not found detail: The requested record or one of its relationships could not be found code: '404' status: '404' schema: $ref: '#/components/schemas/errors_response' '424': description: This response may occur when there is an unresolved data dependency or configuration required inside of the Decisiv Platform preventing access to the requested action. content: application/vnd.api+json: example: errors: - title: Failed Dependency detail: Failed Dependency code: '424' status: '424' schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' /asset_management/{srm_account_id}/v1/cases/{case_id}/participants/{participant_id}/recipients: get: operationId: listCaseParticipantRecipients description: Lists all recipients for the specified participant within the requested case. summary: List all recipients for the requested case tags: - Case Participant Recipients parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: case_id in: path description: The case ID required: true schema: type: string - name: participant_id in: path description: The participant ID required: true schema: type: string - name: page[number] in: query required: false schema: type: number description: Sets the desired `page` when encountering larger result sets - name: page[size] in: query required: false schema: type: number description: Sets the desired maximum number of results per page responses: '200': description: Returns list of recipients content: application/vnd.api+json: example: data: - id: a6fd3ea8-36b1-410a-9bc4-eca6ac654f3b type: recipients attributes: name: Recipient Full Name phone: '12345678910' email: recipient@email.com relationships: affiliation: data: type: participants id: ed1641a8-fa41-478a-bd2e-dd72013096b0 schema: $ref: '#/components/schemas/participant_recipients' '400': description: This response may occur when an invalid request has been provided to the server. The request may be corrected by the consumer and resubmitted. content: application/vnd.api+json: example: errors: - title: Filter not allowed detail: '''{{filter_name}}'' is not allowed. Valid filters: {{filters_list}}' code: decisiv:filters:001 status: '400' source: parameter: filter[filter_name] schema: $ref: '#/components/schemas/errors_response' '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - status: '404' code: decisiv:resource:001 title: Resource Identifier - Not Found detail: The parent resource could not be found source: parameter: id schema: $ref: '#/components/schemas/errors_response' '424': description: This response may occur when there is an unresolved data dependency or configuration required inside of the Decisiv Platform preventing access to the requested action. content: application/vnd.api+json: example: errors: - title: Failed Dependency detail: Failed Dependency code: '424' status: '424' schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' /asset_management/{srm_account_id}/v1/cases/{case_id}/participants/{participant_id}/recipients/{id}: get: operationId: getCaseParticipantRecipient description: Retrieves a specific recipient for the specified participant within the requested case. summary: Get a recipient for the requested case tags: - Case Participant Recipients parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: case_id in: path description: The case ID required: true schema: type: string - name: participant_id in: path description: The participant ID required: true schema: type: string - name: id in: path description: The resource uuid required: true schema: type: string responses: '200': description: Returns list of recipient content: application/vnd.api+json: example: data: id: a6fd3ea8-36b1-410a-9bc4-eca6ac654f3b type: recipients attributes: name: Recipient Full Name phone: '12345678910' email: recipient@email.com relationships: affiliation: data: type: participants id: ed1641a8-fa41-478a-bd2e-dd72013096b0 schema: $ref: '#/components/schemas/participant_recipient' '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - status: '404' code: decisiv:resource:001 title: Resource Identifier - Not Found detail: The parent resource could not be found source: parameter: id schema: $ref: '#/components/schemas/errors_response' '424': description: This response may occur when there is an unresolved data dependency or configuration required inside of the Decisiv Platform preventing access to the requested action. content: application/vnd.api+json: example: errors: - title: Failed Dependency detail: Failed Dependency code: '424' status: '424' schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' /asset_management/{srm_account_id}/v1/cases/{case_id}/recipients: get: operationId: listCaseRecipients description: Lists all recipients associated with the requested case. summary: List all recipients for the requested case tags: - Case Recipients parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: case_id in: path description: The case ID required: true schema: type: string - name: page[number] in: query required: false schema: type: number description: Sets the desired `page` when encountering larger result sets - name: page[size] in: query required: false schema: type: number description: Sets the desired maximum number of results per page responses: '200': description: Returns list of recipients content: application/vnd.api+json: example: data: - id: 20ff667d-582b-450c-a9cb-0b4662761543 type: users attributes: username: some@email.com first_name: Someone last_name: Somebody name: Someone Somebody email: other@email.com affiliation: account_name: Dealer Name recipient_type: other schema: $ref: '#/components/schemas/recipients' '400': description: This response may occur when an invalid request has been provided to the server. The request may be corrected by the consumer and resubmitted. content: application/vnd.api+json: example: errors: - title: Filter not allowed detail: '''{{filter_name}}'' is not allowed. Valid filters: {{filters_list}}' code: decisiv:filters:001 status: '400' source: parameter: filter[filter_name] schema: $ref: '#/components/schemas/errors_response' '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - status: '404' code: decisiv:resource:001 title: Resource Identifier - Not Found detail: The parent resource could not be found source: parameter: id schema: $ref: '#/components/schemas/errors_response' '424': description: This response may occur when there is an unresolved data dependency or configuration required inside of the Decisiv Platform preventing access to the requested action. content: application/vnd.api+json: example: errors: - title: Failed Dependency detail: Failed Dependency code: '424' status: '424' schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' /asset_management/{srm_account_id}/v1/cases/{case_id}/recipients/{id}: get: operationId: getCaseRecipient description: Retrieves a specific recipient associated with the requested case. summary: Get a recipient for the requested case tags: - Case Recipients parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: case_id in: path description: The case ID required: true schema: type: string - name: id in: path description: The resource uuid required: true schema: type: string responses: '200': description: Returns list of recipient content: application/vnd.api+json: example: data: id: 20ff667d-582b-450c-a9cb-0b4662761543 type: users attributes: username: some@email.com first_name: Someone last_name: Somebody name: Someone Somebody email: other@email.com affiliation: account_name: Dealer Name recipient_type: other schema: $ref: '#/components/schemas/recipient' '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - status: '404' code: decisiv:resource:001 title: Resource Identifier - Not Found detail: The parent resource could not be found source: parameter: id schema: $ref: '#/components/schemas/errors_response' '424': description: This response may occur when there is an unresolved data dependency or configuration required inside of the Decisiv Platform preventing access to the requested action. content: application/vnd.api+json: example: errors: - title: Failed Dependency detail: Failed Dependency code: '424' status: '424' schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' /asset_management/{srm_account_id}/v1/cases/{case_id}/relationships/primary_contact: patch: operationId: updateCasePrimaryContact description: Updates the primary contact relationship for the requested case. The fleet may only assign one of its own registered contacts. summary: Modify the primary contact of a Case tags: - Case Relationships parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: case_id in: path description: The case ID required: true schema: type: string responses: '200': description: Show the case with the updated primary contact content: application/vnd.api+json: example: data: id: e3dd4797-3215-4522-a2a8-7f3ccdb1fd44 type: cases attributes: complaint: Check Engine Light continually on po_number: THX1138 auth_number: FLT2112 ro_number: RO1888 status: Drop-off relationships: billing_contact: data: type: contacts id: 3f2a1c9e-6b4d-4e2a-9c1a-7d5f8e2b9a10 primary_contact: data: type: contacts id: 9b6e2b7d-1f4a-4b8e-9d3c-5a7f0e2c8b41 schema: $ref: '#/components/schemas/case' '400': description: This response may occur when a relationship linkage's `type` is not one of `contacts`, `registered_contacts`, `recipients`. content: application/vnd.api+json: example: errors: - status: '400' code: decisiv:resource:002 title: Resource type is invalid detail: Resource type is invalid source: pointer: /data/type schema: $ref: '#/components/schemas/errors_response' '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested case is not found or is not visible to the requesting fleet. content: application/vnd.api+json: example: errors: - status: '404' code: decisiv:resource:001 title: Resource Identifier - Not Found detail: The parent resource could not be found source: parameter: case_id schema: $ref: '#/components/schemas/errors_response' '422': description: This response may occur when the supplied contact uuid is unknown, belongs to a discarded contact, or does not belong to the fleet's own registered contacts. content: application/vnd.api+json: example: errors: - status: '422' code: decisiv:request_attributes:003 title: Identifier not found detail: Contact not found in database source: pointer: /data/id schema: $ref: '#/components/schemas/errors_response' requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/modify_case_contact_relationship' examples: Assign primary contact: value: data: type: contacts id: 014ee85e-a183-4bf7-b4d7-67e758fa2b2a /asset_management/{srm_account_id}/v1/cases/{case_id}/relationships/billing_contact: patch: operationId: updateCaseBillingContact description: Updates the billing contact relationship for the requested case. The fleet may only assign one of its own registered contacts. summary: Modify the billing contact of a Case tags: - Case Relationships parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: case_id in: path description: The case ID required: true schema: type: string responses: '200': description: Show the case with the updated billing contact content: application/vnd.api+json: example: data: id: e3dd4797-3215-4522-a2a8-7f3ccdb1fd44 type: cases attributes: complaint: Check Engine Light continually on po_number: THX1138 auth_number: FLT2112 ro_number: RO1888 status: Drop-off relationships: billing_contact: data: type: contacts id: 3f2a1c9e-6b4d-4e2a-9c1a-7d5f8e2b9a10 primary_contact: data: type: contacts id: 9b6e2b7d-1f4a-4b8e-9d3c-5a7f0e2c8b41 schema: $ref: '#/components/schemas/case' '400': description: This response may occur when a relationship linkage's `type` is not one of `contacts`, `registered_contacts`, `recipients`. content: application/vnd.api+json: example: errors: - status: '400' code: decisiv:resource:002 title: Resource type is invalid detail: Resource type is invalid source: pointer: /data/type schema: $ref: '#/components/schemas/errors_response' '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested case is not found or is not visible to the requesting fleet. content: application/vnd.api+json: example: errors: - status: '404' code: decisiv:resource:001 title: Resource Identifier - Not Found detail: The parent resource could not be found source: parameter: case_id schema: $ref: '#/components/schemas/errors_response' '422': description: This response may occur when the supplied contact uuid is unknown, belongs to a discarded contact, or does not belong to the fleet's own registered contacts. content: application/vnd.api+json: example: errors: - status: '422' code: decisiv:request_attributes:003 title: Identifier not found detail: Contact not found in database source: pointer: /data/id schema: $ref: '#/components/schemas/errors_response' requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/modify_case_contact_relationship' examples: Assign billing contact: value: data: type: contacts id: 014ee85e-a183-4bf7-b4d7-67e758fa2b2a /asset_management/{srm_account_id}/v1/deactivated_assets: get: operationId: listDeactivatedAssets description: Lists all deactivated assets for the requested account. summary: List all Deactivated Assets for the requested account tags: - Deactivated Assets parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: filter[serial_number] in: query required: false schema: type: string minLength: 8 maxLength: 9 description: List `deactivated assets` matching the *exact* `serial_number` attribute. - name: filter[unit_number] in: query required: false schema: type: string description: List `deactivated assets` matching the *exact* `unit_number` attribute. - name: filter[vin] in: query required: false schema: type: string minLength: 17 maxLength: 17 description: List `deactivated assets` matching the *exact* `vin` attribute. - name: filter[depot.id] in: query required: false schema: type: string description: List `deactivated assets` matching the *exact* `depot.id` attribute. - name: filter[chassis_id] in: query required: false schema: type: string description: List `deactivated assets` matching the *exact* `chassis_id` attribute. - name: filter[license.number] in: query required: false schema: type: string description: List `deactivated assets` matching the *exact* `license.number` attribute. - name: filter[event_timestamps.deactivated_at:lt] in: query required: false schema: type: string description: Timebased filter to list deactivated assets deactivated _less than_ a specified `ISO8601` timestamp. - name: filter[event_timestamps.deactivated_at:lte] in: query required: false schema: type: string description: Timebased filter to list deactivated assets deactivated _less than or equal to_ a specified `ISO8601` timestamp. - name: filter[event_timestamps.deactivated_at:gt] in: query required: false schema: type: string description: Timebased filter to list deactivated assets deactivated _greater than_ a specified `ISO8601` timestamp. - name: filter[event_timestamps.deactivated_at:gte] in: query required: false schema: type: string description: Timebased filter to list deactivated assets deactivated _greater than or equal to_ a specified `ISO8601` timestamp. - name: page[number] in: query required: false schema: type: number description: Sets the desired `page` when encountering larger result sets - name: page[size] in: query required: false schema: type: number description: Sets the desired maximum number of results per page - name: include in: query required: false schema: type: array items: type: string enum: - depot description: The relationships to be included. responses: '200': description: Returns list of deactivated assets content: application/vnd.api+json: example: data: - id: 552fb6b4-bbce-452b-bb60-8f40ca6e8eb3 type: registered_assets attributes: vin: 1FDWE3FNXMDC03939 serial_number: MDC03939 unit_number: '42' chassis_id: XMDC03939 fleet_info: Fleet 42 make: Ford model: E350 year: 2021 engine: make: Ford model: 7.3L V-10 displacement: 6.8 l odometer_value: 61342 odometer_unit: mi engine_hours: '1363' notes: MyString license: number: HMB-2112 state: CA country: US expiration: '2029-06-18' event_timestamps: deactivated_at: '2021-11-05T17:30:38Z' vmrs_asset_status: '02' vmrs: asset_type: code_key: '2' code: D metadata: {} schema: $ref: '#/components/schemas/deactivated_assets' '400': description: This response may occur when an invalid request has been provided to the server. The request may be corrected by the consumer and resubmitted. content: application/vnd.api+json: schema: $ref: '#/components/schemas/errors_response' examples: Invalid filter name: value: errors: - title: Filter not allowed detail: '''{{filter_name}}'' is not allowed. Valid filters: {{filters_list}}' code: decisiv:filters:001 status: '400' source: parameter: filter[filter_name] Wrong timestamp format for filter: value: errors: - title: Invalid filter value code: decisiv:filters:010 detail: Invalid filter value `{{invalid_filter}}`. Expected an ISO 8601 timestamp. status: '400' source: parameter: filter[event_timestamps.deactivated_at:gte] Invalid depot filter format: value: errors: - title: Invalid Filter Format detail: Invalid format for `depot.id` code: decisiv:filters:009 status: '400' source: parameter: filter[depot.id] '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - status: '404' code: decisiv:resource:001 title: Resource Identifier - Not Found detail: The parent resource could not be found source: parameter: id schema: $ref: '#/components/schemas/errors_response' '424': description: This response may occur when there is an unresolved data dependency or configuration required inside of the Decisiv Platform preventing access to the requested action. content: application/vnd.api+json: example: errors: - title: Failed Dependency detail: Failed Dependency code: '424' status: '424' schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' /asset_management/{srm_account_id}/v1/deactivated_assets/{id}: get: operationId: getDeactivatedAsset description: Retrieves details on a specific deactivated asset by its ID. summary: List details on a specific inactive asset tags: - Deactivated Assets parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: id in: path description: The resource uuid required: true schema: type: string - name: include in: query required: false schema: type: array items: type: string enum: - depot description: The relationships to be included. responses: '200': description: Show details for requested asset content: application/vnd.api+json: example: data: id: 552fb6b4-bbce-452b-bb60-8f40ca6e8eb3 type: registered_assets attributes: vin: 1FDWE3FNXMDC03939 serial_number: MDC03939 unit_number: '42' chassis_id: XMDC03939 fleet_info: Fleet 42 make: Ford model: E350 year: 2021 engine: make: Ford model: 7.3L V-10 displacement: 6.8 l odometer_value: 61342 odometer_unit: mi engine_hours: '1363' notes: MyString license: number: HMB-2112 state: CA country: US expiration: '2029-06-18' event_timestamps: deactivated_at: '2021-11-05T17:30:38Z' vmrs_asset_status: '02' vmrs: asset_type: code_key: '2' code: D metadata: {} schema: $ref: '#/components/schemas/deactivated_asset' '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: schema: $ref: '#/components/schemas/errors_response' examples: This response may occur when the requested resource is not found.: value: errors: - status: '404' code: decisiv:resource:001 title: Resource Identifier - Not Found detail: The parent resource could not be found source: parameter: id '424': description: This response may occur when there is an unresolved data dependency or configuration required inside of the Decisiv Platform preventing access to the requested action. content: application/vnd.api+json: example: errors: - title: Failed Dependency detail: Failed Dependency code: '424' status: '424' schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' /asset_management/{srm_account_id}/v1/deactivated_depots: get: operationId: listDeactivatedDepots description: Lists all deactivated depots for the requested account. summary: List all Deactivated Depots for the requested account tags: - Deactivated Depots parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: filter[city] in: query required: false schema: type: string description: Filters the `deactivated_depots` for the given `city`, using *exact* matching search. - name: filter[state] in: query required: false schema: type: string minLength: 2 maxLength: 2 description: Filters the `deactivated_depots` for the given `state`, using *exact* matching search. - name: filter[name] in: query required: false schema: type: string description: Filters the `deactivated_depots` for the given `name`, using *exact* matching search. - name: filter[phone] in: query required: false schema: type: string description: Filters the `deactivated_depots` for the given `phone`, using *exact* matching search. - name: filter[external_reference.fms] in: query required: false schema: type: string description: Filters the `deactivated_depots` for the given `external_reference.fms`, using *exact* matching search. - name: page[number] in: query required: false schema: type: number description: Sets the desired `page` when encountering larger result sets - name: page[size] in: query required: false schema: type: number description: Sets the desired maximum number of results per page responses: '200': description: Returns list of deactivated depots content: application/vnd.api+json: example: data: - id: 8bc855e7-6e79-46a1-9e0c-0a039c4d2e44 type: depots attributes: name: Depot Company Test 1 address1: 186 Donella Corners address2: 2487 Bertie Rapid city: New York state: NY postal_code: 48119-722 phone: 236-776-0649 fax: 236-776-0649 email: test@test.com note: This is a depot external_reference: fms: '' metadata: {} country: US schema: $ref: '#/components/schemas/deactivated_depots' '400': description: This response may occur when an invalid request has been provided to the server. The request may be corrected by the consumer and resubmitted. content: application/vnd.api+json: example: errors: - title: Filter not allowed detail: '''{{filter_name}}'' is not allowed. Valid filters: {{filters_list}}' code: decisiv:filters:001 status: '400' source: parameter: filter[filter_name] schema: $ref: '#/components/schemas/errors_response' '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - status: '404' code: decisiv:resource:001 title: Resource Identifier - Not Found detail: The parent resource could not be found source: parameter: id schema: $ref: '#/components/schemas/errors_response' '424': description: This response may occur when there is an unresolved data dependency or configuration required inside of the Decisiv Platform preventing access to the requested action. content: application/vnd.api+json: example: errors: - title: Failed Dependency detail: Failed Dependency code: '424' status: '424' schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' /asset_management/{srm_account_id}/v1/deactivated_depots/{id}: get: operationId: getDeactivatedDepot description: Retrieves details for a specific deactivated depot by its ID. summary: Retrieve a deactivated depot location tags: - Deactivated Depots parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: id in: path description: The resource uuid required: true schema: type: string responses: '200': description: Return a deactivated depot content: application/vnd.api+json: example: data: id: 8bc855e7-6e79-46a1-9e0c-0a039c4d2e44 type: depots attributes: name: Depot Company Test 1 address1: 186 Donella Corners address2: 2487 Bertie Rapid city: New York state: NY postal_code: 48119-722 phone: 236-776-0649 fax: 236-776-0649 email: test@test.com note: This is a depot external_reference: fms: '' metadata: {} country: US schema: $ref: '#/components/schemas/deactivated_depot' '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - status: '404' code: decisiv:resource:001 title: Resource Identifier - Not Found detail: The parent resource could not be found source: parameter: id schema: $ref: '#/components/schemas/errors_response' '424': description: This response may occur when there is an unresolved data dependency or configuration required inside of the Decisiv Platform preventing access to the requested action. content: application/vnd.api+json: example: errors: - title: Failed Dependency detail: Failed Dependency code: '424' status: '424' schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' /asset_management/{srm_account_id}/v1/deactivated_depots/{id}/activate: post: operationId: activateDeactivatedDepot summary: Re-enable a previously deactivated depot for use within the Account tags: - Deactivated Depots parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: id in: path description: The resource uuid required: true schema: type: string description: Call to request re-enabling a depot for use within the registered Account responses: '204': description: Depot successfully re-activated. Will be available in `GET /depots` and `GET /depots/:id` content: {} '400': description: This response may occur when an invalid request has been provided to the server. The request may be corrected by the consumer and resubmitted. content: application/vnd.api+json: example: errors: - title: Filter not allowed detail: invalid is not allowed. code: '002' status: '400' - title: Bad Request detail: Invalid value for X-DECISIV-SILENCE-EVENTS header code: decisiv:silence_webhook_events:001 status: '400' schema: $ref: '#/components/schemas/errors_response' '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - status: '404' code: decisiv:resource:001 title: Resource Identifier - Not Found detail: The parent resource could not be found source: parameter: id schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' /asset_management/{srm_account_id}/v1/depots: get: operationId: listDepots description: Lists all depots for the requested account. summary: List all Depots for the requested account tags: - Depots parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: filter[city] in: query required: false schema: type: string description: Filters the `depots` for the given `city`, using *exact* matching search. - name: filter[state] in: query required: false schema: type: string minLength: 2 maxLength: 2 description: Filters the `depots` for the given `state`, using *exact* matching search. - name: filter[name] in: query required: false schema: type: string description: Filters the `depots` for the given `name`, using *exact* matching search. - name: filter[phone] in: query required: false schema: type: string description: Filters the `depots` for the given `phone`, using *exact* matching search. - name: filter[external_reference.fms] in: query required: false schema: type: string description: Filters the `depots` for the given `external_reference.fms`, using *exact* matching search. - name: page[number] in: query required: false schema: type: number description: Sets the desired `page` when encountering larger result sets - name: page[size] in: query required: false schema: type: number description: Sets the desired maximum number of results per page - name: include in: query required: false schema: type: array items: type: string enum: - registered_assets description: The relationships to be included. responses: '200': description: Returns list of depots content: application/vnd.api+json: example: data: - id: 8bc855e7-6e79-46a1-9e0c-0a039c4d2e44 type: depots attributes: name: Depot Company Test 1 address1: 186 Donella Corners address2: 2487 Bertie Rapid city: New York state: NY postal_code: 48119-722 phone: 236-776-0649 fax: 236-776-0649 email: test@test.com note: This is a depot external_reference: fms: '' metadata: {} country: US schema: $ref: '#/components/schemas/depots' '400': description: This response may occur when an invalid request has been provided to the server. The request may be corrected by the consumer and resubmitted. content: application/vnd.api+json: example: errors: - title: Filter not allowed detail: '''{{filter_name}}'' is not allowed. Valid filters: {{filters_list}}' code: decisiv:filters:001 status: '400' source: parameter: filter[filter_name] schema: $ref: '#/components/schemas/errors_response' '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - status: '404' code: decisiv:resource:001 title: Resource Identifier - Not Found detail: The parent resource could not be found source: parameter: id schema: $ref: '#/components/schemas/errors_response' '424': description: This response may occur when there is an unresolved data dependency or configuration required inside of the Decisiv Platform preventing access to the requested action. content: application/vnd.api+json: example: errors: - title: Failed Dependency detail: Failed Dependency code: '424' status: '424' schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' post: operationId: createDepot description: Creates a new depot or updates an existing one matched by external_reference.fms for the specific Dealer. summary: Create or update a depot for the specific Dealer tags: - Depots parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string responses: '200': description: Updates an existing depot matched by `external_reference.fms` content: application/vnd.api+json: example: data: id: 8bc855e7-6e79-46a1-9e0c-0a039c4d2e44 type: depots attributes: name: Depot Company Test 1 address1: 186 Donella Corners address2: 2487 Bertie Rapid city: New York state: NY postal_code: 48119-722 phone: 236-776-0649 fax: 236-776-0649 email: test@test.com note: This is a depot external_reference: fms: FMS-10001 metadata: {} country: US schema: $ref: '#/components/schemas/depot' '201': description: Creates a new depot for the specified Dealer content: application/vnd.api+json: example: data: id: 8bc855e7-6e79-46a1-9e0c-0a039c4d2e44 type: depots attributes: name: Depot Company Test 1 address1: 186 Donella Corners address2: 2487 Bertie Rapid city: New York state: NY postal_code: 48119-722 phone: 236-776-0649 fax: 236-776-0649 email: test@test.com note: This is a depot external_reference: fms: '' metadata: {} country: US schema: $ref: '#/components/schemas/depot' '400': description: Account filter is missing / Required key not provided / Required value not provided content: application/vnd.api+json: schema: $ref: '#/components/schemas/errors_response' examples: Account filter is missing: value: errors: - title: Required filter is missing detail: 'Required filter must be provided. Valid required filters: srm_account_id' code: decisiv:filters:006 status: '400' source: parameter: filter[srm_account_id] Required key not provided: value: errors: - status: '400' code: decisiv:request_attributes:001 title: Missing required attribute key detail: Required key not provided in request body source: pointer: /data/attributes/name Required value not provided: value: errors: - status: '400' code: decisiv:request_attributes:002 title: Missing required attribute value detail: Required key must be populated source: pointer: /data/attributes '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - status: '404' code: decisiv:resource:001 title: Resource Identifier - Not Found detail: The parent resource could not be found source: parameter: id schema: $ref: '#/components/schemas/errors_response' '422': description: Email with invalid host / Email with long local part / Email with long domain part / Email with invalid format / Invalid country / Empty country / Empty state / Invalid state / State does not match country / This response may occur when there is an error during the request processing. content: application/vnd.api+json: schema: $ref: '#/components/schemas/errors_response' examples: Email with invalid host: value: errors: - status: '422' code: decisiv:email:001 title: Invalid Email - Domain Resolution detail: Email domain name could not be resolved by DNS source: pointer: /data/attributes/email Email with long local part: value: errors: - status: '422' code: decisiv:email:002 title: Invalid Email - Local Part Length detail: Local-part exceeds maximum length of 64 octets source: pointer: /data/attributes/email Email with long domain part: value: errors: - status: '422' code: decisiv:email:003 title: Invalid Email - Domain Length detail: Email domain length exceeds 255 characters source: pointer: /data/attributes/email Email with invalid format: value: errors: - status: '422' code: decisiv:email:004 title: Invalid Email - Invalid Syntax detail: Email address does not match correct syntax in RFC 3696 source: pointer: /data/attributes/email Invalid country: value: errors: - status: '422' code: decisiv:location:001 title: 'Invalid format for country value, must be ISO 3166-1 alpha-2. Valid values are: `{{valid_values}}`' detail: 'Invalid country value. Valid values are: US, CA, EC, MX, CL, JP' source: pointer: /data/attributes/country Empty country: value: errors: - status: '422' code: decisiv:location:000 title: Country or State value missing. Both values must be provided. source: pointer: /data/attributes/country Empty state: value: errors: - status: '422' code: decisiv:location:000 title: Country or State value missing. Both values must be provided. source: pointer: /data/attributes/state Invalid state: value: errors: - status: '422' code: decisiv:location:002 title: Invalid State detail: Invalid format for state value, must be ISO 3166-2 source: pointer: /data/attributes/state State does not match country: value: errors: - status: '422' code: decisiv:location:004 title: Mismatch between State and Country detail: Triggered when state does not exists in the country. source: pointer: /data/attributes/state This response may occur when there is an error during the request processing.: value: errors: - code: '422' detail: Validation Error status: '422' title: Validation Error '429': description: This response will often be associated as a result of an over abundance of calls by a specific Application, Account, or IP Address resulting in a required cool off period. content: application/vnd.api+json: example: errors: - code: '429' detail: The maximum number of requests for this application has been far exceeded with the given credentials. status: '429' title: Too Many Requests schema: $ref: '#/components/schemas/errors_response' requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/depot' examples: Depot: value: data: id: 8bc855e7-6e79-46a1-9e0c-0a039c4d2e44 type: depots attributes: name: Depot Company Test 1 address1: 186 Donella Corners address2: 2487 Bertie Rapid city: New York state: NY postal_code: 48119-722 phone: 236-776-0649 fax: 236-776-0649 email: test@test.com note: This is a depot external_reference: fms: '' country: US /asset_management/{srm_account_id}/v1/depots/{id}: get: operationId: getDepot description: Retrieves details for a specific depot location by its ID. summary: Retrieve a depot location tags: - Depots parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: id in: path description: The resource uuid required: true schema: type: string responses: '200': description: Return a depot content: application/vnd.api+json: example: data: id: 8bc855e7-6e79-46a1-9e0c-0a039c4d2e44 type: depots attributes: name: Depot Company Test 1 address1: 186 Donella Corners address2: 2487 Bertie Rapid city: New York state: NY postal_code: 48119-722 phone: 236-776-0649 fax: 236-776-0649 email: test@test.com note: This is a depot external_reference: fms: '' metadata: {} country: US schema: $ref: '#/components/schemas/depot' '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - status: '404' code: decisiv:resource:001 title: Resource Identifier - Not Found detail: The parent resource could not be found source: parameter: id schema: $ref: '#/components/schemas/errors_response' '424': description: This response may occur when there is an unresolved data dependency or configuration required inside of the Decisiv Platform preventing access to the requested action. content: application/vnd.api+json: example: errors: - title: Failed Dependency detail: Failed Dependency code: '424' status: '424' schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' patch: operationId: updateDepot description: Updates an existing depot for the specific Dealer. summary: Update a depot for the specific Dealer tags: - Depots parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: id in: path description: The resource uuid required: true schema: type: string responses: '200': description: Updates a Depot for the specified Dealer content: application/vnd.api+json: example: data: id: 8bc855e7-6e79-46a1-9e0c-0a039c4d2e44 type: depots attributes: name: Depot Company Test 1 address1: 186 Donella Corners address2: 2487 Bertie Rapid city: New York state: NY postal_code: 48119-722 phone: 236-776-0649 fax: 236-776-0649 email: test@test.com note: This is a depot external_reference: fms: '' metadata: {} country: US schema: $ref: '#/components/schemas/depot' '400': description: Account filter is missing / Required key not provided / Required value not provided / Path ID mismatch content: application/vnd.api+json: schema: $ref: '#/components/schemas/errors_response' examples: Account filter is missing: value: errors: - title: Required filter is missing detail: 'Required filter must be provided. Valid required filters: srm_account_id' code: decisiv:filters:006 status: '400' source: parameter: filter[srm_account_id] Required key not provided: value: errors: - status: '400' code: decisiv:request_attributes:001 title: Missing required attribute key detail: Required key not provided in request body source: pointer: /data/attributes/name Required value not provided: value: errors: - status: '400' code: decisiv:request_attributes:002 title: Missing required attribute value detail: Required key must be populated source: pointer: /data/attributes Path ID mismatch: value: errors: - status: '400' code: decisiv:resource:006 title: Invalid JSON:API Resource specified in request detail: The "id" provided does not match the resource ID in the URL source: pointer: /data/id '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - status: '404' code: decisiv:resource:001 title: Resource Identifier - Not Found detail: The parent resource could not be found source: parameter: id schema: $ref: '#/components/schemas/errors_response' '409': description: This response may occur when the request conflicts with the current state of the target resource. content: application/vnd.api+json: example: errors: - status: '409' code: decisiv:depots:001 title: Resource Identifier - Deactivated Depot detail: Operations on deactivated depots are inaccessible through this interface. source: parameter: id schema: $ref: '#/components/schemas/errors_response' '422': description: Email with invalid host / Email with long local part / Email with long domain part / Email with invalid format / Invalid country / Empty country / Empty state / Invalid state / State does not match country / This response may occur when there is an error during the request processing. content: application/vnd.api+json: schema: $ref: '#/components/schemas/errors_response' examples: Email with invalid host: value: errors: - status: '422' code: decisiv:email:001 title: Invalid Email - Domain Resolution detail: Email domain name could not be resolved by DNS source: pointer: /data/attributes/email Email with long local part: value: errors: - status: '422' code: decisiv:email:002 title: Invalid Email - Local Part Length detail: Local-part exceeds maximum length of 64 octets source: pointer: /data/attributes/email Email with long domain part: value: errors: - status: '422' code: decisiv:email:003 title: Invalid Email - Domain Length detail: Email domain length exceeds 255 characters source: pointer: /data/attributes/email Email with invalid format: value: errors: - status: '422' code: decisiv:email:004 title: Invalid Email - Invalid Syntax detail: Email address does not match correct syntax in RFC 3696 source: pointer: /data/attributes/email Invalid country: value: errors: - status: '422' code: decisiv:location:001 title: 'Invalid format for country value, must be ISO 3166-1 alpha-2. Valid values are: `{{valid_values}}`' detail: 'Invalid country value. Valid values are: US, CA, EC, MX, CL, JP' source: pointer: /data/attributes/country Empty country: value: errors: - status: '422' code: decisiv:location:000 title: Country or State value missing. Both values must be provided. source: pointer: /data/attributes/country Empty state: value: errors: - status: '422' code: decisiv:location:000 title: Country or State value missing. Both values must be provided. source: pointer: /data/attributes/state Invalid state: value: errors: - status: '422' code: decisiv:location:002 title: Invalid State detail: Invalid format for state value, must be ISO 3166-2 source: pointer: /data/attributes/state State does not match country: value: errors: - status: '422' code: decisiv:location:004 title: Mismatch between State and Country detail: Triggered when state does not exists in the country. source: pointer: /data/attributes/state This response may occur when there is an error during the request processing.: value: errors: - code: '422' detail: Validation Error status: '422' title: Validation Error '429': description: This response will often be associated as a result of an over abundance of calls by a specific Application, Account, or IP Address resulting in a required cool off period. content: application/vnd.api+json: example: errors: - code: '429' detail: The maximum number of requests for this application has been far exceeded with the given credentials. status: '429' title: Too Many Requests schema: $ref: '#/components/schemas/errors_response' requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/depot' examples: Depot: value: data: type: depots id: 8bc855e7-6e79-46a1-9e0c-0a039c4d2e44 attributes: name: Depot Company Test 1 address1: 186 Donella Corners address2: 2487 Bertie Rapid city: New York state: NY postal_code: 48119-722 phone: 236-776-0649 fax: 236-776-0649 email: test@test.com note: This is a depot external_reference: fms: '' country: US /asset_management/{srm_account_id}/v1/depots/{id}/deactivate: post: operationId: deactivateDepot summary: Deactivates a Depot, removing it from the Account tags: - Depots parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: id in: path description: The resource uuid required: true schema: type: string description: 'Endpoint provides the ability to deactivate and remove a `Depot` from the specified `Asset Management` account. Once a `depot` is *deactivated* it will be accessible for historical purposes by calling: * `GET /deactivated_depots` * `GET /deactivated_depots/:id` Depots which have been made inactive in error can be reactivated if needed.' responses: '204': description: Successful deactivation of a Depot content: {} '400': description: This response may occur when an invalid request has been provided to the server. The request may be corrected by the consumer and resubmitted. content: application/vnd.api+json: example: errors: - title: Filter not allowed detail: invalid is not allowed. code: '002' status: '400' - title: Bad Request detail: Invalid value for X-DECISIV-SILENCE-EVENTS header code: decisiv:silence_webhook_events:001 status: '400' schema: $ref: '#/components/schemas/errors_response' '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - status: '404' code: decisiv:resource:001 title: Resource Identifier - Not Found detail: The parent resource could not be found source: parameter: id schema: $ref: '#/components/schemas/errors_response' '409': description: This response may occur when the request conflict with the current state of the target resource. content: application/vnd.api+json: example: errors: - status: '409' code: decisiv:depots:001 title: Resource Identifier - Deactivated Depot detail: Operations are deactivated, the depot is inaccessible through this interface. source: parameter: id schema: $ref: '#/components/schemas/errors_response' '422': description: This response may occur when there is an error during the request processing. content: application/vnd.api+json: example: errors: - code: decisiv:depots:002 detail: Depot cannot be deactivated, it contains related assets. status: '422' title: Validation Error schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' /asset_management/{srm_account_id}/v1/estimates: get: operationId: listEstimates description: Lists all estimates for the requested account. summary: List all estimates for the requested account tags: - Estimates parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: filter[case.id] in: query required: false schema: type: string description: Filters the `estimates` for the given `case.id`, using *exact* matching search. - name: filter[case.reference_number] in: query required: false schema: type: string minLength: 2 maxLength: 2 description: Filters the `estimates` for the given `case.reference_number`, using *exact* matching search - name: filter[status] in: query required: false schema: type: string description: 'Filters the `estimates` for the given status, using *exact* matching search. Valid values are: *approved, declined, requested*' - name: filter[version:pending] in: query required: false schema: type: string description: 'Filters the `estimates` for the given `version:pending`, using *exact* matching search. Valid value is: *true*' - name: filter[created_at:gt] in: query required: false schema: type: string description: Filters the `estimates` for the given `created_at:gt`, using *exact* matching search - name: filter[created_at:gte] in: query required: false schema: type: string description: Filters the `estimates` for the given `created_at:gte`, using *exact* matching search - name: filter[created_at:lt] in: query required: false schema: type: string description: Filters the `estimates` for the given `created_at:lt`, using *exact* matching search - name: filter[created_at:lte] in: query required: false schema: type: string description: Filters the `estimates` for the given `created_at:lte`, using *exact* matching search - name: filter[event_timestamps.approval_requested_at:gt] in: query required: false schema: type: string description: Timebased filter to list estimate versions whose approval was requested _greater than_ a specified `ISO 8601` timestamp. - name: filter[event_timestamps.approval_requested_at:gte] in: query required: false schema: type: string description: Timebased filter to list estimate versions whose approval was requested _greater than or equal to_ a specified `ISO 8601` timestamp. - name: filter[event_timestamps.approval_requested_at:lt] in: query required: false schema: type: string description: Timebased filter to list estimate versions whose approval was requested _less than_ a specified `ISO 8601` timestamp. - name: filter[event_timestamps.approval_requested_at:lte] in: query required: false schema: type: string description: Timebased filter to list estimate versions whose approval was requested _less than or equal to_ a specified `ISO 8601` timestamp. - name: page[number] in: query required: false schema: type: number description: Sets the desired `page` when encountering larger result sets - name: page[size] in: query required: false schema: type: number description: Sets the desired maximum number of results per page - name: include in: query required: false schema: type: array items: type: string enum: - case - service_writer - reviewer description: The relationships to be included. responses: '200': description: Returns list of estimates content: application/vnd.api+json: example: data: - id: e85ac4b5-b1c9-4b0f-a35f-39fcd6c3e754 type: estimates attributes: version: 1 status: approved total: 100 totals: shop_supplies: 30 hazwaste: 25 freight: 10 tax: 5 labor: 30 core: 0 parts: 0 line_items: - id: 0b84c64c-75ec-4a42-a899-f6f1044d0951 name: '' parts: - name: Oil Filter quantity: 1 vmrs: - code_key: '33' code_key_name: Component Code code: 023-001-000 description: Control Assembly - Mechanical, Clutch total: 1272 totals: labor: 72 parts: 1200 core: 0 status: approved event_timestamps: estimated_time_to_repair: '2025-04-07T18:58:31Z' reviewed_at: '2025-04-07T18:58:31Z' approval_requested_at: '2025-04-07T18:58:31Z' created_at: '2025-04-07T18:58:31Z' updated_at: '2025-04-07T18:58:31Z' relationships: service_writer: data: type: users id: 2e7cace7-d1a5-4b89-b34c-8fb751296746 case: data: type: cases id: e3dd4797-3215-4522-a2a8-7f3ccdb1fd44 reviewer: data: type: users id: ed1641a8-fa41-478a-bd2e-dd72013096b0 schema: $ref: '#/components/schemas/estimates' '400': description: This response may occur when an invalid request has been provided to the server. The request may be corrected by the consumer and resubmitted. content: application/vnd.api+json: example: errors: - title: Filter not allowed detail: '''{{filter_name}}'' is not allowed. Valid filters: {{filters_list}}' code: decisiv:filters:001 status: '400' source: parameter: filter[filter_name] schema: $ref: '#/components/schemas/errors_response' '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - status: '404' code: decisiv:resource:001 title: Resource Identifier - Not Found detail: The parent resource could not be found source: parameter: id schema: $ref: '#/components/schemas/errors_response' '424': description: This response may occur when there is an unresolved data dependency or configuration required inside of the Decisiv Platform preventing access to the requested action. content: application/vnd.api+json: example: errors: - title: Failed Dependency detail: Failed Dependency code: '424' status: '424' schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' /asset_management/{srm_account_id}/v1/estimates/{id}: get: operationId: getEstimate description: Retrieves a specific estimate for the requested account by its ID. summary: Retrieves an estimate for the requested account tags: - Estimates parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: id in: path description: The resource uuid required: true schema: type: string responses: '200': description: Returns an estimate content: application/vnd.api+json: example: data: id: e85ac4b5-b1c9-4b0f-a35f-39fcd6c3e754 type: estimates attributes: version: 1 status: approved total: 100 totals: shop_supplies: 30 hazwaste: 25 freight: 10 tax: 5 labor: 30 core: 0 parts: 0 line_items: - id: 0b84c64c-75ec-4a42-a899-f6f1044d0951 name: '' parts: - name: Oil Filter quantity: 1 vmrs: - code_key: '33' code_key_name: Component Code code: 023-001-000 description: Control Assembly - Mechanical, Clutch total: 1272 totals: labor: 72 parts: 1200 core: 0 status: approved event_timestamps: estimated_time_to_repair: '2025-04-07T18:58:31Z' reviewed_at: '2025-04-07T18:58:31Z' approval_requested_at: '2025-04-07T18:58:31Z' created_at: '2025-04-07T18:58:31Z' updated_at: '2025-04-07T18:58:31Z' relationships: service_writer: data: type: users id: 2e7cace7-d1a5-4b89-b34c-8fb751296746 case: data: type: cases id: e3dd4797-3215-4522-a2a8-7f3ccdb1fd44 reviewer: data: type: users id: ed1641a8-fa41-478a-bd2e-dd72013096b0 schema: $ref: '#/components/schemas/estimate' '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - status: '404' code: decisiv:resource:001 title: Resource Identifier - Not Found detail: The parent resource could not be found source: parameter: id schema: $ref: '#/components/schemas/errors_response' '424': description: This response may occur when there is an unresolved data dependency or configuration required inside of the Decisiv Platform preventing access to the requested action. content: application/vnd.api+json: example: errors: - title: Failed Dependency detail: Failed Dependency code: '424' status: '424' schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' /asset_management/{srm_account_id}/v1/estimates/{id}/respond: post: operationId: respondToEstimate description: Responds to an estimate by approving, declining, or deferring line items. summary: Respond to an estimate tags: - Estimates parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: id in: path description: The resource uuid required: true schema: type: string responses: '200': description: Returns the updated estimate content: application/vnd.api+json: example: data: id: e85ac4b5-b1c9-4b0f-a35f-39fcd6c3e754 type: estimates attributes: version: 1 status: approved total: 100 totals: shop_supplies: 30 hazwaste: 25 freight: 10 tax: 5 labor: 30 core: 0 parts: 0 line_items: - id: 0b84c64c-75ec-4a42-a899-f6f1044d0951 name: '' parts: - name: Oil Filter quantity: 1 vmrs: - code_key: '33' code_key_name: Component Code code: 023-001-000 description: Control Assembly - Mechanical, Clutch total: 1272 totals: labor: 72 parts: 1200 core: 0 status: approved event_timestamps: estimated_time_to_repair: '2025-04-07T18:58:31Z' reviewed_at: '2025-04-07T18:58:31Z' approval_requested_at: '2025-04-07T18:58:31Z' created_at: '2025-04-07T18:58:31Z' updated_at: '2025-04-07T18:58:31Z' relationships: service_writer: data: type: users id: 2e7cace7-d1a5-4b89-b34c-8fb751296746 case: data: type: cases id: e3dd4797-3215-4522-a2a8-7f3ccdb1fd44 reviewer: data: type: users id: ed1641a8-fa41-478a-bd2e-dd72013096b0 schema: $ref: '#/components/schemas/estimate' '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - status: '404' code: decisiv:resource:001 title: Resource Identifier - Not Found detail: The parent resource could not be found source: parameter: id schema: $ref: '#/components/schemas/errors_response' '424': description: This response may occur when there is an unresolved data dependency or configuration required inside of the Decisiv Platform preventing access to the requested action. content: application/vnd.api+json: example: errors: - title: Failed Dependency detail: Failed Dependency code: '424' status: '424' schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/response_estimate' examples: Estimate: value: data: id: e85ac4b5-b1c9-4b0f-a35f-39fcd6c3e754 type: estimates attributes: line_items: - id: 0fac6e56-0a2a-4fd9-abb5-18c0d72e3103 status: deferred comments: Not approved reason: parts costs /asset_management/{srm_account_id}/v1/deactivated_assets/{id}/activate: post: operationId: activateDeactivatedAsset summary: Re-enable a previously inactive asset for use within the Account tags: - Deactivated Assets parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: id in: path description: The resource uuid required: true schema: type: string description: Call to request re-enabling an asset for use within the registered Account responses: '204': description: Asset successfully re-activated. Will be availble in `GET /registered_assets` and `GET /registered_assets/:id` content: application/vnd.api+json: schema: $ref: '#/components/schemas/activate_deactivated_asset' '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - status: '404' code: decisiv:resource:001 title: Resource Identifier - Not Found detail: The parent resource could not be found source: parameter: id schema: $ref: '#/components/schemas/errors_response' /asset_management/{srm_account_id}/v1/extended_attributes: get: operationId: listExtendedAttributes description: Lists all extended attributes from the requested account. summary: List all Extended Attributes from the requested account tags: - Extended Attributes parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: page[number] in: query required: false schema: type: number description: Sets the desired `page` when encountering larger result sets - name: page[size] in: query required: false schema: type: number description: Sets the desired maximum number of results per page responses: '200': description: Returns list of extended attributes content: application/vnd.api+json: example: data: - id: 3e5f4d4d-8a3d-43d7-8b55-73a0b38adbf9 type: extended_attributes attributes: name: String Options schema: type: string enum: - option1 - option2 schema: $ref: '#/components/schemas/extended_attributes' '400': description: Account filter is missing content: application/vnd.api+json: example: errors: - title: Required filter is missing detail: 'Required filter must be provided. Valid required filters: srm_account_id' code: decisiv:filters:006 status: '400' source: parameter: filter[srm_account_id] schema: $ref: '#/components/schemas/errors_response' '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '424': description: This response may occur when there is an unresolved data dependency or configuration required inside of the Decisiv Platform preventing access to the requested action. content: application/vnd.api+json: example: errors: - title: Failed Dependency detail: Failed Dependency code: '424' status: '424' schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' /asset_management/{srm_account_id}/v1/extended_attributes/{id}: get: operationId: getExtendedAttribute description: Retrieves a specific extended attribute from the requested account by its ID. summary: Retrieves an Extended Attribute from the requested account tags: - Extended Attributes parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: id in: path description: The resource uuid required: true schema: type: string responses: '200': description: Returns an extended attribute content: application/vnd.api+json: example: data: id: 3e5f4d4d-8a3d-43d7-8b55-73a0b38adbf9 type: extended_attributes attributes: name: String Options schema: type: string enum: - option1 - option2 schema: $ref: '#/components/schemas/extended_attribute' '400': description: Account filter is missing content: application/vnd.api+json: example: errors: - title: Required filter is missing detail: 'Required filter must be provided. Valid required filters: srm_account_id' code: decisiv:filters:006 status: '400' source: parameter: filter[srm_account_id] schema: $ref: '#/components/schemas/errors_response' '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: Account not found content: application/vnd.api+json: example: errors: - status: '404' title: Record not found source: parameter: srm_account_id schema: $ref: '#/components/schemas/errors_response' '424': description: This response may occur when there is an unresolved data dependency or configuration required inside of the Decisiv Platform preventing access to the requested action. content: application/vnd.api+json: example: errors: - title: Failed Dependency detail: Failed Dependency code: '424' status: '424' schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' /asset_management/{srm_account_id}/v1/extended_asset_attributes: get: operationId: listExtendedAssetAttributes description: Lists all extended asset attributes for the requested account. summary: List all Extended Asset Attributes for the requested account tags: - Extended Asset Attributes parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: page[number] in: query required: false schema: type: number description: Page number - name: page[size] in: query required: false schema: type: number description: Page size - name: include in: query required: false schema: type: array items: type: string enum: - account_extended_attribute - registered_asset description: The relationships to be included. - name: filter[account_extended_attribute.id] in: query required: false schema: type: string description: Filters the extended asset attribute for the given account_extended_attribute.id, using exact matching search - name: filter[registered_asset.id] in: query required: false schema: type: string description: Filters the extended asset attribute for the given registered_asset.id, using exact matching search responses: '200': description: Returns list of extended asset attributes content: application/vnd.api+json: example: data: - id: 3e5f4d4d-8a3d-43d7-8b55-73a0b38adbf9 type: extended_asset_attributes attributes: value: values relationships: account_extended_attribute: data: type: extended_attributes id: 3e5f4d4d-8a3d-43d7-8b55-73a0b38adbf9 registered_asset: data: type: registered_assets id: ed1641a8-fa41-478a-bd2e-dd72013096b0 schema: $ref: '#/components/schemas/extended_asset_attributes' '400': description: Account filter is missing content: application/vnd.api+json: example: errors: - title: Required filter is missing detail: 'Required filter must be provided. Valid required filters: srm_account_id' code: decisiv:filters:006 status: '400' source: parameter: filter[srm_account_id] schema: $ref: '#/components/schemas/errors_response' '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '428': description: This response represents requests to a module or endpoint which can not immediately be accessed due to the Account permissions and subscriptions in the Decisiv Platform. content: application/vnd.api+json: example: errors: - status: '428' code: decisiv:access:003 title: Precondition required detail: OAuth Application does not have appropriate provisioning to access this resource schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' post: operationId: createExtendedAssetAttribute description: Creates a new extended asset attribute for the requested account. summary: Create an Extended Asset Attribute tags: - Extended Asset Attributes parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string responses: '201': description: The request has been fulfilled and a new resource is available. content: application/vnd.api+json: example: data: id: 3e5f4d4d-8a3d-43d7-8b55-73a0b38adbf9 type: extended_asset_attributes attributes: value: values relationships: account_extended_attribute: data: type: extended_attributes id: 3e5f4d4d-8a3d-43d7-8b55-73a0b38adbf9 registered_asset: data: type: registered_assets id: ed1641a8-fa41-478a-bd2e-dd72013096b0 schema: $ref: '#/components/schemas/extended_asset_attribute' '400': description: Account filter is missing / Required key not provided / Invalid Attribute Value / Required value not provided / Invalid ID format for account extended attribute relationship / Invalid ID format for registered_asset relationship content: application/vnd.api+json: schema: $ref: '#/components/schemas/errors_response' examples: Account filter is missing: value: errors: - title: Required filter is missing detail: 'Required filter must be provided. Valid required filters: srm_account_id' code: decisiv:filters:006 status: '400' source: parameter: filter[srm_account_id] Required key not provided: value: errors: - status: '400' code: decisiv:request_attributes:001 title: Missing required attribute key detail: Required key not provided in request body source: pointer: /data/attributes/value Invalid Attribute Value: value: errors: - status: '400' code: decisiv:request_attributes:010 title: Invalid Attribute Value detail: Invalid {{attribute_name}} value provided - {{reason}} source: pointer: /data/attributes/value links: about: https://decisiv.net/asset_management/srm_account/v1/ Required value not provided: value: errors: - status: '400' code: decisiv:request_attributes:002 title: Missing required attribute value detail: Required key must be populated source: pointer: /data/attributes/value Invalid ID format for account extended attribute relationship: value: errors: - status: '422' code: decisiv:relationships:001 title: Invalid ID format requested detail: Provided ID in relationships must be a valid UUID format source: pointer: /data/relationships/account_extended_attribute/data/id Invalid ID format for registered_asset relationship: value: errors: - status: '422' code: decisiv:relationships:001 title: Invalid ID format requested detail: Provided ID in relationships must be a valid UUID format source: pointer: /data/relationships/registered_asset/data/id '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: Account not found content: application/vnd.api+json: example: errors: - status: '404' title: Record not found source: parameter: srm_account_id schema: $ref: '#/components/schemas/errors_response' '422': description: Account Extended Attribute not found / Registered asset not found / Extended Asset Attribute Association Exists content: application/vnd.api+json: schema: $ref: '#/components/schemas/errors_response' examples: Account Extended Attribute not found: value: errors: - status: '422' code: decisiv:request_attributes:003 title: Identifier not found detail: Identifier not found source: pointer: /data/relationships/account_extended_attribute/data/id Registered asset not found: value: errors: - status: '422' code: decisiv:request_attributes:003 title: Identifier not found detail: Identifier not found source: pointer: /data/relationships/registered_asset/data/id Extended Asset Attribute Association Exists: value: errors: - status: '422' title: Extended Asset Attribute Association Exists detail: The extended asset attribute must be unique for the Extended Attribute and Customer Asset within your Account code: decisiv:extended_asset_attributes:001 source: pointer: /data/relationships '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/extended_asset_attribute' examples: Example: value: data: id: 3e5f4d4d-8a3d-43d7-8b55-73a0b38adbf9 type: extended_asset_attributes attributes: value: values relationships: account_extended_attribute: data: type: extended_attributes id: 3e5f4d4d-8a3d-43d7-8b55-73a0b38adbf9 registered_asset: data: type: registered_assets id: ed1641a8-fa41-478a-bd2e-dd72013096b0 /asset_management/{srm_account_id}/v1/extended_asset_attributes/{id}: get: operationId: getExtendedAssetAttribute description: Retrieves a specific extended asset attribute from the requested account by its ID. summary: Retrieves an Extended Asset Attribute from the requested account tags: - Extended Asset Attributes parameters: - name: srm_account_id in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: include in: query required: false schema: type: array items: type: string enum: - account_extended_attribute - registered_asset description: The relationships to be included. responses: '200': description: Returns an extended asset attribute content: application/vnd.api+json: example: data: id: 3e5f4d4d-8a3d-43d7-8b55-73a0b38adbf9 type: extended_asset_attributes attributes: value: values relationships: account_extended_attribute: data: type: extended_attributes id: 3e5f4d4d-8a3d-43d7-8b55-73a0b38adbf9 registered_asset: data: type: registered_assets id: ed1641a8-fa41-478a-bd2e-dd72013096b0 schema: $ref: '#/components/schemas/extended_asset_attribute' '400': description: This response may occur when an invalid request has been provided to the server. The request may be corrected by the consumer and resubmitted. content: application/vnd.api+json: example: errors: - title: Required filter is missing detail: 'Required filter must be provided. Valid required filters: srm_account_id' code: decisiv:filters:006 status: '400' source: parameter: filter[srm_account_id] schema: $ref: '#/components/schemas/errors_response' '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - status: '404' title: Record not found source: parameter: srm_account_id schema: $ref: '#/components/schemas/errors_response' '428': description: This response represents requests to a module or endpoint which can not immediately be accessed due to the Account permissions and subscriptions in the Decisiv Platform. content: application/vnd.api+json: example: errors: - status: '428' code: decisiv:access:003 title: Precondition required detail: OAuth Application does not have appropriate provisioning to access this resource schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' patch: operationId: updateExtendedAssetAttribute description: Updates an existing extended asset attribute for the requested account. summary: Updates an Extended Asset Attribute tags: - Extended Asset Attributes parameters: - name: srm_account_id in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: Show the updated extended asset attribute content: application/vnd.api+json: example: data: id: 3e5f4d4d-8a3d-43d7-8b55-73a0b38adbf9 type: extended_asset_attributes attributes: value: values relationships: account_extended_attribute: data: type: extended_attributes id: 3e5f4d4d-8a3d-43d7-8b55-73a0b38adbf9 registered_asset: data: type: registered_assets id: ed1641a8-fa41-478a-bd2e-dd72013096b0 schema: $ref: '#/components/schemas/extended_asset_attribute' '400': description: Path ID mismatch / This response may occur when an invalid request has been provided to the server. The request may be corrected by the consumer and resubmitted. content: application/vnd.api+json: schema: $ref: '#/components/schemas/errors_response' examples: Path ID mismatch: value: errors: - status: '400' code: decisiv:resource:002 title: Invalid JSON:API Resource specified in request detail: '''79327cde-d5ce-4ce6-bdba-eebab125ae2d'' is an invalid resource' source: pointer: /data/id ? This response may occur when an invalid request has been provided to the server. The request may be corrected by the consumer and resubmitted. : value: errors: - title: Required filter is missing detail: 'Required filter must be provided. Valid required filters: srm_account_id' code: decisiv:filters:006 status: '400' source: parameter: filter[srm_account_id] '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - status: '404' title: Record not found source: parameter: srm_account_id schema: $ref: '#/components/schemas/errors_response' '422': description: Extended Asset Attribute Association Exists content: application/vnd.api+json: example: errors: - status: '422' title: Extended Asset Attribute Association Exists detail: The extended asset attribute must be unique for the Extended Attribute and Customer Asset within your Account code: decisiv:extended_asset_attributes:001 source: pointer: /data/relationships schema: $ref: '#/components/schemas/errors_response' '428': description: This response represents requests to a module or endpoint which can not immediately be accessed due to the Account permissions and subscriptions in the Decisiv Platform. content: application/vnd.api+json: example: errors: - status: '428' code: decisiv:access:003 title: Precondition required detail: OAuth Application does not have appropriate provisioning to access this resource schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/update_extended_asset_attribute' examples: Example: value: data: id: 3e5f4d4d-8a3d-43d7-8b55-73a0b38adbf9 type: extended_asset_attributes attributes: value: values delete: operationId: deleteExtendedAssetAttribute description: Deletes a specific extended asset attribute by its ID. summary: Deletes an Extended Asset Attribute tags: - Extended Asset Attributes parameters: - name: srm_account_id in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '204': description: Successful deletion content: {} '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - status: '404' title: Record not found source: parameter: srm_account_id schema: $ref: '#/components/schemas/errors_response' /asset_management/{srm_account_id}/v1/internal_users: get: summary: List details all Internal Users operationId: listInternalUsers description: Lists the fleet users that are assignable to cases for the requested account. tags: - Internal Users parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: filter[external_reference.business_system] in: query required: false schema: type: string minLength: 1 description: Filters users by the exact match of the external reference business system responses: '200': description: Returns a list of internal_users content: application/vnd.api+json: example: data: - id: 6383dc89-05b6-4572-8979-a6257f3597ec type: internal_users attributes: first_name: Joe last_name: Ramone email: joe-ramone@decisivgenerated.email external_reference: business_system: '123' meta: record-count: 1 schema: $ref: '#/components/schemas/internal_users' '400': description: This response may occur when an invalid request has been provided to the server. The request may be corrected by the consumer and resubmitted. content: application/vnd.api+json: example: errors: - title: Filter not allowed detail: '''{{filter_name}}'' is not allowed. Valid filters: {{filters_list}}' code: decisiv:filters:001 status: '400' source: parameter: filter[filter_name] schema: $ref: '#/components/schemas/errors_response' '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '424': description: This response may occur when there is an unresolved data dependency or configuration required inside of the Decisiv Platform preventing access to the requested action. content: application/vnd.api+json: example: errors: - title: Failed Dependency detail: Failed Dependency code: '424' status: '424' schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' /asset_management/{srm_account_id}/v1/internal_users/{id}: get: summary: List details on a specific Internal User operationId: getInternalUser description: Returns details for a specific fleet user by ID. tags: - Internal Users parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: id in: path schema: type: string format: uuid description: The resource UUID required: true responses: '200': description: Show details for Internal User content: application/vnd.api+json: example: data: id: 6383dc89-05b6-4572-8979-a6257f3597ec type: internal_users attributes: first_name: Joe last_name: Ramone email: joe-ramone@decisivgenerated.email external_reference: business_system: '123' schema: $ref: '#/components/schemas/internal_user' '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - status: '404' code: decisiv:resource:001 title: Resource Identifier - Not Found detail: The parent resource could not be found source: parameter: id schema: $ref: '#/components/schemas/errors_response' '424': description: This response may occur when there is an unresolved data dependency or configuration required inside of the Decisiv Platform preventing access to the requested action. content: application/vnd.api+json: example: errors: - title: Failed Dependency detail: Failed Dependency code: '424' status: '424' schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' /asset_management/{srm_account_id}/v1/registered_assets: get: operationId: listRegisteredAssets description: Lists all registered assets from the requested account. summary: List all Registered Assets from the requested account tags: - Registered Assets parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: filter[serial_number] in: query required: false schema: type: string minLength: 8 maxLength: 9 description: List `registered assets` matching the *exact* `serial_number` attribute. - name: filter[unit_number] in: query required: false schema: type: string description: List `registered assets` matching the *exact* `unit_number` attribute. - name: filter[chassis_id] in: query required: false schema: type: string description: List `registered assets` matching the *exact* `chassis_id` attribute. - name: filter[vin] in: query required: false schema: type: string minLength: 17 maxLength: 17 description: List `registered assets` matching the *exact* `vin` attribute. - name: filter[depot.id] in: query required: false schema: type: string description: List `registered assets` matching the *exact* `depot.id` attribute. - name: filter[license.number] in: query required: false schema: type: string description: List `registered assets` matching the *exact* `license.number` attribute. - name: page[number] in: query required: false schema: type: number description: Sets the desired `page` when encountering larger result sets - name: page[size] in: query required: false schema: type: number description: Sets the desired maximum number of results per page - name: include in: query required: false schema: type: array items: type: string enum: - depot - srm_verified_asset - extended_asset_attributes description: The relationships to be included. - name: sort in: query required: false schema: type: string examples: Ascending: value: year summary: Single attribute ascending Descending: value: -year summary: Single attribute descending Multiple: value: -year,make summary: Multiple attributes combined description: 'Sort `registered_assets` by one or more attributes separated by commas; prefix with `-` for descending order. Valid attributes: `year`, `make`, `model`' responses: '200': description: Returns list of registered assets content: application/vnd.api+json: example: data: - id: 8a520cb4-9eb4-4caf-823a-e0d0d82dc768 type: registered_assets attributes: vin: 1FDWE3FNXMDC03939 serial_number: MDC03939 unit_number: '42' chassis_id: XMDC03939 fleet_info: Fleet 42 make: Ford model: E350 year: 2021 engine: make: Ford model: 7.3L V-10 displacement: 6.8 l serial_number: '123456789' odometer_value: 61342 odometer_unit: mi engine_hours: 1363 stand_by_hours: null switch_on_hours: null notes: My notes about this vehicle license: number: HMB-0000 state: PA country: US expiration: '2029-06-18' vmrs_asset_status: '02' vmrs: asset_type: code_key: '2' code: D metadata: series: 24SK sale_date: '2021-01-06' car_class_code: FSTK vehicle_status: TC country_iso_code: USA vehicle_use_code: DR car_class_description: 24FT Huge Truck physical_location_ps_org_id: '12345' gvwr: value: '100' unit_of_measure: kg relationships: depot: data: type: depots id: 8bc855e7-6e79-46a1-9e0c-0a039c4d2e44 srm_verified_asset: data: type: srm_verified_assets id: a6cfb121-5e78-4ec4-a7ea-223900c76607 extended_asset_attributes: data: [] - id: 3810e97f-5b23-4c7b-a605-8ad93c192d45 type: registered_assets attributes: serial_number: CRR-8842 unit_number: REEFER-01 make: Carrier model: X4 7300 year: 2022 engine_hours: 1140 stand_by_hours: 20 switch_on_hours: 2000 notes: Refrigeration unit vmrs_asset_status: '01' vmrs: asset_type: code_key: '2' code: R metadata: series: REEFER-X relationships: depot: data: type: depots id: 8bc855e7-6e79-46a1-9e0c-0a039c4d2e44 srm_verified_asset: data: null extended_asset_attributes: data: [] schema: $ref: '#/components/schemas/registered_assets' '400': description: This response may occur when an invalid request has been provided to the server. The request may be corrected by the consumer and resubmitted. / Account filter is missing content: application/vnd.api+json: schema: $ref: '#/components/schemas/errors_response' examples: ? This response may occur when an invalid request has been provided to the server. The request may be corrected by the consumer and resubmitted. : value: errors: - title: Filter not allowed detail: '''{{filter_name}}'' is not allowed. Valid filters: {{filters_list}}' code: decisiv:filters:001 status: '400' source: parameter: filter[filter_name] Account filter is missing: value: errors: - title: Required filter is missing detail: 'Required filter must be provided. Valid required filters: srm_account_id' code: decisiv:filters:006 status: '400' source: parameter: filter[srm_account_id] Invalid depot filter format: value: errors: - title: Invalid Filter Format detail: Invalid format for `depot.id` code: decisiv:filters:009 status: '400' source: parameter: filter[depot.id] '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - status: '404' code: decisiv:resource:001 title: Resource Identifier - Not Found detail: The parent resource could not be found source: parameter: srm_account_id schema: $ref: '#/components/schemas/errors_response' '409': description: This response may occur when the request conflict with the current state of the target resource. content: application/vnd.api+json: example: errors: - status: '409' code: decisiv:registered_asset:009 title: Resource Identifier - Deactivated Asset detail: Operations on deactivated assets are inaccessible through this interface. source: parameter: srm_account_id schema: $ref: '#/components/schemas/errors_response' '424': description: This response may occur when there is an unresolved data dependency or configuration required inside of the Decisiv Platform preventing access to the requested action. content: application/vnd.api+json: example: errors: - title: Failed Dependency detail: Failed Dependency code: '424' status: '424' schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' post: summary: Create a new Registered Asset operationId: createRegisteredAsset description: Creates a new Registered Asset for the requested account. tags: - Registered Assets parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: X-DECISIV-SILENCE-EVENTS in: header required: false schema: type: array items: type: string enum: - asset:registered - decisiv:asset_management:asset:registered description: Corresponding webhook events which can be muted for the given transaction responses: '200': description: Returns the created registered asset content: application/vnd.api+json: example: data: id: 8a520cb4-9eb4-4caf-823a-e0d0d82dc768 type: registered_assets attributes: vin: 1FDWE3FNXMDC03939 serial_number: MDC03939 unit_number: '42' chassis_id: XMDC03939 fleet_info: Fleet 42 make: Ford model: E350 year: 2021 engine: make: Ford model: 7.3L V-10 displacement: 6.8 l serial_number: '123456789' odometer_value: 61342 odometer_unit: mi engine_hours: 1363 stand_by_hours: null switch_on_hours: null notes: My notes about this vehicle license: number: HMB-0000 state: PA country: US expiration: '2029-06-18' vmrs_asset_status: '02' vmrs: asset_type: code_key: '2' code: D metadata: series: 24SK sale_date: '2021-01-06' car_class_code: FSTK vehicle_status: TC country_iso_code: USA vehicle_use_code: DR car_class_description: 24FT Huge Truck physical_location_ps_org_id: '12345' gvwr: value: '100' unit_of_measure: kg relationships: depot: data: type: depots id: 8bc855e7-6e79-46a1-9e0c-0a039c4d2e44 srm_verified_asset: data: type: srm_verified_assets id: a6cfb121-5e78-4ec4-a7ea-223900c76607 extended_asset_attributes: data: [] schema: $ref: '#/components/schemas/registered_asset' '400': description: Account filter is missing / Missing required field - serial_number / Missing required field - make / Missing required field - model / Missing required field - year / Missing depot relationship / Invalid depot UUID format / GVWR invalid type / GVWR missing key / Engine serial number invalid type / Engine serial number exceeds max length / Invalid silence event value / Invalid request attribute content: application/vnd.api+json: schema: $ref: '#/components/schemas/errors_response' examples: Account filter is missing: value: errors: - title: Required filter is missing detail: 'Required filter must be provided. Valid required filters: srm_account_id' code: decisiv:filters:006 status: '400' source: parameter: filter[srm_account_id] Missing required field - serial_number: value: errors: - status: '400' code: decisiv:request_attributes:001 title: Missing required attribute key detail: Required key not provided in request body source: pointer: /data/attributes/serial_number Missing required field - make: value: errors: - status: '400' code: decisiv:request_attributes:001 title: Missing required attribute key detail: Required key not provided in request body source: pointer: /data/attributes/make Missing required field - model: value: errors: - status: '400' code: decisiv:request_attributes:001 title: Missing required attribute key detail: Required key not provided in request body source: pointer: /data/attributes/model Missing required field - year: value: errors: - status: '400' code: decisiv:request_attributes:001 title: Missing required attribute key detail: Required key not provided in request body source: pointer: /data/attributes/year Missing depot relationship: value: errors: - status: '400' code: decisiv:relationships:002 title: Missing required relationship detail: The required relationship {{relationship_name}} is missing source: pointer: /data/relationships/depot Invalid depot UUID format: value: errors: - status: '400' code: decisiv:request_attributes:011 title: Invalid Attribute Pattern detail: Attribute value must match pattern '{{pattern}}' source: pointer: /data/relationships/depot/data/id GVWR invalid type: value: errors: - status: '400' code: decisiv:request_attributes:002 title: Missing required attribute value detail: Required key must be populated source: pointer: /data/attributes/gvwr GVWR missing key: value: errors: - status: '400' code: decisiv:request_attributes:001 title: Missing required attribute key detail: Required key not provided in request body source: pointer: /data/attributes/gvwr Engine serial number invalid type: value: errors: - status: '400' code: decisiv:request_attributes:002 title: Missing required attribute value detail: Required key must be populated source: pointer: /data/attributes/engine/serial_number Engine serial number exceeds max length: value: errors: - status: '400' code: decisiv:request_attributes:014 title: Character Limit Exceeded detail: Field length can not exceed {{limit}} characters source: pointer: /data/attributes/engine/serial_number Invalid silence event value: value: errors: - title: Bad Request detail: Invalid value for X-DECISIV-SILENCE-EVENTS header code: decisiv:silence_webhook_events:001 status: '400' Invalid request attribute: value: errors: - status: '400' code: decisiv:request_attributes:009 title: Attribute Not Allowed detail: invalid_attribute is not allowed source: pointer: /data/attributes/invalid_attribute '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - status: '404' code: decisiv:resource:001 title: Resource Identifier - Not Found detail: The parent resource could not be found source: parameter: id schema: $ref: '#/components/schemas/errors_response' '422': description: Missing identifier / Invalid VIN length / Invalid VIN check digit / Invalid VIN character I / Invalid VIN character O / Invalid VIN character Q / Invalid VIN character format / Serial number below minimum length / Serial number exceeds maximum length / Serial number VIN mismatch / Invalid year range / Missing odometer unit / Invalid odometer unit / Invalid metadata key / Invalid metadata value / Too many metadata keys / GVWR invalid unit / GVWR value required / GVWR unit_of_measure required / Depot not in fleet / Depot belongs to different fleet / Invalid country / Empty country / Empty state / Invalid license state / State does not match country / License expiration date / Invalid vmrs asset status / Invalid vmrs.asset_type.code / Invalid vmrs.asset_type.code_key content: application/vnd.api+json: schema: $ref: '#/components/schemas/errors_response' examples: Missing identifier: value: errors: - status: '422' code: decisiv:registered_asset:010 title: Missinsg Required Fields detail: 'At least one of the following fields should be present: vin, chassis_id, unit_number' source: pointer: /data/attributes Invalid VIN length: value: errors: - status: '422' code: decisiv:vins:002 title: Invalid length detail: Provided VIN attribute must be 17 digits in length source: pointer: /data/attributes/vin Invalid VIN check digit: value: errors: - status: '422' code: decisiv:vins:001 title: Invalid check digit detail: Provided VIN attribute has an invalid check digit. source: pointer: /data/attributes/vin Invalid VIN character I: value: errors: - status: '422' code: decisiv:vins:003 title: Invalid character I detail: Provided VIN attribute has an invalid character I. source: pointer: /data/attributes/vin Invalid VIN character O: value: errors: - status: '422' code: decisiv:vins:004 title: Invalid character O detail: Provided VIN attribute has an Invalid character O. source: pointer: /data/attributes/vin Invalid VIN character Q: value: errors: - status: '422' code: decisiv:vins:005 title: Invalid character Q detail: Provided VIN attribute has an Invalid character Q. source: pointer: /data/attributes/vin Invalid VIN character format: value: errors: - status: '422' code: decisiv:vins:006 title: Invalid format detail: Provided VIN attribute has an invalid format. source: pointer: /data/attributes/vin Serial number below minimum length: value: errors: - status: '422' code: decisiv:request_attributes:015 title: Field Length Within Limit detail: Field length must be at least {{limit}} characters source: pointer: /data/attributes/serial_number Serial number exceeds maximum length: value: errors: - status: '422' code: decisiv:request_attributes:014 title: Character Limit Exceeded detail: Field length can not exceed {{limit}} characters source: pointer: /data/attributes/serial_number Serial number VIN mismatch: value: errors: - status: '422' code: decisiv:vin_based_asset:002 title: Invalid Serial Number detail: Provided serial number must match the last 8-9 digits of the provided vin attribute source: pointer: /data/attributes/serial_number Invalid year range: value: errors: - status: '422' code: decisiv:request_attributes:016 title: Invalid Year detail: Provided year value is outside of the supported range - {{range}} source: pointer: /data/attributes/year Missing odometer unit: value: errors: - status: '422' code: decisiv:registered_asset:011 title: Required odometer_unit value. detail: An odometer_unit value is required when providing an odometer reading. source: pointer: /data/attributes/odometer_unit Invalid odometer unit: value: errors: - status: '422' code: decisiv:registered_asset:012 title: Invalid odometer_unit value. detail: 'Invalid value for odometer_unit. Valid values: {{valid_odometer_units}}' source: pointer: /data/attributes/odometer_unit Invalid metadata key: value: errors: - status: '422' code: decisiv:metadata:001 title: Invalid Metadata key detail: null source: pointer: /data/attributes/metadata Invalid metadata value: value: errors: - status: '422' code: decisiv:metadata:002 title: Invalid Metadata value detail: null source: pointer: /data/attributes/metadata Too many metadata keys: value: errors: - status: '422' code: decisiv:metadata:003 title: Metadata object is too big detail: null source: pointer: /data/attributes/metadata GVWR invalid unit: value: errors: - status: '422' code: decisiv:base:unexpected_value:103 title: Unexpected Value detail: Value provided for unit_of_measure is not supported. Valid values are kg, lb source: pointer: /data/attributes/gvwr/unit_of_measure GVWR value required: value: errors: - status: '422' code: decisiv:request_attributes:001 title: Missing required attribute key detail: Required key not provided in request body source: pointer: /data/attributes/gvwr/value GVWR unit_of_measure required: value: errors: - status: '422' code: decisiv:request_attributes:001 title: Missing required attribute key detail: Required key not provided in request body source: pointer: /data/attributes/gvwr/unit_of_measure Depot not in fleet: value: errors: - status: '422' code: decisiv:registered_asset:100 title: Depot Identifier Not Found detail: Depot Identifier does not exist for this Asset Management Account source: pointer: /data/relationships/depot/data/id Depot belongs to different fleet: value: errors: - status: '422' code: decisiv:request_attributes:003 title: Identifier Not Found detail: This object is not from the same account source: pointer: /data/relationships/depot/data/id Invalid country: value: errors: - status: '422' code: decisiv:location:001 title: 'Invalid format for country value, must be ISO 3166-1 alpha-2. Valid values are: `{{valid_values}}`' detail: 'Invalid country value. Valid values are: US, CA, EC, MX, CL, JP' source: pointer: /data/attributes/license/country Empty country: value: errors: - status: '422' code: decisiv:location:000 title: Country or State value missing. Both values must be provided. source: pointer: /data/attributes/license/country Empty state: value: errors: - status: '422' code: decisiv:location:000 title: Country or State value missing. Both values must be provided. source: pointer: /data/attributes/license/state Invalid license state: value: errors: - status: '422' code: decisiv:location:002 title: Invalid State detail: Invalid format for state value, must be ISO 3166-2 source: pointer: /data/attributes/license/state State does not match country: value: errors: - status: '422' code: decisiv:location:004 title: Mismatch between State and Country detail: Triggered when state does not exists in the country. source: pointer: /data/attributes/license/state License expiration date: value: errors: - status: '422' code: decisiv:request_attributes:006 title: Timestamps must conform to ISO 8601 standard in the format of "YYYY-MM-DDTHH:MM:SSZ" source: pointer: /data/attributes/license/expiration Invalid vmrs asset status: value: errors: - status: '422' code: decisiv:request_attributes:010 title: Invalid Attribute Value detail: Invalid {{attribute_name}} value provided - {{reason}} source: pointer: /data/attributes/vmrs_asset_status Invalid vmrs.asset_type.code: value: errors: - status: '422' code: decisiv:request_attributes:010 title: Invalid Attribute Value detail: Invalid vmrs.asset_type.code value provided - the value provided is not a valid code according to VMRS code key 2 source: pointer: /data/attributes/vmrs/asset_type/code Invalid vmrs.asset_type.code_key: value: errors: - status: '422' code: decisiv:request_attributes:010 title: Invalid Attribute Value detail: Invalid vmrs.asset_type.code_key value provided - vmrs.asset_type.code_key must be '2' source: pointer: /data/attributes/vmrs/asset_type/code_key '424': description: This response may occur when there is an unresolved data dependency or configuration required inside of the Decisiv Platform preventing access to the requested action. / Asset Already Registered (non-VIN asset contention) content: application/vnd.api+json: examples: Asset Contention - VIN: value: errors: - status: '424' code: decisiv:registered_assets:001 title: Failed Dependency detail: Asset Contention Issue source: pointer: /data/attributes/vin Asset Already Registered - non-VIN: value: errors: - status: '424' code: decisiv:registered_assets:002 title: Asset Already Registered detail: The asset's identifying attributes are already registered in the SRM Ecosystem. source: pointer: /data/attributes/serial_number schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/create_registered_asset' examples: Registered Asset: value: data: type: registered_assets attributes: vin: 1FDWE3FNXMDC03939 serial_number: MDC03939 unit_number: '42' chassis_id: XMDC03939 make: Ford model: E350 year: 2021 engine: make: Ford model: 7.3L V-10 displacement: 6.8 l serial_number: '123456789' odometer_value: 61342 odometer_unit: mi engine_hours: 1363 stand_by_hours: null switch_on_hours: null notes: My notes about this vehicle license: number: HMB-0000 state: PA country: US expiration: '2029-06-18' vmrs_asset_status: '02' vmrs: asset_type: code_key: '2' code: R metadata: series: 24SK sale_date: '2021-01-06' car_class_code: FSTK vehicle_status: TC country_iso_code: USA vehicle_use_code: DR car_class_description: 24FT Huge Truck physical_location_ps_org_id: '12345' gvwr: value: '100' unit_of_measure: kg relationships: depot: data: type: depots id: 8bc855e7-6e79-46a1-9e0c-0a039c4d2e44 /asset_management/{srm_account_id}/v1/registered_assets/{id}: get: summary: Retrieves a Registered Assets from the requested account operationId: getRegisteredAsset description: Returns details for a specific Registered Asset by ID. tags: - Registered Assets parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: id in: path description: The resource uuid required: true schema: type: string - name: include in: query required: false schema: type: array items: type: string enum: - depot - srm_verified_asset - extended_asset_attributes description: The relationships to be included. responses: '200': description: Returns a registered asset content: application/vnd.api+json: example: data: id: 8a520cb4-9eb4-4caf-823a-e0d0d82dc768 type: registered_assets attributes: vin: 1FDWE3FNXMDC03939 serial_number: MDC03939 unit_number: '42' chassis_id: XMDC03939 fleet_info: Fleet 42 make: Ford model: E350 year: 2021 engine: make: Ford model: 7.3L V-10 displacement: 6.8 l serial_number: '123456789' odometer_value: 61342 odometer_unit: mi engine_hours: 1363 stand_by_hours: null switch_on_hours: null notes: My notes about this vehicle license: number: HMB-0000 state: PA country: US expiration: '2029-06-18' vmrs_asset_status: '02' vmrs: asset_type: code_key: '2' code: D metadata: series: 24SK sale_date: '2021-01-06' car_class_code: FSTK vehicle_status: TC country_iso_code: USA vehicle_use_code: DR car_class_description: 24FT Huge Truck physical_location_ps_org_id: '12345' gvwr: value: '100' unit_of_measure: kg relationships: depot: data: type: depots id: 8bc855e7-6e79-46a1-9e0c-0a039c4d2e44 srm_verified_asset: data: type: srm_verified_assets id: a6cfb121-5e78-4ec4-a7ea-223900c76607 extended_asset_attributes: data: [] schema: $ref: '#/components/schemas/registered_asset' '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - status: '404' code: decisiv:resource:001 title: Resource Identifier - Not Found detail: The parent resource could not be found source: parameter: id schema: $ref: '#/components/schemas/errors_response' '409': description: This response may occur when the request conflict with the current state of the target resource. content: application/vnd.api+json: example: errors: - status: '409' code: decisiv:registered_asset:009 title: Resource Identifier - Deactivated Asset detail: Operations on deactivated assets are inaccessible through this interface. source: parameter: id schema: $ref: '#/components/schemas/errors_response' '424': description: This response may occur when there is an unresolved data dependency or configuration required inside of the Decisiv Platform preventing access to the requested action. content: application/vnd.api+json: example: errors: - title: Failed Dependency detail: Failed Dependency code: '424' status: '424' schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' patch: summary: Updates a registered asset operationId: updateRegisteredAsset description: Updates an existing Registered Asset for the requested account. tags: - Registered Assets parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: id in: path description: The resource uuid required: true schema: type: string - name: X-DECISIV-SILENCE-EVENTS in: header required: false schema: type: array items: type: string enum: - asset:meter_update - asset:transferred - decisiv:asset_management:asset:transferred - decisiv:asset_management:asset:meter_updated description: Corresponding webhook events which can be muted for the given transaction responses: '200': description: Show the updated registered asset content: application/vnd.api+json: example: data: id: 8a520cb4-9eb4-4caf-823a-e0d0d82dc768 type: registered_assets attributes: vin: 1FDWE3FNXMDC03939 serial_number: MDC03939 unit_number: '42' chassis_id: XMDC03939 fleet_info: Fleet 42 make: Ford model: E350 year: 2021 engine: make: Ford model: 7.3L V-10 displacement: 6.8 l serial_number: '123456789' odometer_value: 61342 odometer_unit: mi engine_hours: 1363 stand_by_hours: null switch_on_hours: null notes: My notes about this vehicle license: number: HMB-0000 state: PA country: US expiration: '2029-06-18' vmrs_asset_status: '02' vmrs: asset_type: code_key: '2' code: D metadata: series: 24SK sale_date: '2021-01-06' car_class_code: FSTK vehicle_status: TC country_iso_code: USA vehicle_use_code: DR car_class_description: 24FT Huge Truck physical_location_ps_org_id: '12345' gvwr: value: '100' unit_of_measure: kg relationships: depot: data: type: depots id: 8bc855e7-6e79-46a1-9e0c-0a039c4d2e44 srm_verified_asset: data: type: srm_verified_assets id: a6cfb121-5e78-4ec4-a7ea-223900c76607 extended_asset_attributes: data: [] schema: $ref: '#/components/schemas/registered_asset' '400': description: Invalid depot UUID format / GVWR invalid type / GVWR missing key / Engine serial number invalid type / Engine serial number exceeds max length / Invalid silence event value / Invalid request attribute / ID mismatch content: application/vnd.api+json: schema: $ref: '#/components/schemas/errors_response' examples: Invalid depot UUID format: value: errors: - status: '400' code: decisiv:request_attributes:011 title: Invalid Attribute Pattern detail: Attribute value must match pattern '{{pattern}}' source: pointer: /data/relationships/depot/data/id ID mismatch: value: errors: - status: '400' code: decisiv:resource:006 title: ID Mismatch detail: The "id" provided does not match the resource ID in the URL source: pointer: /data/id GVWR invalid type: value: errors: - status: '400' code: decisiv:request_attributes:002 title: Missing required attribute value detail: Required key must be populated source: pointer: /data/attributes/gvwr GVWR missing key: value: errors: - status: '400' code: decisiv:request_attributes:001 title: Missing required attribute key detail: Required key not provided in request body source: pointer: /data/attributes/gvwr Engine serial number invalid type: value: errors: - status: '400' code: decisiv:request_attributes:002 title: Missing required attribute value detail: Required key must be populated source: pointer: /data/attributes/engine/serial_number Engine serial number exceeds max length: value: errors: - status: '400' code: decisiv:request_attributes:014 title: Character Limit Exceeded detail: Field length can not exceed {{limit}} characters source: pointer: /data/attributes/engine/serial_number Invalid silence event value: value: errors: - title: Bad Request detail: Invalid value for X-DECISIV-SILENCE-EVENTS header code: decisiv:silence_webhook_events:001 status: '400' Invalid request attribute: value: errors: - status: '400' code: decisiv:request_attributes:009 title: Attribute Not Allowed detail: invalid_attribute is not allowed source: pointer: /data/attributes/invalid_attribute '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - status: '404' code: decisiv:resource:001 title: Resource Identifier - Not Found detail: The parent resource could not be found source: parameter: id schema: $ref: '#/components/schemas/errors_response' '409': description: This response may occur when the request conflict with the current state of the target resource. content: application/vnd.api+json: example: errors: - status: '409' code: decisiv:registered_asset:009 title: Resource Identifier - Deactivated Asset detail: Operations on deactivated assets are inaccessible through this interface. source: parameter: id schema: $ref: '#/components/schemas/errors_response' '422': description: Invalid year range / Missing odometer unit / Invalid odometer unit / Invalid metadata key / Invalid metadata value / Too many metadata keys / GVWR invalid unit / GVWR value required / GVWR unit_of_measure required / Depot not in fleet / Invalid country / Empty country / Empty state / Invalid license state / State does not match country / License expiration date / Invalid vmrs asset status / Invalid vmrs.asset_type.code / Invalid vmrs.asset_type.code_key content: application/vnd.api+json: schema: $ref: '#/components/schemas/errors_response' examples: Invalid year range: value: errors: - status: '422' code: decisiv:registered_asset:003 title: Invalid Year detail: Provided year value is outside of the supported range - {{range}} source: pointer: /data/attributes/year Missing odometer unit: value: errors: - status: '422' code: decisiv:registered_asset:011 title: Required odometer_unit value. detail: An odometer_unit value is required when providing an odometer reading. source: pointer: /data/attributes/odometer_unit Invalid odometer unit: value: errors: - status: '422' code: decisiv:registered_asset:012 title: Invalid odometer_unit value. detail: 'Invalid value for odometer_unit. Valid values: {{valid_odometer_units}}' source: pointer: /data/attributes/odometer_unit Invalid metadata key: value: errors: - status: '422' code: decisiv:metadata:001 title: Invalid Metadata key detail: null source: pointer: /data/attributes/metadata Invalid metadata value: value: errors: - status: '422' code: decisiv:metadata:002 title: Invalid Metadata value detail: null source: pointer: /data/attributes/metadata Too many metadata keys: value: errors: - status: '422' code: decisiv:metadata:003 title: Metadata object is too big detail: null source: pointer: /data/attributes/metadata GVWR invalid unit: value: errors: - status: '422' code: decisiv:request_attributes:010 title: Invalid Attribute Value detail: Invalid {{attribute_name}} value provided - {{reason}} source: pointer: /data/attributes/gvwr/unit GVWR value required: value: errors: - status: '422' code: decisiv:request_attributes:001 title: Missing required attribute key detail: Required key not provided in request body source: pointer: /data/attributes/gvwr/value GVWR unit_of_measure required: value: errors: - status: '422' code: decisiv:request_attributes:001 title: Missing required attribute key detail: Required key not provided in request body source: pointer: /data/attributes/gvwr/unit_of_measure Depot not in fleet: value: errors: - status: '422' code: decisiv:registered_asset:100 title: Depot Identifier Not Found detail: Depot Identifier does not exist for this Asset Management Account source: pointer: /data/relationships/depot/data/id Invalid country: value: errors: - status: '422' code: decisiv:location:001 title: 'Invalid format for country value, must be ISO 3166-1 alpha-2. Valid values are: `{{valid_values}}`' detail: 'Invalid country value. Valid values are: US, CA, EC, MX, CL, JP' source: pointer: /data/attributes/license/country Empty country: value: errors: - status: '422' code: decisiv:location:000 title: Country or State value missing. Both values must be provided. source: pointer: /data/attributes/license/country Empty state: value: errors: - status: '422' code: decisiv:location:000 title: Country or State value missing. Both values must be provided. source: pointer: /data/attributes/license/state Invalid license state: value: errors: - status: '422' code: decisiv:location:002 title: Invalid State detail: Invalid format for state value, must be ISO 3166-2 source: pointer: /data/attributes/license/state State does not match country: value: errors: - status: '422' code: decisiv:location:004 title: Mismatch between State and Country detail: Triggered when state does not exists in the country. source: pointer: /data/attributes/license/state License expiration date: value: errors: - status: '422' code: decisiv:request_attributes:006 title: Timestamps must conform to ISO 8601 standard in the format of "YYYY-MM-DDTHH:MM:SSZ" source: pointer: /data/attributes/license/expiration Invalid vmrs asset status: value: errors: - status: '422' code: decisiv:request_attributes:010 title: Invalid Attribute Value detail: Invalid {{attribute_name}} value provided - {{reason}} source: pointer: /data/attributes/vmrs_asset_status Invalid vmrs.asset_type.code: value: errors: - status: '422' code: decisiv:request_attributes:010 title: Invalid Attribute Value detail: Invalid vmrs.asset_type.code value provided - the value provided is not a valid code according to VMRS code key 2 source: pointer: /data/attributes/vmrs/asset_type/code Invalid vmrs.asset_type.code_key: value: errors: - status: '422' code: decisiv:request_attributes:010 title: Invalid Attribute Value detail: Invalid vmrs.asset_type.code_key value provided - vmrs.asset_type.code_key must be '2' source: pointer: /data/attributes/vmrs/asset_type/code_key '424': description: This response may occur when there is an unresolved data dependency or configuration required inside of the Decisiv Platform preventing access to the requested action. content: application/vnd.api+json: example: errors: - title: Failed Dependency detail: Failed Dependency code: '424' status: '424' schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/registered_asset_patch' examples: Registered Asset: value: data: id: 8a520cb4-9eb4-4caf-823a-e0d0d82dc768 type: registered_assets attributes: unit_number: '42' chassis_id: XMDC03939 fleet_info: Fleet 42 make: Ford model: E350 year: 2021 engine: make: Ford model: 7.3L V-10 displacement: 6.8 l serial_number: '123456789' odometer_value: 61342 odometer_unit: mi engine_hours: 1363 notes: My notes about this vehicle license: number: HMB-0000 state: PA country: US expiration: '2029-06-18' vmrs_asset_status: '02' vmrs: asset_type: code_key: '2' code: R metadata: series: 24SK sale_date: '2021-01-06' car_class_code: FSTK vehicle_status: TC country_iso_code: USA vehicle_use_code: DR car_class_description: 24FT Huge Truck physical_location_ps_org_id: '12345' gvwr: value: '100' unit_of_measure: kg /asset_management/{srm_account_id}/v1/registered_assets/{id}/deactivate: post: summary: Deactivates a Registered Asset, removing it from the Account operationId: deactivateRegisteredAsset tags: - Registered Assets parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: id in: path description: The resource uuid required: true schema: type: string - name: X-DECISIV-SILENCE-EVENTS in: header required: false schema: type: array items: type: string enum: - asset:deactivated - decisiv:asset_management:asset:deactivated description: Corresponding webhook events which can be muted for the given transaction description: "Endpoint provides the ability to deactivate and remove a `Registered Asset` from the specified `Asset\ \ Management` account.\n\n Once an `asset` is *deactivated* it will be accessible for historical purposes by calling:\n\ \ * `GET /deactivated_assets`\n* `GET /deactivated_assets/:id`\n\nAssets which have been made inactive in error can\ \ be re-enabled for use on the platform through the `activate` child endpoint of the desired asset." responses: '204': description: Successful deativation of a Registered Asset content: application/vnd.api+json: schema: $ref: '#/components/schemas/deactivate_registered_asset' '400': description: This response may occur when an invalid request has been provided to the server. The request may be corrected by the consumer and resubmitted. content: application/vnd.api+json: example: errors: - title: Filter not allowed detail: '''{{filter_name}}'' is not allowed. Valid filters: {{filters_list}}' code: decisiv:filters:001 status: '400' source: parameter: filter[filter_name] - title: Bad Request detail: Invalid value for X-DECISIV-SILENCE-EVENTS header code: decisiv:silence_webhook_events:001 status: '400' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - status: '404' code: decisiv:resource:001 title: Resource Identifier - Not Found detail: The parent resource could not be found source: parameter: id schema: $ref: '#/components/schemas/errors_response' '409': description: This response may occur when the request conflict with the current state of the target resource. content: application/vnd.api+json: example: errors: - status: '409' code: decisiv:registered_asset:009 title: Resource Identifier - Deactivated Asset detail: Operations on deactivated assets are inaccessible through this interface. source: parameter: id schema: $ref: '#/components/schemas/errors_response' /asset_management/{srm_account_id}/v1/registered_assets/{id}/metadata: delete: summary: Remove all Metadata Keys from the Registered Asset operationId: deleteRegisteredAssetMetadata description: Removes all metadata keys from the Registered Asset. tags: - Registered Assets parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: id in: path description: The resource uuid required: true schema: type: string responses: '204': description: Successful remove the metadata key of a Registered Asset content: {} '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - status: '404' code: decisiv:resource:001 title: Resource Identifier - Not Found detail: The parent resource could not be found source: parameter: id schema: $ref: '#/components/schemas/errors_response' '409': description: This response may occur when the request conflict with the current state of the target resource. content: application/vnd.api+json: example: errors: - status: '409' code: decisiv:registered_asset:009 title: Resource Identifier - Deactivated Asset detail: Operations on deactivated assets are inaccessible through this interface. source: parameter: id schema: $ref: '#/components/schemas/errors_response' /asset_management/{srm_account_id}/v1/registered_assets/{id}/metadata/{metadata_key}: delete: summary: Remove a specific Metadata Key from the Registered Asset operationId: deleteRegisteredAssetMetadataKey description: Removes a specific metadata key from the Registered Asset. tags: - Registered Assets parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: id in: path description: The resource uuid required: true schema: type: string - name: metadata_key in: path description: The metadata key to be removed required: true schema: type: string responses: '204': description: Successful remove the metadata key of a Registered Asset content: {} '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - status: '404' code: decisiv:metadata:004 title: Metadata key not found detail: The metadata object must include the metadata key source: parameter: metadata_key schema: $ref: '#/components/schemas/errors_response' '409': description: This response may occur when the request conflict with the current state of the target resource. content: application/vnd.api+json: example: errors: - status: '409' code: decisiv:registered_asset:009 title: Resource Identifier - Deactivated Asset detail: Operations on deactivated assets are inaccessible through this interface. source: parameter: id schema: $ref: '#/components/schemas/errors_response' /asset_management/{srm_account_id}/v1/registered_assets/{id}/update_meter_data: post: summary: Update an existing Registered Asset meter data description: Updates the meter data for a registered asset. tags: - Registered Assets operationId: asset_management_ra_update_meter_data parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: id in: path description: The resource uuid required: true schema: type: string - name: X-DECISIV-SILENCE-EVENTS in: header required: false schema: type: array items: type: string enum: - asset:meter_update - decisiv:asset_management:asset:meter_updated description: Corresponding webhook events which can be muted for the given transaction responses: '200': description: Returns the updated registered asset content: application/vnd.api+json: example: data: id: 8a520cb4-9eb4-4caf-823a-e0d0d82dc768 type: registered_assets attributes: vin: 1FDWE3FNXMDC03939 serial_number: MDC03939 unit_number: '42' chassis_id: XMDC03939 fleet_info: Fleet 42 make: Ford model: E350 year: 2021 engine: make: Ford model: 7.3L V-10 displacement: 6.8 l serial_number: '123456789' odometer_value: 61342 odometer_unit: mi engine_hours: 1363 stand_by_hours: null switch_on_hours: null fuel_consumed_value: 500 fuel_consumed_unit: gal notes: My notes about this vehicle license: number: HMB-0000 state: PA country: US expiration: '2029-06-18' vmrs_asset_status: '02' vmrs: asset_type: code_key: '2' code: D metadata: series: 24SK sale_date: '2021-01-06' car_class_code: FSTK vehicle_status: TC country_iso_code: USA vehicle_use_code: DR car_class_description: 24FT Huge Truck physical_location_ps_org_id: '12345' gvwr: value: '100' unit_of_measure: kg relationships: depot: data: type: depots id: 8bc855e7-6e79-46a1-9e0c-0a039c4d2e44 srm_verified_asset: data: type: srm_verified_assets id: a6cfb121-5e78-4ec4-a7ea-223900c76607 extended_asset_attributes: data: [] schema: $ref: '#/components/schemas/registered_asset' '400': description: Invalid request / ID mismatch content: application/vnd.api+json: schema: $ref: '#/components/schemas/errors_response' examples: Invalid silence event value: value: errors: - title: Bad Request detail: Invalid value for X-DECISIV-SILENCE-EVENTS header code: decisiv:silence_webhook_events:001 status: '400' ID mismatch: value: errors: - status: '400' code: decisiv:resource:006 title: ID Mismatch detail: The "id" provided does not match the resource ID in the URL source: pointer: /data/id '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - status: '404' code: decisiv:resource:001 title: Resource Identifier - Not Found detail: The parent resource could not be found source: parameter: id schema: $ref: '#/components/schemas/errors_response' '409': description: This response may occur when the request conflict with the current state of the target resource. content: application/vnd.api+json: example: errors: - status: '409' code: decisiv:registered_asset:009 title: Resource Identifier - Deactivated Asset detail: Operations on deactivated assets are inaccessible through this interface. source: parameter: id schema: $ref: '#/components/schemas/errors_response' '422': description: Invalid meter type / Invalid meter unit / Invalid meter value type / Invalid metadata key / Invalid metadata value / Too many metadata keys content: application/vnd.api+json: schema: $ref: '#/components/schemas/errors_response' examples: Invalid meter type: value: errors: - status: '422' code: decisiv:meter_data:001 title: Invalid Meter Type detail: Value provided for meter is not expected source: pointer: /data/attributes/meter_data Invalid meter unit: value: errors: - status: '422' code: decisiv:meter_data:002 title: Invalid Meter Unit detail: Value provided for the unit of measure is not supported source: pointer: /data/attributes/meter_data Non-integer meter value: value: errors: - status: '422' code: decisiv:meter_data:003 title: Invalid Meter Value Type detail: Value must be an integer source: pointer: /data/attributes/meter_data Non-numeric meter value (fuel_consumed): value: errors: - status: '422' code: decisiv:meter_data:003 title: Invalid Meter Value Type detail: Value must be numeric source: pointer: /data/attributes/meter_data Invalid metadata key: value: errors: - status: '422' code: decisiv:metadata:001 title: Invalid Metadata key detail: null source: pointer: /data/attributes/metadata Invalid metadata value: value: errors: - status: '422' code: decisiv:metadata:002 title: Invalid Metadata value detail: null source: pointer: /data/attributes/metadata Too many metadata keys: value: errors: - status: '422' code: decisiv:metadata:003 title: Metadata object is too big detail: null source: pointer: /data/attributes/metadata '424': description: This response may occur when there is an unresolved data dependency or configuration required inside of the Decisiv Platform preventing access to the requested action. content: application/vnd.api+json: example: errors: - title: Failed Dependency detail: Failed Dependency code: '424' status: '424' schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' requestBody: content: application/vnd.api+json: schema: oneOf: - $ref: '#/components/schemas/meter_data_odometer_registered_asset' - $ref: '#/components/schemas/meter_data_eng_hours_registered_asset' - $ref: '#/components/schemas/meter_data_switch_hours_registered_asset' - $ref: '#/components/schemas/meter_data_stand_hours_registered_asset' - $ref: '#/components/schemas/meter_data_fuel_consumed_registered_asset' examples: Registered Asset Meter Data: value: data: id: 8a520cb4-9eb4-4caf-823a-e0d0d82dc768 type: registered_assets attributes: meter_data: - meter: odometer unit: mi value: 2114 Registered Asset Fuel Consumed Meter Data: value: data: id: 8a520cb4-9eb4-4caf-823a-e0d0d82dc768 type: registered_assets attributes: meter_data: - meter: fuel_consumed unit: gal value: 500 /asset_management/{srm_account_id}/v1/registered_assets/{id}/meter_data_history: get: summary: Get the Registered Asset meter data log history description: Returns a log of historical meter data records for the registered asset. tags: - Registered Assets operationId: asset_management_ra_meter_data_history parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: id in: path description: The resource uuid required: true schema: type: string responses: '200': description: Returns the registered asset meter data log history content: application/vnd.api+json: example: data: id: d779edd8-cbba-4689-8d9c-8ea1488cc124 type: meter_data_records attributes: meter: odometer value: 1240 unit: mi event_timestamps: retrieved_at: '2025-04-07T18:58:31Z' recorded_by: some_email@**** schema: $ref: '#/components/schemas/meter_data_history' '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - status: '404' code: decisiv:resource:001 title: Resource Identifier - Not Found detail: The parent resource could not be found source: parameter: id schema: $ref: '#/components/schemas/errors_response' '409': description: This response may occur when the request conflict with the current state of the target resource. content: application/vnd.api+json: example: errors: - status: '409' code: decisiv:registered_asset:009 title: Resource Identifier - Deactivated Asset detail: Operations on deactivated assets are inaccessible through this interface. source: parameter: id schema: $ref: '#/components/schemas/errors_response' '424': description: This response may occur when there is an unresolved data dependency or configuration required inside of the Decisiv Platform preventing access to the requested action. content: application/vnd.api+json: example: errors: - title: Failed Dependency detail: Failed Dependency code: '424' status: '424' schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' /asset_management/{srm_account_id}/v1/registered_assets/{id}/transfer: post: summary: Transfer an existing Registered Asset operationId: transferRegisteredAsset description: Transfers an existing Registered Asset to a different account. tags: - Registered Assets parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: id in: path description: The resource uuid required: true schema: type: string - name: X-DECISIV-SILENCE-EVENTS in: header required: false schema: type: array items: type: string enum: - asset:meter_update - asset:transferred - decisiv:asset_management:asset:transferred - decisiv:asset_management:asset:meter_updated description: Corresponding webhook events which can be muted for the given transaction responses: '200': description: Returns the transfered registered asset content: application/vnd.api+json: example: data: id: 8a520cb4-9eb4-4caf-823a-e0d0d82dc768 type: registered_assets attributes: vin: 1FDWE3FNXMDC03939 serial_number: MDC03939 unit_number: '42' chassis_id: XMDC03939 fleet_info: Fleet 42 make: Ford model: E350 year: 2021 engine: make: Ford model: 7.3L V-10 displacement: 6.8 l serial_number: '123456789' odometer_value: 61342 odometer_unit: mi engine_hours: 1363 stand_by_hours: null switch_on_hours: null notes: My notes about this vehicle license: number: HMB-0000 state: PA country: US expiration: '2029-06-18' vmrs_asset_status: '02' vmrs: asset_type: code_key: '2' code: D metadata: series: 24SK sale_date: '2021-01-06' car_class_code: FSTK vehicle_status: TC country_iso_code: USA vehicle_use_code: DR car_class_description: 24FT Huge Truck physical_location_ps_org_id: '12345' gvwr: value: '100' unit_of_measure: kg relationships: depot: data: type: depots id: 8bc855e7-6e79-46a1-9e0c-0a039c4d2e44 srm_verified_asset: data: type: srm_verified_assets id: a6cfb121-5e78-4ec4-a7ea-223900c76607 extended_asset_attributes: data: [] schema: $ref: '#/components/schemas/registered_asset' '400': description: Invalid request / Invalid depot UUID format / ID mismatch content: application/vnd.api+json: schema: $ref: '#/components/schemas/errors_response' examples: Invalid depot UUID format: value: errors: - status: '400' code: decisiv:relationships:001 title: Invalid UUID detail: Attribute value must be a valid UUID source: pointer: /data/relationships/depot/data/id ID mismatch: value: errors: - status: '400' code: decisiv:resource:006 title: ID Mismatch detail: The "id" provided does not match the resource ID in the URL source: pointer: /data/id Invalid silence event value: value: errors: - title: Bad Request detail: Invalid value for X-DECISIV-SILENCE-EVENTS header code: decisiv:silence_webhook_events:001 status: '400' '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - status: '404' code: decisiv:resource:001 title: Resource Identifier - Not Found detail: The parent resource could not be found source: parameter: id schema: $ref: '#/components/schemas/errors_response' '409': description: This response may occur when the request conflict with the current state of the target resource. content: application/vnd.api+json: example: errors: - status: '409' code: decisiv:registered_asset:009 title: Resource Identifier - Deactivated Asset detail: Operations on deactivated assets are inaccessible through this interface. source: parameter: id schema: $ref: '#/components/schemas/errors_response' '422': description: Depot not found / Depot belongs to different fleet content: application/vnd.api+json: schema: $ref: '#/components/schemas/errors_response' examples: Depot not found: value: errors: - status: '422' code: decisiv:registered_asset:100 title: Depot Identifier Not Found detail: Depot Identifier does not exist for this Asset Management Account source: pointer: /data/relationships/depot/data/id Depot belongs to different fleet: value: errors: - status: '422' code: decisiv:request_attributes:003 title: Identifier Not Found detail: This object is not from the same account source: pointer: /data/relationships/depot/data/id '424': description: This response may occur when there is an unresolved data dependency or configuration required inside of the Decisiv Platform preventing access to the requested action. content: application/vnd.api+json: example: errors: - title: Failed Dependency detail: Failed Dependency code: '424' status: '424' schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/transfer_registered_asset' examples: Registered Asset: value: data: id: 8a520cb4-9eb4-4caf-823a-e0d0d82dc768 type: registered_assets attributes: {} relationships: depot: data: type: depots id: 8bc855e7-6e79-46a1-9e0c-0a039c4d2e44 /asset_management/{srm_account_id}/v1/registered_assets/{id}/build_information: get: summary: Get the SRM verified build information for a registered asset operationId: getBuildInformation description: Returns manufacturer-provided build data for the asset, sourced from SRM verified asset records. The response data array will be empty if the asset has no linked manufactured asset record. tags: - Registered Assets parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: id in: path description: The resource uuid required: true schema: type: string responses: '200': description: Returns the manufacturer build information for the registered asset. Returns an empty array if the asset has no linked manufactured asset. content: application/vnd.api+json: example: data: - id: f8c1d2e3-4567-890a-bcde-f12345678901 type: manufacturer_build_information attributes: manufacturer_specific_attributes: series: 24SK sale_date: '2021-01-06' car_class_code: FSTK car_class_description: 24FT Huge Truck schema: $ref: '#/components/schemas/build_information' '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - status: '404' code: decisiv:resource:001 title: Resource Identifier - Not Found detail: The parent resource could not be found source: parameter: id schema: $ref: '#/components/schemas/errors_response' '409': description: This response may occur when the request conflict with the current state of the target resource. content: application/vnd.api+json: example: errors: - status: '409' code: decisiv:registered_asset:009 title: Resource Identifier - Deactivated Asset detail: Operations on deactivated assets are inaccessible through this interface. source: parameter: id schema: $ref: '#/components/schemas/errors_response' '424': description: This response may occur when there is an unresolved data dependency or configuration required inside of the Decisiv Platform preventing access to the requested action. content: application/vnd.api+json: example: errors: - title: Failed Dependency detail: Failed Dependency code: '424' status: '424' schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' /asset_management/{srm_account_id}/v1/registered_assets/{registered_asset_id}/attachments: get: summary: List all attachments for the requested registered asset operationId: listRegisteredAssetAttachments description: Returns file attachments associated with the registered asset, such as inspection reports or asset photos. tags: - Registered Asset Attachments parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: registered_asset_id in: path description: The registered asset uuid required: true schema: type: string - name: page[number] in: query required: false schema: type: number description: Sets the desired `page` when encountering larger result sets - name: page[size] in: query required: false schema: type: number description: Sets the desired maximum number of results per page - name: include in: query required: false schema: type: array items: type: string enum: - publisher - subject description: The relationships to be included. responses: '200': description: Returns list of attachments for the registered asset content: application/vnd.api+json: example: data: - id: 0cc1a623-54ec-4e35-83b6-9125657a1baa type: attachments attributes: description: Asset inspection report filename: inspection.pdf size: 123456 format: application/pdf download_url: https://decisiv.net/download_url created_at: '2025-04-07T18:58:31Z' updated_at: '2025-04-07T18:58:31Z' relationships: publisher: data: type: users id: ed1641a8-fa41-478a-bd2e-dd72013096b0 subject: data: type: registered_assets id: 8a520cb4-9eb4-4caf-823a-e0d0d82dc768 schema: $ref: '#/components/schemas/attachments' '400': description: This response may occur when an invalid request has been provided to the server. The request may be corrected by the consumer and resubmitted. content: application/vnd.api+json: example: errors: - title: Filter not allowed detail: '''{{filter_name}}'' is not allowed. Valid filters: {{filters_list}}' code: decisiv:filters:001 status: '400' source: parameter: filter[filter_name] schema: $ref: '#/components/schemas/errors_response' '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - status: '404' code: decisiv:resource:001 title: Resource Identifier - Not Found detail: The parent resource could not be found source: parameter: id schema: $ref: '#/components/schemas/errors_response' '424': description: This response may occur when there is an unresolved data dependency or configuration required inside of the Decisiv Platform preventing access to the requested action. content: application/vnd.api+json: example: errors: - title: Failed Dependency detail: Failed Dependency code: '424' status: '424' schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' post: summary: Creates an attachment for the requested registered asset operationId: createRegisteredAssetAttachment description: Uploads a file attachment to the registered asset. Files can be provided via multipart form-data upload or as a URL reference. Maximum file size is 10 MB. tags: - Registered Asset Attachments parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: registered_asset_id in: path description: The registered asset uuid required: true schema: type: string responses: '201': description: Created an attachment for the registered asset content: application/vnd.api+json: schema: $ref: '#/components/schemas/attachment' examples: Attachment with file upload: value: data: id: 0cc1a623-54ec-4e35-83b6-9125657a1baa type: attachments attributes: description: Asset inspection report filename: inspection.pdf size: 123456 format: application/pdf download_url: https://decisiv.net/download_url created_at: '2025-04-07T18:58:31Z' updated_at: '2025-04-07T18:58:31Z' relationships: publisher: data: type: users id: ed1641a8-fa41-478a-bd2e-dd72013096b0 subject: data: type: registered_assets id: 8a520cb4-9eb4-4caf-823a-e0d0d82dc768 Attachment with URL: value: data: id: 3fa85f64-5717-4562-b3fc-2c963f66afa6 type: attachments attributes: description: Description of URL resource. filename: null size: null format: null download_url: https://img.fileserver.com/truck_part.png created_at: '2025-04-07T18:58:31Z' updated_at: '2025-04-07T18:58:31Z' relationships: publisher: data: type: users id: ed1641a8-fa41-478a-bd2e-dd72013096b0 subject: data: type: registered_assets id: 8a520cb4-9eb4-4caf-823a-e0d0d82dc768 '400': description: Invalid request attribute / Filename extension does not match / Invalid attribute value / File required / File too large content: application/vnd.api+json: schema: $ref: '#/components/schemas/errors_response' examples: Invalid request attribute: value: errors: - status: '400' code: decisiv:request_attributes:009 title: Attribute Not Allowed detail: invalid_attribute is not allowed source: pointer: /data/attributes/invalid_attribute Filename extension does not match: value: errors: - status: '400' code: decisiv:attachments:003 title: Filename extension does not match detail: Filename extension does not match the actual filename. source: pointer: /data/attributes/filename File required: value: errors: - status: '400' code: decisiv:attachments:001 title: File required detail: A file must be provided File too large: value: errors: - status: '400' code: decisiv:attachments:002 title: File too large detail: File size exceeds the maximum allowed (10 MB) Invalid attribute value: value: errors: - status: '400' code: decisiv:request_attributes:010 title: Invalid Attribute Value detail: Invalid {{attribute_name}} value provided - {{reason}} source: pointer: /data/attributes/{{attribute_name}} '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - status: '404' code: decisiv:resource:001 title: Resource Identifier - Not Found detail: The parent resource could not be found source: parameter: id schema: $ref: '#/components/schemas/errors_response' requestBody: description: 'Supports two content types: - **multipart/form-data**: Upload a file with optional metadata in the `body` field. - **application/vnd.api+json**: Create an attachment by providing a URL reference instead of uploading a file. ' content: multipart/form-data: schema: type: object properties: body: type: string description: 'JSON metadata for the attachment. Example: ```json {"data": {"type": "attachments", "attributes": {"description": "This is a description", "filename": "filename.txt"}}} ``` ' file: type: string format: binary description: File to be uploaded (max 10 MB) application/vnd.api+json: schema: $ref: '#/components/schemas/create_attachment' examples: Attachment with URL: summary: Create an attachment by providing a URL value: data: type: attachments attributes: description: Description of URL resource. url: https://img.fileserver.com/truck_part.png /asset_management/{srm_account_id}/v1/registered_assets/{registered_asset_id}/attachments/{id}: get: summary: Get a specific attachment for the requested registered asset operationId: getRegisteredAssetAttachment description: Returns a single attachment by ID, including a temporary download URL for the file. tags: - Registered Asset Attachments parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: registered_asset_id in: path description: The registered asset uuid required: true schema: type: string - name: id in: path description: The resource uuid required: true schema: type: string - name: include in: query required: false schema: type: array items: type: string enum: - publisher - subject description: The relationships to be included. responses: '200': description: Returns the requested attachment content: application/vnd.api+json: example: data: id: 0cc1a623-54ec-4e35-83b6-9125657a1baa type: attachments attributes: description: Asset inspection report filename: inspection.pdf size: 123456 format: application/pdf download_url: https://decisiv.net/download_url created_at: '2025-04-07T18:58:31Z' updated_at: '2025-04-07T18:58:31Z' relationships: publisher: data: type: users id: ed1641a8-fa41-478a-bd2e-dd72013096b0 subject: data: type: registered_assets id: 8a520cb4-9eb4-4caf-823a-e0d0d82dc768 schema: $ref: '#/components/schemas/attachment' '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - status: '404' code: decisiv:resource:001 title: Resource Identifier - Not Found detail: The parent resource could not be found source: parameter: id schema: $ref: '#/components/schemas/errors_response' delete: summary: Delete an attachment for the requested registered asset operationId: deleteRegisteredAssetAttachment description: Permanently removes the attachment. Only attachments uploaded by the fleet can be deleted. tags: - Registered Asset Attachments parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: registered_asset_id in: path description: The registered asset uuid required: true schema: type: string - name: id in: path description: The resource uuid required: true schema: type: string responses: '204': description: Deletes an attachment content: {} '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: The resource is read-only and cannot be updated or deleted code: decisiv:resource:003 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - status: '404' code: decisiv:resource:001 title: Resource Identifier - Not Found detail: The parent resource could not be found source: parameter: id schema: $ref: '#/components/schemas/errors_response' /asset_management/{srm_account_id}/v1/registered_components: get: summary: List all Registered Components from the requested account operationId: listRegisteredComponents description: Lists all registered components for the requested account. tags: - Registered Components parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: filter[serial_number] in: query required: false schema: type: string minLength: 8 maxLength: 9 description: List `registered components` matching the *exact* `serial_number` attribute. - name: filter[registered_asset.id] in: query required: false schema: type: string format: uuid description: List `registered components` matching the *exact* `registered_asset.id` attribute. - name: filter[registered_asset.type] in: query required: false schema: type: array items: type: string enum: - registered_assets - deactivated_assets description: List `registered components` matching the `registered_asset` type - name: include in: query required: false schema: type: array items: type: string enum: - registered_asset description: The relationships to be included. - name: page[number] in: query required: false schema: type: number description: Sets the desired `page` when encountering larger result sets - name: page[size] in: query required: false schema: type: number description: Sets the desired maximum number of results per page responses: '200': description: Returns list of registered components content: application/vnd.api+json: example: data: - id: 3e5f4d4d-8a3d-43d7-8b55-73a0b38adbf9 type: registered_components attributes: name: Rear View Safety RVS-770613 make: Rear View Safety model: RVS-770613 year: 2011 serial_number: 33CA97CF event_timestamps: installed_on: '2025-04-07T18:58:31Z' metadata: series: 24SK relationships: registered_asset: data: type: registered_assets id: 552fb6b4-bbce-452b-bb60-8f40ca6e8eb3 schema: $ref: '#/components/schemas/registered_components' '400': description: Account filter is missing / Filter not allowed / Invalid Filter with uuid type value / Invalid Filter value for registered_asset type content: application/vnd.api+json: schema: $ref: '#/components/schemas/errors_response' examples: Account filter is missing: value: errors: - title: Required filter is missing detail: 'Required filter must be provided. Valid required filters: srm_account_id' code: decisiv:filters:006 status: '400' source: parameter: filter[srm_account_id] Filter not allowed: value: errors: - title: Filter not allowed detail: '''{{filter_name}}'' is not allowed. Valid filters: {{filters_list}}' code: decisiv:filters:001 status: '400' source: parameter: filter[filter_name] Invalid Filter with uuid type value: value: errors: - code: decisiv:filters:002 title: Invalid filter value detail: '''aaa-113j-uuid'' is not a valid value for filter. Expected values: uuid' status: '400' source: parameter: filter[registered_asset.id] Invalid Filter value for registered_asset type: value: errors: - code: decisiv:filters:002 title: Invalid filter value detail: '''type'' is not a valid value for filter. Expected values: uuid' status: '400' source: parameter: filter[registered_asset.type] '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - status: '404' code: decisiv:resource:001 title: Resource Identifier - Not Found detail: The parent resource could not be found source: parameter: id schema: $ref: '#/components/schemas/errors_response' '424': description: This response may occur when there is an unresolved data dependency or configuration required inside of the Decisiv Platform preventing access to the requested action. content: application/vnd.api+json: example: errors: - title: Failed Dependency detail: Failed Dependency code: '424' status: '424' schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' post: summary: Create a new Registered Component operationId: createRegisteredComponent description: Creates a new Registered Component for the requested account. tags: - Registered Components parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string responses: '200': description: Returns the created registered component content: application/vnd.api+json: example: data: id: 3e5f4d4d-8a3d-43d7-8b55-73a0b38adbf9 type: registered_components attributes: name: Rear View Safety RVS-770613 make: Rear View Safety model: RVS-770613 year: 2011 serial_number: 33CA97CF event_timestamps: installed_on: '2025-04-07T18:58:31Z' metadata: series: 24SK relationships: registered_asset: data: type: registered_assets id: 552fb6b4-bbce-452b-bb60-8f40ca6e8eb3 schema: $ref: '#/components/schemas/registered_component' '400': description: Account filter is missing / Required key not provided / Required key must be populated / Schema conflict / Missing Registered Asset relationship / Registered Asset type is not valid content: application/vnd.api+json: schema: $ref: '#/components/schemas/errors_response' examples: Account filter is missing: value: errors: - title: Required filter is missing detail: 'Required filter must be provided. Valid required filters: srm_account_id' code: decisiv:filters:006 status: '400' source: parameter: filter[srm_account_id] Required key not provided: value: errors: - status: '400' code: decisiv:request_attributes:001 title: Missing required attribute key detail: Required key not provided in request body source: pointer: /data/attributes/name Required key must be populated: value: errors: - status: '400' code: decisiv:request_attributes:002 title: Missing required attribute value detail: Required key must be populated source: pointer: /data/attributes/name Schema conflict: value: errors: - status: '400' code: decisiv:request_schema:001 title: Schema Conflict detail: Request must be validated against exactly one of the documented schemas source: pointer: / Missing Registered Asset relationship: value: errors: - code: decisiv:relationships:002 source: pointer: /data/relationships/registered_asset status: '400' title: Missing required relationship detail: The required relationship registered_asset is missing Registered Asset type is not valid: value: errors: - code: decisiv:resource:002 source: pointer: /data/relationships/registered_asset/data/type status: '400' title: Invalid JSON:API Resource specified in request detail: '''assets'' is an invalid resource' '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: Account not found content: application/vnd.api+json: example: errors: - status: '404' title: Record not found source: parameter: srm_account_id schema: $ref: '#/components/schemas/errors_response' '422': description: Invalid year / Invalid timestamp / Identifier not found / Deactivated Asset / Registered Asset uuid is not valid content: application/vnd.api+json: schema: $ref: '#/components/schemas/errors_response' examples: Invalid year: value: errors: - status: '422' code: decisiv:request_attributes:016 title: Provided attribute value is outside of the supported range - 1000..9999 source: pointer: /data/attributes/year Invalid timestamp: value: errors: - status: '422' code: decisiv:request_attributes:006 title: Invalid Timestamp Format detail: Timestamps must conform to ISO 8601 standard in the format of "YYYY-MM-DDTHH:MM:SSZ" source: pointer: /data/attributes/event_timestamps/installed_on Identifier not found: value: errors: - status: '422' code: decisiv:request_attributes:003 title: Identifier not found detail: Identifier not found source: pointer: /data/relationships/registered_asset/data/id Deactivated Asset: value: errors: - status: '422' code: decisiv:registered_components:001 title: Deactivated Asset detail: Asset has been deactivated and is not eligible for use source: pointer: /data/relationships/registered_asset/data/id Registered Asset uuid is not valid: value: errors: - status: '422' code: decisiv:relationships:001 title: Invalid ID format requested detail: Provided ID in relationships must be a valid UUID format source: pointer: /data/relationships/registered_asset/data/id '424': description: This response may occur when there is an unresolved data dependency or configuration required inside of the Decisiv Platform preventing access to the requested action. content: application/vnd.api+json: example: errors: - title: Failed Dependency detail: Failed Dependency code: '424' status: '424' schema: $ref: '#/components/schemas/errors_response' '428': description: This response represents requests to a module or endpoint which can not immediately be accessed due to the Account permissions and subscriptions in the Decisiv Platform. content: application/vnd.api+json: example: errors: - status: '428' code: decisiv:access:003 title: Precondition required detail: OAuth Application does not have appropriate provisioning to access this resource schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/registered_component_create' examples: Registered Component: value: data: type: registered_components attributes: name: Rear View Safety RVS-770613 make: Rear View Safety model: RVS-770613 year: 2011 serial_number: 33CA97CF event_timestamps: installed_on: '2025-04-07T18:58:31Z' metadata: series: 24SK relationships: registered_asset: data: type: registered_assets id: 552fb6b4-bbce-452b-bb60-8f40ca6e8eb3 /asset_management/{srm_account_id}/v1/registered_components/{id}: get: summary: Retrieves a Registered Components from the requested account operationId: getRegisteredComponent description: Returns details for a specific Registered Component by ID. tags: - Registered Components parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: id in: path description: The resource uuid required: true schema: type: string - name: include in: query required: false schema: type: array items: type: string enum: - registered_asset description: The relationships to be included. responses: '200': description: Returns a registered components content: application/vnd.api+json: example: data: id: 3e5f4d4d-8a3d-43d7-8b55-73a0b38adbf9 type: registered_components attributes: name: Rear View Safety RVS-770613 make: Rear View Safety model: RVS-770613 year: 2011 serial_number: 33CA97CF event_timestamps: installed_on: '2025-04-07T18:58:31Z' metadata: series: 24SK relationships: registered_asset: data: type: registered_assets id: 552fb6b4-bbce-452b-bb60-8f40ca6e8eb3 schema: $ref: '#/components/schemas/registered_component' '400': description: Account filter is missing content: application/vnd.api+json: example: errors: - title: Required filter is missing detail: 'Required filter must be provided. Valid required filters: srm_account_id' code: decisiv:filters:006 status: '400' source: parameter: filter[srm_account_id] schema: $ref: '#/components/schemas/errors_response' '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: Account not found content: application/vnd.api+json: example: errors: - status: '404' title: Record not found source: parameter: srm_account_id schema: $ref: '#/components/schemas/errors_response' '424': description: This response may occur when there is an unresolved data dependency or configuration required inside of the Decisiv Platform preventing access to the requested action. content: application/vnd.api+json: example: errors: - title: Failed Dependency detail: Failed Dependency code: '424' status: '424' schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' patch: summary: Updates a Registered Components from the requested account operationId: updateRegisteredComponent description: Updates an existing Registered Component for the requested account. tags: - Registered Components parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: id in: path description: The resource uuid required: true schema: type: string responses: '200': description: Show the updated registered component content: application/vnd.api+json: example: data: id: 3e5f4d4d-8a3d-43d7-8b55-73a0b38adbf9 type: registered_components attributes: name: Rear View Safety RVS-770613 make: Rear View Safety model: RVS-770613 year: 2011 serial_number: 33CA97CF event_timestamps: installed_on: '2025-04-07T18:58:31Z' metadata: series: 24SK relationships: registered_asset: data: type: registered_assets id: 552fb6b4-bbce-452b-bb60-8f40ca6e8eb3 schema: $ref: '#/components/schemas/registered_component' '400': description: Account filter is missing / Required key not provided / Required key must be populated / Schema conflict / Missing Registered Asset relationship / Registered Asset type is not valid content: application/vnd.api+json: schema: $ref: '#/components/schemas/errors_response' examples: Account filter is missing: value: errors: - title: Required filter is missing detail: 'Required filter must be provided. Valid required filters: srm_account_id' code: decisiv:filters:006 status: '400' source: parameter: filter[srm_account_id] Required key not provided: value: errors: - status: '400' code: decisiv:request_attributes:001 title: Missing required attribute key detail: Required key not provided in request body source: pointer: /data/attributes/name Required key must be populated: value: errors: - status: '400' code: decisiv:request_attributes:002 title: Missing required attribute value detail: Required key must be populated source: pointer: /data/attributes/name Schema conflict: value: errors: - status: '400' code: decisiv:request_schema:001 title: Schema Conflict detail: Request must be validated against exactly one of the documented schemas source: pointer: / Missing Registered Asset relationship: value: errors: - code: decisiv:relationships:002 source: pointer: /data/relationships/registered_asset status: '400' title: Missing required relationship detail: The required relationship registered_asset is missing Registered Asset type is not valid: value: errors: - code: decisiv:resource:002 source: pointer: /data/relationships/registered_asset/data/type status: '400' title: Invalid JSON:API Resource specified in request detail: '''assets'' is an invalid resource' '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: Account not found content: application/vnd.api+json: example: errors: - status: '404' title: Record not found source: parameter: srm_account_id schema: $ref: '#/components/schemas/errors_response' '422': description: Invalid year / Invalid timestamp / Identifier not found / Deactivated Asset / Registered Asset uuid is not valid content: application/vnd.api+json: schema: $ref: '#/components/schemas/errors_response' examples: Invalid year: value: errors: - status: '422' code: decisiv:request_attributes:016 title: Provided attribute value is outside of the supported range - 1000..9999 source: pointer: /data/attributes/year Invalid timestamp: value: errors: - status: '422' code: decisiv:request_attributes:006 title: Invalid Timestamp Format detail: Timestamps must conform to ISO 8601 standard in the format of "YYYY-MM-DDTHH:MM:SSZ" source: pointer: /data/attributes/event_timestamps/installed_on Identifier not found: value: errors: - status: '422' code: decisiv:request_attributes:003 title: Identifier not found detail: Identifier not found source: pointer: /data/relationships/registered_asset/data/id Deactivated Asset: value: errors: - status: '422' code: decisiv:registered_components:001 title: Deactivated Asset detail: Asset has been deactivated and is not eligible for use source: pointer: /data/relationships/registered_asset/data/id Registered Asset uuid is not valid: value: errors: - status: '422' code: decisiv:relationships:001 title: Invalid ID format requested detail: Provided ID in relationships must be a valid UUID format source: pointer: /data/relationships/registered_asset/data/id '424': description: This response may occur when there is an unresolved data dependency or configuration required inside of the Decisiv Platform preventing access to the requested action. content: application/vnd.api+json: example: errors: - title: Failed Dependency detail: Failed Dependency code: '424' status: '424' schema: $ref: '#/components/schemas/errors_response' '428': description: This response represents requests to a module or endpoint which can not immediately be accessed due to the Account permissions and subscriptions in the Decisiv Platform. content: application/vnd.api+json: example: errors: - status: '428' code: decisiv:access:003 title: Precondition required detail: OAuth Application does not have appropriate provisioning to access this resource schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/registered_component_patch' examples: Registered Component: value: data: id: 3e5f4d4d-8a3d-43d7-8b55-73a0b38adbf9 type: registered_components attributes: name: Rear View Safety RVS-770613 make: Rear View Safety model: RVS-770613 year: 2011 serial_number: 33CA97CF event_timestamps: installed_on: '2025-04-07T18:58:31Z' metadata: series: 24SK relationships: registered_asset: data: type: registered_assets id: 552fb6b4-bbce-452b-bb60-8f40ca6e8eb3 delete: summary: Deletes a Registered Components from the requested account operationId: deleteRegisteredComponent description: Deletes an existing Registered Component for the requested account. tags: - Registered Components parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: id in: path description: The resource uuid required: true schema: type: string responses: '204': description: The request has been successfully fulfilled but there is no additional content to return. content: {} '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: Account not found content: application/vnd.api+json: example: errors: - status: '404' title: Record not found source: parameter: srm_account_id schema: $ref: '#/components/schemas/errors_response' '424': description: This response may occur when there is an unresolved data dependency or configuration required inside of the Decisiv Platform preventing access to the requested action. content: application/vnd.api+json: example: errors: - title: Failed Dependency detail: Failed Dependency code: '424' status: '424' schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' /asset_management/{srm_account_id}/v1/registered_components/{component_id}/relationships/registered_asset: patch: summary: Add, Update or Remove a Registered Asset from Registered Component operationId: updateRegisteredComponentRelationship description: Updates the registered asset relationship for a registered component. tags: - Registered Components Relationships parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: component_id in: path schema: type: string format: uuid description: The component UUID required: true responses: '200': description: Show details for changed Registered Asset content: application/vnd.api+json: example: data: id: 3e5f4d4d-8a3d-43d7-8b55-73a0b38adbf9 type: registered_components attributes: name: Rear View Safety RVS-770613 make: Rear View Safety model: RVS-770613 year: 2011 serial_number: 33CA97CF event_timestamps: installed_on: '2025-04-07T18:58:31Z' metadata: series: 24SK relationships: registered_asset: data: type: registered_assets id: 552fb6b4-bbce-452b-bb60-8f40ca6e8eb3 schema: $ref: '#/components/schemas/registered_component' '400': description: This response may occur when an invalid request has been provided to the server. The request may be corrected by the consumer and resubmitted. content: application/vnd.api+json: example: errors: - title: Filter not allowed detail: '''{{filter_name}}'' is not allowed. Valid filters: {{filters_list}}' code: decisiv:filters:001 status: '400' source: parameter: filter[filter_name] schema: $ref: '#/components/schemas/errors_response' '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. / Feature for this action is not available content: application/vnd.api+json: schema: $ref: '#/components/schemas/errors_response' examples: ? This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. : value: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' Feature for this action is not available: value: errors: - status: '403' code: decisiv:account:002 title: Feature Unavailable detail: Requested feature or action not available for this account '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - title: Record not found detail: The requested record or one of its relationships could not be found code: '404' status: '404' schema: $ref: '#/components/schemas/errors_response' '422': description: User does not have the underlying permission content: application/vnd.api+json: example: errors: - status: '422' code: decisiv:permissions:001 title: Missing Permission detail: Provided resource does not have the required permission to complete the request. schema: $ref: '#/components/schemas/errors_response' '424': description: This response may occur when there is an unresolved data dependency or configuration required inside of the Decisiv Platform preventing access to the requested action. content: application/vnd.api+json: example: errors: - title: Failed Dependency detail: Failed Dependency code: '424' status: '424' schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' requestBody: content: application/vnd.api+json: schema: oneOf: - $ref: '#/components/schemas/registered_asset_change' - $ref: '#/components/schemas/registered_asset_remove' examples: Change Registered Asset: value: data: type: registered_asset id: 8a520cb4-9eb4-4caf-823a-e0d0d82dc768 Remove Registered Asset: value: data: null /asset_management/{srm_account_id}/v1/service_providers: get: summary: List all Service Providers available for the requested account operationId: listServiceProviders tags: - Service Providers description: 'You need to use at least one of the filters: filter[name], filter[name:like], filter[geolocation.point] or filter[state].' parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: filter[geolocation.point] in: query required: false schema: type: string description: 'Filters the service providers for the given `geolocation.point`, using geolocation search. Format: `lat,lon`' - name: filter[geolocation.radius] in: query required: false schema: type: integer minLength: 1 maxLength: 100 description: Used combined with `geolocation.point` filter. Default value `20` if not present - name: filter[geolocation.radius_unit] in: query required: false schema: type: string description: 'Used combined with `geolocation.point` and `geolocation.radius` filters. Valid values: `mi` and `km`. Default value `mi` if not present' - name: filter[name:like] in: query required: false schema: type: string minLength: 4 maxLength: 100 description: Filters the service providers for the given name, using *partial* matching search. Cannot be combined with `filter[name]`. - name: filter[name] in: query required: false schema: type: string minLength: 4 maxLength: 100 description: Filters the service providers for the given name, using *exact* matching search. Cannot be combined with `filter[name:like]`. - name: filter[state] in: query required: false schema: type: string description: List `service_provider` matching the *exact* `state` attribute. - name: filter[service_networks.name] in: query required: false schema: type: string description: List `service_provider` matching the *exact* `service network name` attribute. - name: filter[service_networks.id] in: query required: false schema: type: string description: List `service_provider` matching the *exact* `service network id` attribute. - name: page[number] in: query required: false schema: type: number description: Sets the desired `page` when encountering larger result sets - name: page[size] in: query required: false schema: type: number description: Sets the desired maximum number of results per page responses: '200': description: Returns list of Service Providers content: application/vnd.api+json: example: data: - id: 49babff7-536d-4262-b267-de66a19452cf type: service_providers attributes: name: Joe's Garage address1: 9009 Sunset Blvd address2: Door 5 city: West Hollywood state: CA postal_code: '90069' country: US email: roxy.by.proxy@decisivgenerated.email phone: (939) 555-0113 fax: (939) 555-0113 location: latitude: 34.090674 longitude: -118.387979 external_reference: srm_account_id: AAA-123 relationships: service_networks: data: type: service_networks id: 73225f34-c108-42a4-98d1-2da354ebff89 schema: $ref: '#/components/schemas/service_providers' '400': description: This response may occur when an invalid request has been provided to the server. The request may be corrected by the consumer and resubmitted. content: application/vnd.api+json: schema: $ref: '#/components/schemas/errors_response' examples: Filter not allowed: value: errors: - title: Filter not allowed detail: '''{{filter_name}}'' is not allowed. Valid filters: {{filters_list}}' code: decisiv:filters:001 status: '400' source: parameter: filter[filter_name] Conflicting filters: value: errors: - title: Conflicting filters detail: Cannot combine filter[name] with its :like variant. Use only one. code: decisiv:filters:012 status: '400' source: parameter: filter[name] Filter value too long: value: errors: - title: Maximum character length not met detail: Filter value must be less than 4096 characters code: decisiv:filters:008 status: '400' source: parameter: filter[name] Invalid filter characters: value: errors: - title: Invalid filter characters detail: Filter value for filter[name] contains invalid characters. code: decisiv:filters:013 status: '400' source: parameter: filter[name] Invalid filter shape: value: errors: - title: Invalid filter value shape detail: Filter value for filter[name] must be a string. code: decisiv:filters:014 status: '400' source: parameter: filter[name] '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - status: '404' code: decisiv:resource:001 title: Resource Identifier - Not Found detail: The parent resource could not be found source: parameter: id schema: $ref: '#/components/schemas/errors_response' '424': description: This response may occur when there is an unresolved data dependency or configuration required inside of the Decisiv Platform preventing access to the requested action. content: application/vnd.api+json: example: errors: - title: Failed Dependency detail: Failed Dependency code: '424' status: '424' schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' /asset_management/{srm_account_id}/v1/service_providers/{id}: get: summary: Retrieve a Service Provider available for the requested account operationId: getServiceProvider description: Returns details for a specific Service Provider by ID. tags: - Service Providers parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: id in: path description: The resource uuid required: true schema: type: string responses: '200': description: Returns list of Service Providers content: application/vnd.api+json: example: data: id: 49babff7-536d-4262-b267-de66a19452cf type: service_providers attributes: name: Joe's Garage address1: 9009 Sunset Blvd address2: Door 5 city: West Hollywood state: CA postal_code: '90069' country: US email: roxy.by.proxy@decisivgenerated.email phone: (939) 555-0113 fax: (939) 555-0113 location: latitude: 34.090674 longitude: -118.387979 external_reference: srm_account_id: AAA-123 relationships: service_networks: data: type: service_networks id: 73225f34-c108-42a4-98d1-2da354ebff89 schema: $ref: '#/components/schemas/service_provider' '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - status: '404' code: decisiv:resource:001 title: Resource Identifier - Not Found detail: The parent resource could not be found source: parameter: id schema: $ref: '#/components/schemas/errors_response' '424': description: This response may occur when there is an unresolved data dependency or configuration required inside of the Decisiv Platform preventing access to the requested action. content: application/vnd.api+json: example: errors: - title: Failed Dependency detail: Failed Dependency code: '424' status: '424' schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' /asset_management/{srm_account_id}/v1/service_requests: get: summary: List all Service requests available for the requested account operationId: listServiceRequests description: Lists all service requests available for the requested account. tags: - Service Requests parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: filter[event_timestamps.requested_at:lt] in: query required: false schema: type: string description: Timebased filter to list service requests requested _less than_ a specified `ISO8601` timestamp. - name: filter[event_timestamps.requested_at:lte] in: query required: false schema: type: string description: Timebased filter to list service requests requested _less than or equal to_ a specified `ISO8601` timestamp. - name: filter[event_timestamps.requested_at:gt] in: query required: false schema: type: string description: Timebased filter to list service requests requested _greater than_ a specified `ISO8601` timestamp. - name: filter[event_timestamps.requested_at:gte] in: query required: false schema: type: string description: Timebased filter to list service requests requested _greater than or equal to_ a specified `ISO8601` timestamp. - name: filter[account.id] in: query required: false schema: type: string pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ minLength: 36 maxLength: 36 description: Filter service requests based upon the specified `Account` identifier - name: filter[account.external_reference.srm_account] in: query required: false schema: type: string description: Filter service requests based upon the specified `SRM account` external reference - name: filter[service_provider.id] in: query required: false schema: type: string pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ minLength: 36 maxLength: 36 description: Filter service requests based upon the specified `Service Provider` identifier - name: filter[status] in: query required: false schema: type: string description: Filter service requests by status - name: filter[registered_asset.id] in: query required: false schema: type: string pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ minLength: 36 maxLength: 36 description: Filter service requests based upon the specified `Registered Asset` identifier - name: filter[case.id] in: query required: false schema: type: string pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ minLength: 36 maxLength: 36 description: Filter service requests based upon the specified `Case` identifier - name: page[number] in: query required: false schema: type: number description: Sets the desired `page` when encountering larger result sets - name: page[size] in: query required: false schema: type: number description: Sets the desired maximum number of results per page - name: include in: query required: false schema: type: array items: type: string enum: - registered_asset - service_provider - case - primary_contact description: The relationships to be included. responses: '200': description: Returns list of Service requests content: application/vnd.api+json: example: data: - id: 22027e64-4191-41fd-b0e2-6f6c489d8b2a type: service_requests attributes: complaint: transmission leaks on left side status: Accepted po_number: PO836743 auth_number: AUTH984107 note: Initial Note asset_information: odometer_value: 1234566 odometer_unit: mi reference_number: 123245 primary_contact: first_name: Gandalf last_name: The Gray email: gandalf@thegray.com relation: Frodo phone: mobile: (582) 123-1234 work: (524) 123-1234 driver: first_name: Bilbo last_name: Baggins email: bilbo@baggins.com phone: mobile: (582) 123-1234 work: (524) 123-1234 breakdown: location: Dorris city: South Lake Tahoe state: KY created_at: '2025-04-07T18:58:31Z' updated_at: '2025-04-07T18:58:31Z' relationships: registered_asset: data: type: registered_assets id: 552fb6b4-bbce-452b-bb60-8f40ca6e8eb3 service_provider: data: type: service_providers id: 49babff7-536d-4262-b267-de66a19452cf case: data: type: cases id: e3dd4797-3215-4522-a2a8-7f3ccdb1fd44 primary_contact: data: type: contacts id: 7da042d2-c47b-4748-ba65-c114adf1cf62 schema: $ref: '#/components/schemas/service_requests' '400': description: This response may occur when an invalid request has been provided to the server. The request may be corrected by the consumer and resubmitted. content: application/vnd.api+json: example: errors: - title: Filter not allowed detail: '''{{filter_name}}'' is not allowed. Valid filters: {{filters_list}}' code: decisiv:filters:001 status: '400' source: parameter: filter[filter_name] - title: Invalid filter value code: decisiv:filters:010 detail: Invalid filter value `{{invalid_filter}}`. Expected an ISO 8601 timestamp. status: '400' source: parameter: filter[event_timestamps.requested_at:gte] schema: $ref: '#/components/schemas/errors_response' '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - status: '404' code: decisiv:resource:001 title: Resource Identifier - Not Found detail: The parent resource could not be found source: parameter: id schema: $ref: '#/components/schemas/errors_response' '424': description: This response may occur when there is an unresolved data dependency or configuration required inside of the Decisiv Platform preventing access to the requested action. content: application/vnd.api+json: example: errors: - title: Failed Dependency detail: Failed Dependency code: '424' status: '424' schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' post: summary: Create a new Service Request operationId: createServiceRequest description: Creates a new Service Request for the requested account. tags: - Service Requests parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: X-DECISIV-SILENCE-EVENTS in: header required: false schema: type: array items: type: string enum: - service_request:submitted - decisiv:asset_management:service_request:submitted description: Corresponding webhook events which can be muted for the given transaction responses: '200': description: Returns the created service request content: application/vnd.api+json: example: data: id: 22027e64-4191-41fd-b0e2-6f6c489d8b2a type: service_requests attributes: complaint: transmission leaks on left side status: Accepted po_number: PO836743 auth_number: AUTH984107 note: Initial Note asset_information: odometer_value: 1234566 odometer_unit: mi reference_number: 123245 primary_contact: first_name: Gandalf last_name: The Gray email: gandalf@thegray.com relation: Frodo phone: mobile: (582) 123-1234 work: (524) 123-1234 driver: first_name: Bilbo last_name: Baggins email: bilbo@baggins.com phone: mobile: (582) 123-1234 work: (524) 123-1234 breakdown: location: Dorris city: South Lake Tahoe state: KY created_at: '2025-04-07T18:58:31Z' updated_at: '2025-04-07T18:58:31Z' relationships: registered_asset: data: type: registered_assets id: 552fb6b4-bbce-452b-bb60-8f40ca6e8eb3 service_provider: data: type: service_providers id: 49babff7-536d-4262-b267-de66a19452cf case: data: type: cases id: e3dd4797-3215-4522-a2a8-7f3ccdb1fd44 primary_contact: data: type: contacts id: 7da042d2-c47b-4748-ba65-c114adf1cf62 schema: $ref: '#/components/schemas/service_request' '400': description: This response may occur when an invalid request has been provided to the server. The request may be corrected by the consumer and resubmitted. content: application/vnd.api+json: schema: $ref: '#/components/schemas/errors_response' examples: Filter not allowed: value: errors: - title: Filter not allowed detail: '''{{filter_name}}'' is not allowed. Valid filters: {{filters_list}}' code: decisiv:filters:001 status: '400' source: parameter: filter[filter_name] Invalid silence events header: value: errors: - title: Bad Request detail: Invalid value for X-DECISIV-SILENCE-EVENTS header code: decisiv:silence_webhook_events:001 status: '400' Missing required relationship: value: errors: - status: '400' code: decisiv:relationships:002 title: Missing required relationship detail: The required relationship registered_asset is missing source: pointer: /data/relationships/registered_asset Missing required attribute value: value: errors: - status: '400' code: decisiv:request_attributes:002 title: Missing required attribute value detail: Required key must be populated source: pointer: /data/attributes/complaint Invalid timestamp value: value: errors: - status: '400' code: decisiv:request_attributes:006 title: Invalid Timestamp Format detail: Timestamps must conform to ISO 8601 standard in the format of "YYYY-MM-DDTHH:MM:SSZ" source: pointer: /data/attributes/event_timestamps/requested_at Invalid odometer_unit value: value: errors: - status: '400' code: decisiv:request_attributes:010 title: Invalid Attribute Value detail: Invalid odometer_unit value provided - Needs to be either 'km' or 'mi' source: pointer: /data/attributes/asset_information/odometer_unit '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - status: '404' code: decisiv:resource:001 title: Resource Identifier - Not Found detail: The parent resource could not be found source: parameter: id schema: $ref: '#/components/schemas/errors_response' '422': description: Service Provider does not have a contact to receive request / Registered Asset is not owned by the dealer or does not have owner / Relationship not found / Missing required contact field / Invalid state content: application/vnd.api+json: schema: $ref: '#/components/schemas/errors_response' examples: Service Provider does not have a contact to receive request: value: errors: - status: '422' code: decisiv:service_requests:002 title: Service Provider is not currently available for accepting requests detail: Triggered when the service provider does not have a contact to receive the request source: pointer: /data/relationships/service_provider/data/id Registered Asset is not owned by the dealer or does not have owner: value: errors: - status: '422' code: decisiv:service_requests:001 title: Provided Registered Asset is not enrolled for this account detail: Triggered when the registered asset is not owned by any dealers on the account source: pointer: /data/relationships/registered_asset/data/id Relationship not found: value: errors: - status: '422' code: decisiv:request_attributes:003 title: Identifier not found detail: Triggered when the record is not found by the provided identifier source: pointer: /data/relationships/registered_asset/data/id Missing required contact field: value: errors: - status: '422' code: decisiv:contacts:002 title: Must be present when primary_contact information has been provided. detail: Triggered when contact data has been provided with missing mandatory fields source: pointer: /data/attributes/primary_contact/first_name Invalid state: value: errors: - status: '422' code: decisiv:location:002 title: Invalid state value detail: Invalid format for state value, must be ISO 3166-2 source: pointer: /data/attributes/breakdown/state '424': description: This response may occur when there is an unresolved data dependency or configuration required inside of the Decisiv Platform preventing access to the requested action. content: application/vnd.api+json: example: errors: - title: Failed Dependency detail: Failed Dependency code: '424' status: '424' schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/create_service_request' examples: Service Request: value: data: type: service_requests attributes: complaint: transmission leaks on left side po_number: PO836743 auth_number: AUTH984107 note: Initial Note asset_information: odometer_value: 1234566 odometer_unit: mi primary_contact: first_name: Gandalf last_name: The Gray email: gandalf@thegray.com relation: Frodo phone: mobile: (582) 123-1234 work: (524) 123-1234 driver: first_name: Bilbo last_name: Baggins email: bilbo@baggins.com phone: mobile: (582) 123-1234 work: (524) 123-1234 breakdown: location: Dorris city: South Lake Tahoe state: KY relationships: registered_asset: data: type: registered_assets id: 552fb6b4-bbce-452b-bb60-8f40ca6e8eb3 service_provider: data: type: service_providers id: 49babff7-536d-4262-b267-de66a19452cf primary_contact: data: type: contacts id: 7da042d2-c47b-4748-ba65-c114adf1cf62 /asset_management/{srm_account_id}/v1/service_requests/{id}: get: summary: Retrieves a Service Request available for the requested account operationId: getServiceRequest description: Returns details for a specific Service Request by ID. tags: - Service Requests parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: id in: path description: The resource uuid required: true schema: type: string responses: '200': description: Retrieves a Service request content: application/vnd.api+json: example: data: id: 22027e64-4191-41fd-b0e2-6f6c489d8b2a type: service_requests attributes: complaint: transmission leaks on left side status: Accepted po_number: PO836743 auth_number: AUTH984107 note: Initial Note asset_information: odometer_value: 1234566 odometer_unit: mi reference_number: 123245 primary_contact: first_name: Gandalf last_name: The Gray email: gandalf@thegray.com relation: Frodo phone: mobile: (582) 123-1234 work: (524) 123-1234 driver: first_name: Bilbo last_name: Baggins email: bilbo@baggins.com phone: mobile: (582) 123-1234 work: (524) 123-1234 breakdown: location: Dorris city: South Lake Tahoe state: KY created_at: '2025-04-07T18:58:31Z' updated_at: '2025-04-07T18:58:31Z' relationships: registered_asset: data: type: registered_assets id: 552fb6b4-bbce-452b-bb60-8f40ca6e8eb3 service_provider: data: type: service_providers id: 49babff7-536d-4262-b267-de66a19452cf case: data: type: cases id: e3dd4797-3215-4522-a2a8-7f3ccdb1fd44 primary_contact: data: type: contacts id: 7da042d2-c47b-4748-ba65-c114adf1cf62 schema: $ref: '#/components/schemas/service_request' '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - status: '404' code: decisiv:resource:001 title: Resource Identifier - Not Found detail: The parent resource could not be found source: parameter: id schema: $ref: '#/components/schemas/errors_response' '424': description: This response may occur when there is an unresolved data dependency or configuration required inside of the Decisiv Platform preventing access to the requested action. content: application/vnd.api+json: example: errors: - title: Failed Dependency detail: Failed Dependency code: '424' status: '424' schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' put: summary: Updates a Service Request availavable for the requested account operationId: updateServiceRequest description: Updates an existing Service Request for the requested account. tags: - Service Requests parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: id in: path description: The resource uuid required: true schema: type: string - name: X-DECISIV-SILENCE-EVENTS in: header required: false schema: type: array items: type: string enum: - service_request:canceled - decisiv:asset_management:service_request:canceled description: Corresponding webhook events which can be muted for the given transaction responses: '200': description: Show the updated Service Request content: application/vnd.api+json: example: data: id: 22027e64-4191-41fd-b0e2-6f6c489d8b2a type: service_requests attributes: complaint: transmission leaks on left side status: Accepted po_number: PO836743 auth_number: AUTH984107 note: Initial Note asset_information: odometer_value: 1234566 odometer_unit: mi reference_number: 123245 primary_contact: first_name: Gandalf last_name: The Gray email: gandalf@thegray.com relation: Frodo phone: mobile: (582) 123-1234 work: (524) 123-1234 driver: first_name: Bilbo last_name: Baggins email: bilbo@baggins.com phone: mobile: (582) 123-1234 work: (524) 123-1234 breakdown: location: Dorris city: South Lake Tahoe state: KY created_at: '2025-04-07T18:58:31Z' updated_at: '2025-04-07T18:58:31Z' relationships: registered_asset: data: type: registered_assets id: 552fb6b4-bbce-452b-bb60-8f40ca6e8eb3 service_provider: data: type: service_providers id: 49babff7-536d-4262-b267-de66a19452cf case: data: type: cases id: e3dd4797-3215-4522-a2a8-7f3ccdb1fd44 primary_contact: data: type: contacts id: 7da042d2-c47b-4748-ba65-c114adf1cf62 schema: $ref: '#/components/schemas/service_request' '400': description: This response may occur when an invalid request has been provided to the server. The request may be corrected by the consumer and resubmitted. content: application/vnd.api+json: example: errors: - title: Filter not allowed detail: '''{{filter_name}}'' is not allowed. Valid filters: {{filters_list}}' code: decisiv:filters:001 status: '400' source: parameter: filter[filter_name] - title: Bad Request detail: Invalid value for X-DECISIV-SILENCE-EVENTS header code: decisiv:silence_webhook_events:001 status: '400' schema: $ref: '#/components/schemas/errors_response' '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '404': description: This response may occur when the requested resource is not found. content: application/vnd.api+json: example: errors: - status: '404' code: decisiv:resource:001 title: Resource Identifier - Not Found detail: The parent resource could not be found source: parameter: id schema: $ref: '#/components/schemas/errors_response' '422': description: This response may occur when there is an error during the request processing. content: application/vnd.api+json: example: errors: - status: '422' code: decisiv:base:unexpected_value:103 title: Invalid value detail: 'Invalid Value for attribute - Valid values are: ["canceled", "pending"]' source: pointer: /data/attributes/status schema: $ref: '#/components/schemas/errors_response' '424': description: This response may occur when there is an unresolved data dependency or configuration required inside of the Decisiv Platform preventing access to the requested action. content: application/vnd.api+json: example: errors: - title: Failed Dependency detail: Failed Dependency code: '424' status: '424' schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/service_request' examples: Service Request: value: data: id: 22027e64-4191-41fd-b0e2-6f6c489d8b2a type: service_requests attributes: status: canceled /asset_management/{srm_account_id}/v1/service_requests/{id}/cancel: post: summary: Cancel service request operationId: cancelServiceRequest description: Cancels a Service Request. tags: - Service Requests parameters: - name: srm_account_id in: path description: The account ID for SRM required: true schema: type: string - name: id in: path schema: type: string format: uuid description: The resource UUID required: true responses: '200': description: The request has succeeded. It may or may not return a single resource of collection of resources. content: application/vnd.api+json: example: data: id: 22027e64-4191-41fd-b0e2-6f6c489d8b2a type: service_requests attributes: complaint: transmission leaks on left side po_number: PO836743 auth_number: AUTH984107 note: Initial Note asset_information: odometer_value: 1234566 odometer_unit: mi reference_number: 123245 primary_contact: first_name: Gandalf last_name: The Gray email: gandalf@thegray.com relation: Frodo phone: mobile: (582) 123-1234 work: (524) 123-1234 driver: first_name: Bilbo last_name: Baggins email: bilbo@baggins.com phone: mobile: (582) 123-1234 work: (524) 123-1234 breakdown: location: Dorris city: South Lake Tahoe state: KY created_at: '2025-04-07T18:58:31Z' updated_at: '2025-04-07T18:58:31Z' status: Canceled relationships: registered_asset: data: type: registered_assets id: 552fb6b4-bbce-452b-bb60-8f40ca6e8eb3 service_provider: data: type: service_providers id: 49babff7-536d-4262-b267-de66a19452cf case: data: null primary_contact: data: type: contacts id: 7da042d2-c47b-4748-ba65-c114adf1cf62 schema: $ref: '#/components/schemas/service_request' '401': description: This response may occur when the access token provided within the Authorization token has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '422': description: invalid previous status content: application/vnd.api+json: example: errors: - code: decisiv:sublet_requests:005 status: '422' title: Unprocessable record detail: Only Sublet Requests with a status of 'Canceled' may be reopened by the requesting account schema: $ref: '#/components/schemas/errors_response' '424': description: This response may occur when there is an unresolved data dependency or configuration required inside of the Decisiv Platform preventing access to the requested action. content: application/vnd.api+json: example: errors: - title: Failed Dependency detail: Failed Dependency code: '424' status: '424' schema: $ref: '#/components/schemas/errors_response' '428': description: This response represents requests to a module or endpoint which can not immediately be accessed due to the Account permissions and subscriptions in the Decisiv Platform. content: application/vnd.api+json: example: errors: - title: Precondition Required detail: Precondition Required code: '428' status: '428' schema: $ref: '#/components/schemas/errors_response' '429': description: This response will often be associated as a result of an over abundance of calls by a specific Application, Account, or IP Address resulting in a required cool off period. content: application/vnd.api+json: example: errors: - code: '429' detail: The maximum number of requests for this application has been far exceeded with the given credentials. status: '429' title: Too Many Requests schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' /asset_management/{srm_account_id}/v1/vmrs/asset_types: get: operationId: listVmrsAssetTypes description: 'Returns the catalog of VMRS Code Key 2 ("Equipment Category" / asset type) reference values. Use this to populate dropdowns and validate `vmrs_asset_type` values before sending them on asset write endpoints. The response payload is byte-identical to the equivalent route under `service_management` — both URLs are served by the same backend controller. Results are sorted alphabetically by `code` (ascending), with `description` as a deterministic tiebreaker. ' summary: List all VMRS Asset Types (Code Key 2) tags: - VMRS parameters: - name: srm_account_id in: path required: true description: The SRM Account ID. schema: type: string - name: page[number] in: query required: false schema: type: integer default: 1 minimum: 1 description: Sets the desired `page` when encountering larger result sets. - name: page[size] in: query required: false schema: type: integer default: 25 minimum: 1 description: Sets the desired maximum number of results per page. responses: '200': description: Returns the list of VMRS Asset Types. content: application/vnd.api+json: example: data: - id: '01' type: decisiv_vmrs_asset_types attributes: code_key: '2' code_key_name: Equipment Category code: '01' description: Truck - id: '02' type: decisiv_vmrs_asset_types attributes: code_key: '2' code_key_name: Equipment Category code: '02' description: Tractor - id: D type: decisiv_vmrs_asset_types attributes: code_key: '2' code_key_name: Equipment Category code: D description: Agricultural Equipment meta: record-count: 78 schema: $ref: '#/components/schemas/vmrs_asset_types' '401': description: This response may occur when the access token provided within the Authorization header has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: The authenticated user does not have the `vmrs:ReadAssetTypes` permission for the requested account. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: Account not found. content: application/vnd.api+json: example: errors: - status: '404' title: Record not found source: parameter: srm_account_id schema: $ref: '#/components/schemas/errors_response' '428': description: This response represents requests to a module or endpoint which can not immediately be accessed due to the Account permissions and subscriptions in the Decisiv Platform. content: application/vnd.api+json: example: errors: - status: '428' code: decisiv:access:003 title: Precondition required detail: OAuth Application does not have appropriate provisioning to access this resource schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' /asset_management/{srm_account_id}/v1/vmrs/reasons_for_repair: get: operationId: listVmrsReasonsForRepair description: 'Returns the catalog of VMRS Code Key 14 ("Reason for Repair") reference values. Use this to populate dropdowns and validate reason-for-repair values before sending them on case/line item write endpoints. The response payload is byte-identical to the equivalent route under `service_management` — both URLs are served by the same backend controller. Results are sorted by `code` (ascending), with `reason` as a deterministic tiebreaker. Each record also carries a `category` attribute (the VMRS `repair_type` grouping the reason belongs to). ' summary: List all VMRS Reasons for Repair (Code Key 14) tags: - VMRS parameters: - name: srm_account_id in: path required: true description: The SRM Account ID. schema: type: string - name: page[number] in: query required: false schema: type: integer default: 1 minimum: 1 description: Sets the desired `page` when encountering larger result sets. - name: page[size] in: query required: false schema: type: integer default: 25 minimum: 1 description: Sets the desired maximum number of results per page. responses: '200': description: Returns the list of VMRS Reasons for Repair. content: application/vnd.api+json: example: data: - id: '01' type: decisiv_vmrs_reasons_for_repair attributes: code_key: '14' code_key_name: Reason for Repair code: '01' description: Breakdown category: Maintenance - id: '22' type: decisiv_vmrs_reasons_for_repair attributes: code_key: '14' code_key_name: Reason for Repair code: '22' description: Vandalism category: Outside Influence - id: '70' type: decisiv_vmrs_reasons_for_repair attributes: code_key: '14' code_key_name: Reason for Repair code: '70' description: Tow-in category: Management Decision meta: record-count: 60 schema: $ref: '#/components/schemas/vmrs_reasons_for_repair' '401': description: This response may occur when the access token provided within the Authorization header has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: The authenticated user does not have the `vmrs:ReadReasonsForRepair` permission for the requested account. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: Account not found. content: application/vnd.api+json: example: errors: - status: '404' title: Record not found source: parameter: srm_account_id schema: $ref: '#/components/schemas/errors_response' '428': description: This response represents requests to a module or endpoint which can not immediately be accessed due to the Account permissions and subscriptions in the Decisiv Platform. content: application/vnd.api+json: example: errors: - status: '428' code: decisiv:access:003 title: Precondition required detail: OAuth Application does not have appropriate provisioning to access this resource schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' /asset_management/{srm_account_id}/v1/vmrs/repair_priorities: get: operationId: listVmrsRepairPriorities description: 'Returns the catalog of VMRS Code Key 16 ("Repair Priority Class") reference values. Use this to populate dropdowns and validate repair-priority values before sending them on case/line item write endpoints. The response payload is byte-identical to the equivalent route under `service_management` — both URLs are served by the same backend controller. Results are sorted by `code` (ascending). ' summary: List all VMRS Repair Priorities (Code Key 16) tags: - VMRS parameters: - name: srm_account_id in: path required: true description: The SRM Account ID. schema: type: string - name: page[number] in: query required: false schema: type: integer default: 1 minimum: 1 description: Sets the desired `page` when encountering larger result sets. - name: page[size] in: query required: false schema: type: integer default: 25 minimum: 1 description: Sets the desired maximum number of results per page. responses: '200': description: Returns the list of VMRS Repair Priorities. content: application/vnd.api+json: example: data: - id: '1' type: decisiv_vmrs_repair_priorities attributes: code_key: '16' code_key_name: Repair Priority Class code: '1' description: Scheduled - id: '2' type: decisiv_vmrs_repair_priorities attributes: code_key: '16' code_key_name: Repair Priority Class code: '2' description: Non-Scheduled - id: '3' type: decisiv_vmrs_repair_priorities attributes: code_key: '16' code_key_name: Repair Priority Class code: '3' description: Emergency meta: record-count: 3 schema: $ref: '#/components/schemas/vmrs_repair_priorities' '401': description: This response may occur when the access token provided within the Authorization header has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: The authenticated user does not have the `vmrs:ReadRepairPriorities` permission for the requested account. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: Account not found. content: application/vnd.api+json: example: errors: - status: '404' title: Record not found source: parameter: srm_account_id schema: $ref: '#/components/schemas/errors_response' '428': description: This response represents requests to a module or endpoint which can not immediately be accessed due to the Account permissions and subscriptions in the Decisiv Platform. content: application/vnd.api+json: example: errors: - status: '428' code: decisiv:access:003 title: Precondition required detail: OAuth Application does not have appropriate provisioning to access this resource schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' /asset_management/{srm_account_id}/v1/vmrs/repair_sites: get: operationId: listVmrsRepairSites description: 'Returns the catalog of VMRS Code Key 17 ("Repair Site") reference values. Use this to populate dropdowns and validate repair-site values before sending them on case/line item write endpoints. The response payload is byte-identical to the equivalent route under `service_management` — both URLs are served by the same backend controller. Results are sorted by `code` (ascending). ' summary: List all VMRS Repair Sites (Code Key 17) tags: - VMRS parameters: - name: srm_account_id in: path required: true description: The SRM Account ID. schema: type: string - name: page[number] in: query required: false schema: type: integer default: 1 minimum: 1 description: Sets the desired `page` when encountering larger result sets. - name: page[size] in: query required: false schema: type: integer default: 25 minimum: 1 description: Sets the desired maximum number of results per page. responses: '200': description: Returns the list of VMRS Repair Sites. content: application/vnd.api+json: example: data: - id: '1' type: decisiv_vmrs_repair_sites attributes: code_key: '17' code_key_name: Repair Site code: '1' description: Facility (Fleet) - id: '2' type: decisiv_vmrs_repair_sites attributes: code_key: '17' code_key_name: Repair Site code: '2' description: Field - id: '3' type: decisiv_vmrs_repair_sites attributes: code_key: '17' code_key_name: Repair Site code: '3' description: Terminal meta: record-count: 3 schema: $ref: '#/components/schemas/vmrs_repair_sites' '401': description: This response may occur when the access token provided within the Authorization header has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: The authenticated user does not have the `vmrs:ReadRepairSites` permission for the requested account. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: Account not found. content: application/vnd.api+json: example: errors: - status: '404' title: Record not found source: parameter: srm_account_id schema: $ref: '#/components/schemas/errors_response' '428': description: This response represents requests to a module or endpoint which can not immediately be accessed due to the Account permissions and subscriptions in the Decisiv Platform. content: application/vnd.api+json: example: errors: - status: '428' code: decisiv:access:003 title: Precondition required detail: OAuth Application does not have appropriate provisioning to access this resource schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' /asset_management/{srm_account_id}/v1/vmrs/components: get: operationId: listVmrsComponents description: 'Returns the catalog of VMRS Code Key 33 ("Component") reference values. Use this to populate dropdowns and validate `component` values before sending them on case/line item write endpoints. The response payload is byte-identical to the equivalent route under `service_management` — both URLs are served by the same backend controller. Results are sorted by `code` (ascending). ' summary: List all VMRS Components (Code Key 33) tags: - VMRS parameters: - name: srm_account_id in: path required: true description: The SRM Account ID. schema: type: string - name: page[number] in: query required: false schema: type: integer default: 1 minimum: 1 description: Sets the desired `page` when encountering larger result sets. - name: page[size] in: query required: false schema: type: integer default: 25 minimum: 1 description: Sets the desired maximum number of results per page. responses: '200': description: Returns the list of VMRS Components. content: application/vnd.api+json: example: data: - id: 000-000-000 type: decisiv_vmrs_components attributes: code_key: '33' code_key_name: Component code: 000-000-000 description: Cab, Climate Control, Instrumentation, & Aerodynamic Devices Group - id: 001-000-000 type: decisiv_vmrs_components attributes: code_key: '33' code_key_name: Component code: 001-000-000 description: Air Conditioning, Heating & Ventilating System meta: record-count: 2 schema: $ref: '#/components/schemas/vmrs_components' '401': description: This response may occur when the access token provided within the Authorization header has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: The authenticated user does not have the `vmrs:ReadComponents` permission for the requested account. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: Account not found. content: application/vnd.api+json: example: errors: - status: '404' title: Record not found source: parameter: srm_account_id schema: $ref: '#/components/schemas/errors_response' '428': description: This response represents requests to a module or endpoint which can not immediately be accessed due to the Account permissions and subscriptions in the Decisiv Platform. content: application/vnd.api+json: example: errors: - status: '428' code: decisiv:access:003 title: Precondition required detail: OAuth Application does not have appropriate provisioning to access this resource schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' /asset_management/{srm_account_id}/v1/vmrs/operator_reports: get: operationId: listVmrsOperatorReports description: 'Returns the catalog of VMRS Code Key 82 ("Operator Vehicle/Equipment Condition Report") reference values. Use this to populate dropdowns and validate `operator_reports` values before sending them on line item / estimate write endpoints. The response payload is byte-identical to the equivalent route under `service_management` — both URLs are served by the same backend controller. Results are sorted by `code` (ascending). ' summary: List all VMRS Operator Reports (Code Key 82) tags: - VMRS parameters: - name: srm_account_id in: path required: true description: The SRM Account ID. schema: type: string - name: page[number] in: query required: false schema: type: integer default: 1 minimum: 1 description: Sets the desired `page` when encountering larger result sets. - name: page[size] in: query required: false schema: type: integer default: 25 minimum: 1 description: Sets the desired maximum number of results per page. responses: '200': description: Returns the list of VMRS Operator Reports. content: application/vnd.api+json: example: data: - id: '001' type: decisiv_vmrs_operator_reports attributes: code_key: '82' code_key_name: Operator Vehicle/Equipment Condition Report code: '001' description: Aim/Alignment (Out of Adjustment) - id: '050' type: decisiv_vmrs_operator_reports attributes: code_key: '82' code_key_name: Operator Vehicle/Equipment Condition Report code: '050' description: Brakes, Grabbing - id: '190' type: decisiv_vmrs_operator_reports attributes: code_key: '82' code_key_name: Operator Vehicle/Equipment Condition Report code: '190' description: ABS, Light Stays On meta: record-count: 136 schema: $ref: '#/components/schemas/vmrs_operator_reports' '401': description: This response may occur when the access token provided within the Authorization header has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: The authenticated user does not have the `vmrs:ReadOperatorReports` permission for the requested account. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: Account not found. content: application/vnd.api+json: example: errors: - status: '404' title: Record not found source: parameter: srm_account_id schema: $ref: '#/components/schemas/errors_response' '428': description: This response represents requests to a module or endpoint which can not immediately be accessed due to the Account permissions and subscriptions in the Decisiv Platform. content: application/vnd.api+json: example: errors: - status: '428' code: decisiv:access:003 title: Precondition required detail: OAuth Application does not have appropriate provisioning to access this resource schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' /asset_management/{srm_account_id}/v1/vmrs/positions: get: operationId: listVmrsPositions description: 'Returns the catalog of VMRS Code Key 79 ("Position") reference values. Use this to populate dropdowns and validate `positions` values before sending them on line item / estimate write endpoints. Results are sorted by `code` (ascending). ' summary: List all VMRS Positions (Code Key 79) tags: - VMRS parameters: - name: srm_account_id in: path required: true description: The SRM Account ID. schema: type: string - name: page[number] in: query required: false schema: type: integer default: 1 minimum: 1 description: Sets the desired `page` when encountering larger result sets. - name: page[size] in: query required: false schema: type: integer default: 25 minimum: 1 description: Sets the desired maximum number of results per page. responses: '200': description: Returns the list of VMRS Positions. content: application/vnd.api+json: example: data: - id: '00' type: decisiv_vmrs_positions attributes: code_key: '79' code_key_name: Position code: '00' description: Not Applicable - id: '01' type: decisiv_vmrs_positions attributes: code_key: '79' code_key_name: Position code: '01' description: Front - id: '02' type: decisiv_vmrs_positions attributes: code_key: '79' code_key_name: Position code: '02' description: Front Left meta: record-count: 162 schema: $ref: '#/components/schemas/vmrs_positions' '401': description: This response may occur when the access token provided within the Authorization header has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: The authenticated user does not have the `vmrs:ReadPositions` permission for the requested account. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: Account not found. content: application/vnd.api+json: example: errors: - status: '404' title: Record not found source: parameter: srm_account_id schema: $ref: '#/components/schemas/errors_response' '428': description: This response represents requests to a module or endpoint which can not immediately be accessed due to the Account permissions and subscriptions in the Decisiv Platform. content: application/vnd.api+json: example: errors: - status: '428' code: decisiv:access:003 title: Precondition required detail: OAuth Application does not have appropriate provisioning to access this resource schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' /asset_management/{srm_account_id}/v1/vmrs/work_accomplished: get: operationId: listVmrsWorkAccomplished description: 'Returns the catalog of VMRS Code Key 15 ("Work Accomplished") reference values. Use this to populate dropdowns and validate `work_accomplished` values before sending them on line item / estimate write endpoints. Results are sorted by `code` (ascending). ' summary: List all VMRS Work Accomplished values (Code Key 15) tags: - VMRS parameters: - name: srm_account_id in: path required: true description: The SRM Account ID. schema: type: string - name: page[number] in: query required: false schema: type: integer default: 1 minimum: 1 description: Sets the desired `page` when encountering larger result sets. - name: page[size] in: query required: false schema: type: integer default: 25 minimum: 1 description: Sets the desired maximum number of results per page. responses: '200': description: Returns the list of VMRS Work Accomplished values. content: application/vnd.api+json: example: data: - id: '01' type: decisiv_vmrs_work_accomplished attributes: code_key: '15' code_key_name: Work Accomplished code: '01' description: Adjust - id: '02' type: decisiv_vmrs_work_accomplished attributes: code_key: '15' code_key_name: Work Accomplished code: '02' description: Clean - id: '03' type: decisiv_vmrs_work_accomplished attributes: code_key: '15' code_key_name: Work Accomplished code: '03' description: Replace with New meta: record-count: 68 schema: $ref: '#/components/schemas/vmrs_work_accomplished_list' '401': description: This response may occur when the access token provided within the Authorization header has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: The authenticated user does not have the `vmrs:ReadWorkAccomplished` permission for the requested account. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: Account not found. content: application/vnd.api+json: example: errors: - status: '404' title: Record not found source: parameter: srm_account_id schema: $ref: '#/components/schemas/errors_response' '428': description: This response represents requests to a module or endpoint which can not immediately be accessed due to the Account permissions and subscriptions in the Decisiv Platform. content: application/vnd.api+json: example: errors: - status: '428' code: decisiv:access:003 title: Precondition required detail: OAuth Application does not have appropriate provisioning to access this resource schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' /asset_management/{srm_account_id}/v1/vmrs/technician_part_failure_codes: get: operationId: listVmrsTechnicianPartFailureCodes description: 'Returns the catalog of VMRS Code Key 18 ("Technician Part Failure Code") reference values. Use this to populate dropdowns and validate `technician_part_failure_codes` values before sending them on line item / estimate write endpoints. The response payload is byte-identical to the equivalent route under `service_management` — both URLs are served by the same backend controller. Results are sorted by `code` (ascending). ' summary: List all VMRS Technician Part Failure Codes (Code Key 18) tags: - VMRS parameters: - name: srm_account_id in: path required: true description: The SRM Account ID. schema: type: string - name: page[number] in: query required: false schema: type: integer default: 1 minimum: 1 description: Sets the desired `page` when encountering larger result sets. - name: page[size] in: query required: false schema: type: integer default: 25 minimum: 1 description: Sets the desired maximum number of results per page. responses: '200': description: Returns the list of VMRS Technician Part Failure Codes. content: application/vnd.api+json: example: data: - id: '00' type: decisiv_vmrs_technician_part_failure_codes attributes: code_key: '18' code_key_name: Technician Part Failure Code code: '00' description: No Failure - id: '01' type: decisiv_vmrs_technician_part_failure_codes attributes: code_key: '18' code_key_name: Technician Part Failure Code code: '01' description: Battered, Hammered - id: '02' type: decisiv_vmrs_technician_part_failure_codes attributes: code_key: '18' code_key_name: Technician Part Failure Code code: '02' description: Burned, Scorched, Melted, Blistered meta: record-count: 109 schema: $ref: '#/components/schemas/vmrs_technician_part_failure_codes' '401': description: This response may occur when the access token provided within the Authorization header has expired. content: application/vnd.api+json: example: errors: - title: Access unauthorized detail: Access unauthorized code: decisiv::access_token:001 status: '401' schema: $ref: '#/components/schemas/errors_response' '403': description: The authenticated user does not have the `vmrs:ReadTechnicianPartFailureCodes` permission for the requested account. content: application/vnd.api+json: example: errors: - title: Forbidden detail: User does not have permission to perform this action on the requested resource(s) code: decisiv:access:001 status: '403' schema: $ref: '#/components/schemas/errors_response' '404': description: Account not found. content: application/vnd.api+json: example: errors: - status: '404' title: Record not found source: parameter: srm_account_id schema: $ref: '#/components/schemas/errors_response' '428': description: This response represents requests to a module or endpoint which can not immediately be accessed due to the Account permissions and subscriptions in the Decisiv Platform. content: application/vnd.api+json: example: errors: - status: '428' code: decisiv:access:003 title: Precondition required detail: OAuth Application does not have appropriate provisioning to access this resource schema: $ref: '#/components/schemas/errors_response' '504': description: This response may occur when there is an unexpected system timeout. content: application/vnd.api+json: example: errors: - code: '504' detail: Gateway timeout error status: '504' title: Gateway timeout error schema: $ref: '#/components/schemas/errors_response' components: schemas: error_response: type: object properties: status: type: string title: type: string detail: type: - string - 'null' code: type: - string - 'null' source: type: object properties: parameter: type: - string - 'null' pointer: type: - string - 'null' links: type: object description: Links related to this error (e.g. documentation reference). additionalProperties: type: string format: uri required: - status - title errors_response: type: object properties: errors: type: array items: $ref: '#/components/schemas/error_response' required: - errors relationship_object: type: object properties: data: type: - object - 'null' properties: id: type: string type: type: string required: - id - type required: - data relationship_objects: type: object properties: data: type: array items: type: - object - 'null' properties: id: type: string type: type: string required: - id - type required: - data activate_deactivated_asset: type: object required: - data properties: data: type: object properties: id: type: string format: uuid type: type: string attributes: type: object required: - attributes - type - id create_attachment: type: object required: - data properties: data: type: object properties: type: type: string attributes: type: object properties: description: type: string maxLength: 1024 description: The description of the file url: type: string maxLength: 255 description: The URL of the file required: - url required: - attributes - type attachment: type: object required: - data properties: data: type: object properties: id: type: string format: uuid type: type: string attributes: type: object properties: description: type: string maxLength: 1024 description: The description of the file filename: type: - string - 'null' maxLength: 256 description: The name of the file. Null when the attachment was created via URL. example: example.pdf size: type: - integer - 'null' maximum: 10485760 description: The file size in bytes (max allowed is 10 megabytes). Null when the attachment was created via URL. example: 2684355 format: type: - string - 'null' description: The file content type. Null when the attachment was created via URL. example: application/pdf download_url: type: string description: A temporary URL to download the file, or the external URL when the attachment was created via URL. example: https://decisiv.net/shared/downloads/7746422/get_authed?filename=example.pdf&key=184bddd6479a3e3d created_at: type: string format: date-time description: '`ISO 8601` timestamp indicating when the attachment was created' example: '2023-10-01T12:00:00Z' updated_at: type: string format: date-time description: '`ISO 8601` timestamp indicating when the attachment was updated' example: '2023-10-01T12:00:00Z' required: - download_url - created_at - updated_at relationships: type: object properties: publisher: $ref: '#/components/schemas/relationship_object' subject: $ref: '#/components/schemas/relationship_object' required: - attributes - type - id attachments: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/attachment_properties-data' meta: type: object build_information: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/manufacturer_build_information' meta: type: object manufacturer_build_information: type: object properties: id: type: string description: The manufactured asset identifier type: type: string example: manufacturer_build_information attributes: type: object properties: manufacturer_specific_attributes: type: object additionalProperties: true description: Vendor-specific build data for the asset. The structure varies by manufacturer. required: - manufacturer_specific_attributes required: - attributes - type - id cancel_service_request: type: object required: - data properties: data: type: object properties: id: type: string format: uuid type: type: string attributes: type: object additionalProperties: true case_summary: type: object required: - data properties: data: type: object properties: id: type: string format: uuid type: type: string attributes: type: object properties: content: type: string description: The case summary text example: Vehicle arrived with check engine light on. Diagnosed as faulty O2 sensor. Replaced and cleared codes. created_at: type: string format: date-time description: '`ISO 8601` timestamp indicating when the case summary was created' example: '2023-10-01T12:00:00Z' updated_at: type: string format: date-time description: '`ISO 8601` timestamp indicating when the case summary was last updated' example: '2023-10-01T12:00:00Z' required: - content - created_at - updated_at relationships: type: object properties: case: $ref: '#/components/schemas/relationship_object' required: - attributes - type - id case_summaries: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/data' meta: type: object case: type: object required: - data properties: data: type: object properties: id: type: string format: uuid type: type: string enum: - cases attributes: type: object properties: complaint: type: string description: Initially reported information from driver or other customer entity examples: - Broken truck po_number: type: string description: The Purchase Order number examples: - '1234' auth_number: type: string description: The Authorization number examples: - '1234' ro_number: type: string description: The Repair Order number examples: - '1234' reference_number: type: number description: Integer representation of the Case ID inside of the User Interface closed: type: boolean description: Indicates whether the case has been closed. repair_status: type: string description: Status of the repair examples: - Hold (auth) status: type: string description: Status of the case examples: - Pick-up invoice: type: object description: The invoice information for the case properties: total: type: number description: The total amount of the invoice number: type: string description: The invoice number invoice_date: type: string format: date description: The date of the invoice examples: - '2025-04-07' event_timestamps: type: object description: All the timestamps related to the case properties: started_at: type: string format: date-time description: '`ISO 8601` timestamp indicating when the Case was first opened' examples: - '2022-04-14T05:23:45Z' requested_completion_time: type: string format: date-time description: '`ISO 8601` timestamp indicating the completion time of the case' examples: - '2022-04-14T05:23:45Z' requested_appointment_time: type: string format: date-time description: '`ISO 8601` timestamp indicating the appointment time' examples: - '2022-04-14T05:23:45Z' actual_time_to_repair: type: string format: date-time description: '`ISO 8601` timestamp indicating the time spent to repair the asset' examples: - '2022-04-14T05:23:45Z' estimated_time_to_repair: type: string format: date-time description: '`ISO 8601` timestamp indicating the time estimated to repair the asset' examples: - '2022-04-14T05:23:45Z' followup_time: type: string format: date-time description: '`ISO 8601` timestamp indicating the next check-in point between Customer / Provider' examples: - '2022-04-14T05:23:45Z' asset_arrived: type: string format: date-time description: '`ISO 8601` timestamp indicating when the Asset arrived' examples: - '2022-04-14T05:23:45Z' asset_checked_in: type: string format: date-time description: '`ISO 8601` timestamp indicating when the check-in was performed' examples: - '2022-04-14T05:23:45Z' closed_at: type: string format: date-time description: '`ISO 8601` timestamp indicating when the Case was marked as completed and closed' examples: - '2022-04-14T05:23:45Z' asset_uptime: type: string format: date-time description: '`ISO 8601` timestamp indicating when the Asset became operational, once again' examples: - '2022-04-14T05:23:45Z' asset_downtime: type: string format: date-time description: '`ISO 8601` timestamp indicating when the Asset was considered no longer operational' examples: - '2022-04-14T05:23:45Z' pricing: type: object description: Financial totals for the case, sourced directly from the Estimate properties: parts_total: type: number description: Total cost of parts examples: - 432.5 labor_total: type: number description: Total cost of labor examples: - 250 core_total: type: number description: Total cost of cores examples: - 75 tax: type: number description: Total tax amount examples: - 32.18 haz_waste: type: number description: Total hazardous waste charge examples: - 15 asset_information: type: object description: The asset information when the case was created properties: odometer_value: type: number description: Integer representation about the asset odometer odometer_unit: type: string description: Abbreviation for the asset odometer unit (e.g., `mi` for miles or `km` for kilometers). examples: - mi unit_number: type: string description: The unit number cargo: type: object properties: unit: type: - string - 'null' description: The unit number loaded: type: boolean description: Indicates whether the cargo is loaded. load: type: - string - 'null' description: The load amount breakdown: type: object description: Information about the breakdown location properties: city: type: string description: City of breakdown examples: - North Haven location: type: string description: Exact map location of the breakdown examples: - 41.395022,-72.856326 state: type: string description: State of the breakdown examples: - CT updated_at: type: string format: date-time description: '`ISO 8601` timestamp indicating when the case was last updated' examples: - '2022-04-14T05:23:45Z' created_at: type: string format: date-time description: '`ISO 8601` timestamp indicating when the case was created' examples: - '2022-04-14T05:23:45Z' relationships: type: object properties: registered_asset: $ref: '#/components/schemas/relationship_object' service_provider: $ref: '#/components/schemas/relationship_object' assignee: $ref: '#/components/schemas/relationship_object' billing_contact: $ref: '#/components/schemas/relationship_object' primary_contact: $ref: '#/components/schemas/relationship_object' estimates: $ref: '#/components/schemas/relationship_objects' required: - attributes - type - id cases: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/properties-data' meta: type: object modify_case_contact_relationship: type: object required: - data properties: data: type: object description: JSON:API resource linkage. `id` must be the `uuid` of one of the fleet's own registered contacts; `type` may be `contacts`, `registered_contacts`, or `recipients`, since a registered contact can be referenced by any of these resource types. properties: type: type: string enum: - contacts - registered_contacts - recipients id: type: string format: uuid required: - type - id contact: type: object required: - data properties: data: type: object properties: id: type: string format: uuid type: type: string enum: - contacts attributes: type: object properties: first_name: type: string description: First name of the contact minLength: 2 maxLength: 100 last_name: type: string description: Last name of the contact minLength: 2 maxLength: 100 notes: type: string description: Notes about the contact minLength: 2 maxLength: 200 address1: type: string description: Primary address information maxLength: 100 address2: type: string description: Secondary address information maxLength: 100 city: type: string description: City in which the business resides maxLength: 100 state: type: string description: Second part of the `ISO 3166-2` code indicating the state minLength: 1 maxLength: 3 example: NJ country: type: string description: '`ISO 3166-1` alpha-2 code indicating the country' minLength: 2 maxLength: 2 example: US postal_code: type: string description: Postal ZIP Code maxLength: 20 communication: type: array description: Array of communication methods for the contact items: type: object properties: method_type: type: string description: Type of communication method (e.g., email, mobile) enum: - email - mobile value: type: string description: Value of the communication method (e.g., email address, phone number) minLength: 2 maxLength: 254 notify: type: boolean description: Indicates if notifications should be sent to this contact required: - method_type - value - notify required: - first_name - last_name - communication relationships: type: object required: - depot properties: depot: $ref: '#/components/schemas/relationship_object' required: - attributes - relationships - type - id contact_by_id: example: data: id: 014ee85e-a183-4bf7-b4d7-67e758fa2b2a type: contacts attributes: first_name: John last_name: Doe address1: 9009 Sunset Blvd address2: Door 5 city: West Hollywood state: CA postal_code: '90069' country: US communication: - method_type: email value: john.doe@example.com notify: true - method_type: mobile value: '+1234567890' notify: true notes: Sample notes about the contact relationships: depot: data: id: 73814a82-d26c-4241-8421-a1a622ac9f71 type: depots type: object properties: data: type: object properties: id: type: string format: uuid type: type: string enum: - contacts attributes: type: object properties: first_name: type: string description: First name of the contact maxLength: 100 last_name: type: string description: Last name of the contact maxLength: 100 notes: type: string description: Notes about the contact maxLength: 200 address1: type: string description: Primary address information maxLength: 100 address2: type: string description: Secondary address information maxLength: 100 city: type: string description: City in which the business resides maxLength: 100 state: type: string description: Second part of the `ISO 3166-2` code indicating the state minLength: 1 maxLength: 3 example: NJ country: type: string description: '`ISO 3166-1` alpha-2 code indicating the country' minLength: 2 maxLength: 2 example: US postal_code: type: string description: Postal ZIP Code maxLength: 20 communication: type: array description: Array of communication methods for the contact items: type: object properties: method_type: type: string description: Type of communication method (e.g., email, mobile) enum: - email - mobile value: type: string description: Value of the communication method (e.g., email address, phone number) minLength: 2 maxLength: 254 notify: type: boolean description: Indicates if notifications should be sent to this contact required: - method_type - value - notify required: - first_name - last_name - communication relationships: type: object required: - depot properties: depot: $ref: '#/components/schemas/relationship_object' required: - attributes - relationships - type - id required: - data contacts: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/contact_properties-data' meta: type: object create_note: type: object required: - data properties: data: type: object properties: type: type: string enum: - notes attributes: type: object required: - message - public properties: message: type: string description: The message itself example: This is a note public: type: boolean description: If the message is public example: true relationships: type: object required: - recipients properties: recipients: type: array description: The recipients that will receive the message, one or more allowed items: type: object properties: data: type: object required: - type - id properties: type: type: string example: recipients enum: - recipients - participants id: type: string format: uuid description: The uuid of the receiving user, *one or more allowed* example: 1ed4f5ce-e426-11eb-a848-4fd53322f5bb create_note_participant: type: object required: - data properties: data: type: object properties: type: type: string attributes: type: object required: - message - public properties: message: type: string description: The message itself example: This is a note public: type: boolean description: If the message is public example: true relationships: type: object required: - recipients properties: recipients: type: array description: The participants that will receive the message items: type: object properties: data: type: object properties: type: type: string example: participants enum: - participants id: type: string format: uuid description: The uuid of the participant, *only one is permitted* example: 1ed4f5ce-e426-11eb-a848-4fd53322f5bb create_note_to_provider: type: object required: - data properties: data: type: object properties: type: type: string enum: - notes attributes: type: object properties: message: type: string description: The message itself examples: - This is a note public: type: boolean description: If the message is public examples: - true required: - message - public relationships: properties: recipients: $ref: '#/components/schemas/relationship_object' srm_account: $ref: '#/components/schemas/relationship_object' required: - type - attributes create_registered_asset: type: object required: - data properties: data: type: object properties: type: type: string enum: - registered_assets attributes: type: object properties: vin: type: string description: 17 digit vehicle identification number minLength: 17 maxLength: 17 serial_number: type: string description: Production number of the asset minLength: 6 maxLength: 36 unit_number: type: string maxLength: 255 description: Identification number commonly used on assets residing within a fleet chassis_id: type: string maxLength: 255 description: Unique identifier consisting of a letter (chassis series) and six digits (chassis number) make: type: string maxLength: 255 description: Brand of the asset model: type: string maxLength: 255 description: Name of the asset product from the manufacturer year: type: integer minimum: 1970 maximum: 2028 description: 'Calendar year the asset model was released, minimum: 1970, maximum: two years from now' odometer_value: type: number description: Integer representation about the asset odometer odometer_unit: type: string description: ' The unit of measure for odometer value represented in standard or metric (mi = Miles or km = Kilometers)' enum: - mi - km engine_hours: type: - integer - 'null' description: Integer representation about the engine hours of asset stand_by_hours: type: - integer - 'null' description: Integer representation about the stand by hours of asset switch_on_hours: type: - integer - 'null' description: Integer representation about the switch on hours of asset notes: type: string maxLength: 1000 description: Notes about the asset gvwr: type: object description: Gross Vehicle Weight Rating properties: value: type: string description: The numeral value for the weight, serialized as a string unit_of_measure: type: string description: The unit of measure used, can be `kg` or `lb` enum: - kg - lb engine: type: object description: Engine data properties: make: type: string maxLength: 255 description: The make of the engine model: type: string maxLength: 255 description: The model of the engine displacement: type: string maxLength: 50 description: The engine size related in liters or cubic inches serial_number: type: string description: The engine serial number minLength: 1 maxLength: 40 license: type: object description: License plate data properties: number: type: string maxLength: 50 description: The number of the license plate state: type: string minLength: 2 maxLength: 10 description: The second part of the ISO 3166-2 code indicates the license State country: type: string enum: - US - CA - MX - EC minLength: 2 maxLength: 2 description: ISO 3166-1 alpha-2 code indicating the license Country expiration: type: string format: date description: '`ISO 8601` date indicating when the license expires' example: '2029-06-18' vmrs_asset_status: type: string description: 'Valid values are: 01, 02, 12, 13, 15, 16, 31, 33, 40, 41, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61' vmrs: type: object description: VMRS classification of the asset. Optional on create. properties: asset_type: type: object description: VMRS Code Key 2 (Equipment Category). properties: code_key: type: string description: The VMRS code key identifier. Must be `"2"` when supplied. example: '2' code: type: string description: The VMRS Code Key 2 code (e.g. `"D"`, `"1"`, `"R"`). Must match an active value from `GET /vmrs/asset_types`. example: R metadata: type: object description: 'Arbitrary key-value pairs for custom asset metadata (max 50 entries). Keys: lowercase snake_case, 1-50 chars, alphanumeric start/end, no double underscores. Values: required strings, max 500 chars.' minProperties: 1 maxProperties: 50 propertyNames: minLength: 1 maxLength: 50 pattern: ^[a-z0-9]+(_{1}[a-z0-9]+)*$ additionalProperties: type: string minLength: 1 maxLength: 500 required: - serial_number - make - model - year relationships: type: object properties: depot: $ref: '#/components/schemas/relationship_object' required: - depot required: - attributes - relationships - type create_service_request: type: object required: - data properties: data: type: object required: - type - attributes properties: type: type: string enum: - service_requests attributes: type: object properties: complaint: type: string description: Initially reported information from driver or other customer entity examples: - Broken truck po_number: type: string description: PO number examples: - '1234' auth_number: type: string description: The auth number examples: - '1234' note: type: string description: The notes for the service request examples: - Initial note vmrs_ck14_code: type: string description: VMRS CK14 code vmrs_ck15_code: type: string description: VMRS CK15 code vmrs_ck16_code: type: string description: VMRS CK16 code vmrs_ck17_code: type: string description: VMRS CK17 code cause_vmrs_ck18_code: type: string description: Cause VMRS CK18 code complaint_vmrs_ck33_code: type: string description: Complaint VMRS CK33 code complaint_vmrs_ck79_code: type: string description: Complaint VMRS CK79 code asset_information: type: object description: The asset information when the service request was created properties: odometer_value: type: number description: Integer representation about the asset odometer odometer_unit: type: string description: abreviation about the unit of asset can be mi for miles or km for Kilometers examples: - mi breakdown: type: object description: Information about the breakdown location properties: city: type: string description: City of breakdown examples: - North Haven location: type: string description: Exact map location of the breakdown examples: - 41.395022,-72.856326 state: type: string description: State of the breakdown examples: - CT primary_contact: type: object description: Primary contact information properties: first_name: type: string description: First name examples: - Martha last_name: type: string description: Last name examples: - Wayne email: type: string description: Contact email examples: - martha@wayne.com relation: type: string examples: - Bobby phone: type: object description: Phone information properties: mobile: type: string examples: - (582) 123-1234 work: type: string examples: - (582) 123-1234 driver: type: object description: Driver information properties: first_name: type: string description: First name examples: - Martha last_name: type: string description: Last name examples: - Wayne email: type: string description: Contact email examples: - martha@wayne.com phone: type: object description: Phone information properties: mobile: type: string examples: - (582) 123-1234 work: type: string examples: - (582) 123-1234 event_timestamps: type: object description: All the timestamps related to the service request properties: requested_completion_time: type: string format: date-time description: '`ISO 8601` timestamp indicating the completion time of the case' examples: - '2022-04-14T05:23:45Z' requested_appointment_time: type: string format: date-time description: '`ISO 8601` timestamp indicating the appointment time' examples: - '2022-04-14T05:23:45Z' asset_downtime: type: string format: date-time description: '`ISO 8601` timestamp indicating when the Asset was considered no longer operational' examples: - '2022-04-14T05:23:45Z' requested_at: type: string required: - complaint relationships: type: object required: - service_provider - registered_asset properties: service_provider: description: Information of the service provider that will be requested $ref: '#/components/schemas/relationship_object' registered_asset: description: Information of the registered asset that needs to be serviced $ref: '#/components/schemas/relationship_object' primary_contact: description: Optional linkage to an existing fleet contact to use as the primary contact for the service request. The linkage `id` is a contact identifier as returned by the contacts endpoints. When provided, its details take precedence over the descriptive `primary_contact` attribute. $ref: '#/components/schemas/relationship_object' deactivate_registered_asset: type: object required: - data properties: data: type: object properties: id: type: string format: uuid type: type: string attributes: type: object required: - attributes - type - id deactivated_asset: type: object required: - data properties: data: type: object properties: id: type: string format: uuid type: type: string enum: - registered_assets attributes: type: object properties: vin: type: string description: 17 digit vehicle identification number minLength: 17 maxLength: 17 serial_number: type: string description: Production number of the asset minLength: 8 maxLength: 9 unit_number: type: string maxLength: 255 description: Identification number commonly used on assets residing within a fleet chassis_id: type: string maxLength: 255 description: Unique identifier consisting of a letter (chassis series) and six digits (chassis number) fleet_info: type: string maxLength: 255 description: Free-form text associated with the asset. Shown as "Fleet Info" in the fleet UI. No defined format or meaning. make: type: string maxLength: 255 description: Brand of the asset model: type: string maxLength: 255 description: Name of the asset product from the manufacturer year: type: integer description: Calendar year the asset model was released odometer_value: type: number description: Integer representation about the asset odometer odometer_unit: type: string description: abreviation about the unit of asset can be mi for miles or km for Kilometers example: mi engine_hours: type: string description: Integer representation about the engine hours of asset minLength: 0 maxLength: 25 notes: type: string maxLength: 1000 description: Notes about the asset engine: type: object description: Engine data properties: make: type: string maxLength: 255 description: The make of the engine model: type: string maxLength: 255 description: The model of the engine displacement: type: string maxLength: 255 license: type: object description: License plate data properties: number: type: string maxLength: 20 description: The number of the license plate state: type: string minLength: 2 maxLength: 10 description: The second part of the ISO 3166-2 code indicates the license State country: type: string minLength: 2 maxLength: 2 description: ISO 3166-1 alpha-2 code indicating the license Country expiration: type: string format: date description: '`ISO 8601` date indicating when the license expires' example: '2029-06-18' vmrs_asset_status: type: string vmrs: type: object readOnly: true description: VMRS classification of the asset properties: asset_type: type: object description: VMRS Code Key 2 (Equipment Category) properties: code_key: type: string description: The VMRS code key identifier example: '2' code: type: string description: The VMRS code value for the equipment category (e.g. 'D', '1', 'R') metadata: type: object additionalProperties: true event_timestamps: type: object properties: deactivated_at: type: string format: date-time description: '`ISO 8601` timestamp indicating when the asset was deactivated' required: - attributes - type - id deactivated_assets: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/deactivated_asset_properties-data' meta: type: object deactivated_depot: type: object required: - data properties: data: type: object properties: id: type: string format: uuid type: type: string enum: - depots attributes: type: object properties: name: type: string description: Name of the depot maxLength: 255 example: Depot Company Test 1 address1: type: string description: Primary address line for the depot maxLength: 255 example: Some street address2: type: string description: Secondary address line for the depot maxLength: 255 example: Some complement city: type: string description: City where the depot is located maxLength: 255 example: New York state: type: string description: Second part of the `ISO 3166-2` code indicating the state maxLength: 10 example: NY country: type: string description: '`ISO 3166-1` alpha-2 code indicating the country' maxLength: 10 example: US postal_code: type: string description: Postal or ZIP code for the depot location maxLength: 20 example: '123456' phone: type: string description: Contact phone number for the depot maxLength: 30 example: +1 321 321321 fax: type: - string - 'null' description: Contact fax number for the depot maxLength: 30 example: +1 321 321321 email: type: string description: Contact email address. Validated for syntax and deliverable domain — addresses whose domain has no resolvable DNS host are rejected. maxLength: 254 example: test@test.com note: type: - string - 'null' description: Free-form notes about the depot maxLength: 1000 example: Tricky depot external_reference: type: object properties: fms: type: string maxLength: 40 example: depot-fms-ref-001 metadata: type: object additionalProperties: true required: - name - email required: - attributes - type - id deactivated_depots: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/deactivated_depot_properties-data' meta: type: object depot: type: object required: - data properties: data: type: object properties: id: type: string format: uuid type: type: string enum: - depots attributes: type: object properties: name: type: string description: Name of the depot maxLength: 255 example: Depot Company Test 1 address1: type: string description: Primary address line for the depot maxLength: 255 example: Some street address2: type: string description: Secondary address line for the depot maxLength: 255 example: Some complement city: type: string description: City where the depot is located maxLength: 255 example: New York state: type: string description: Second part of the `ISO 3166-2` code indicating the state maxLength: 10 example: NY country: type: string description: '`ISO 3166-1` alpha-2 code indicating the country' maxLength: 10 example: US postal_code: type: string description: Postal or ZIP code for the depot location maxLength: 20 example: '123456' phone: type: string description: Contact phone number for the depot maxLength: 30 example: +1 321 321321 fax: type: - string - 'null' description: Contact fax number for the depot maxLength: 30 example: +1 321 321321 email: type: string description: Contact email address. Validated for syntax and deliverable domain — addresses whose domain has no resolvable DNS host are rejected. maxLength: 254 example: test@test.com note: type: - string - 'null' description: Free-form notes about the depot maxLength: 1000 example: Tricky depot external_reference: type: object properties: fms: type: string maxLength: 40 example: COMPANY FMS metadata: type: object additionalProperties: true required: - name - email required: - attributes - type - id depots: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/depot_properties-data' meta: type: object estimate: type: object required: - data properties: data: type: object properties: id: type: string format: uuid type: type: string enum: - estimates attributes: type: object properties: version: type: integer description: Version of the estimate examples: - 1 status: type: string description: Status of the estimate examples: - requested total: type: number description: Total cost of the estimate examples: - 749.86 updated_at: type: string format: date-time description: '`ISO 8601` timestamp indicating when the estimate was updated' examples: - '2022-04-14T05:23:45Z' created_at: type: string format: date-time description: '`ISO 8601` timestamp indicating when the estimate was created' examples: - '2022-04-14T05:23:45Z' totals: type: object description: The detailed description of expenses for the total properties: shop_supplies: type: number description: Detailed cost of shop supplies examples: - 749.86 hazwaste: type: number description: Detailed cost of hazwaste examples: - 749.86 freight: type: number description: Detailed cost of freight examples: - 749.86 tax: type: number description: Detailed cost of tax examples: - 749.86 labor: type: number description: Detailed cost of labor examples: - 749.86 core: type: number description: Detailed cost of core examples: - 749.86 parts: type: number description: Detailed cost of parts examples: - 749.86 event_timestamps: type: object description: All the timestamps related to the estimate properties: estimated_time_to_repair: type: string format: date-time description: '`ISO 8601` timestamp indicating the time estimated to repair the asset' examples: - '2022-04-14T05:23:45Z' reviewed_at: type: string format: date-time description: '`ISO 8601` timestamp indicating when the estimate was reviewed' examples: - '2022-04-14T05:23:45Z' approval_requested_at: type: - string - 'null' format: date-time description: '`ISO 8601` timestamp indicating when approval was requested for this estimate version. Backed by `estimate_versions.created_at` — the same value exposed by the top-level `created_at` attribute.' examples: - '2022-04-14T05:23:45Z' line_items: type: array description: Line items inside the estimate items: type: object properties: id: type: string description: UUID of the line item name: type: string description: Name of the line item status: type: string description: Status of the line item examples: - requested total: type: number description: Total cost of the line item examples: - 749.86 totals: type: object description: The detailed description of expenses for the total properties: labor: type: number description: Detailed cost of labor examples: - 749.86 core: type: number description: Detailed cost of core examples: - 749.86 parts: type: number description: Detailed cost of parts examples: - 749.86 parts: type: array description: Line items parts in the estimate items: type: object properties: name: type: string examples: - hose quantity: type: integer examples: - 1 vmrs: type: array description: Line items vrms in the estimate items: type: object properties: code_key: type: string examples: - '33' code_key_name: type: string examples: - Component Code code: type: string examples: - 013-007-024 description: type: string examples: - Line - Air Coiled relationships: type: object properties: service_writer: $ref: '#/components/schemas/relationship_object' reviewer: $ref: '#/components/schemas/relationship_object' case: $ref: '#/components/schemas/relationship_object' required: - attributes - type - id estimates: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/estimate_properties-data' meta: type: object extended_attribute: type: object required: - data properties: data: type: object properties: id: type: string format: uuid type: type: string attributes: type: object properties: name: type: string description: Description of extended attribute minLength: 1 maxLength: 255 schema: type: object oneOf: - type: object description: String with enum validation required: - type - enum properties: type: type: string example: string enum: type: array items: type: string - type: object description: String with length validation required: - type - minLength - maxLength properties: type: type: string example: string minLength: type: integer maxLength: type: integer - type: object description: String with pattern validation required: - type - pattern properties: type: type: string example: string pattern: type: string - type: object description: Integer with range validation required: - type - minimum - maximum properties: type: type: integer example: 42 minimum: type: integer maximum: type: integer - type: object description: Integer with enum validation required: - type - enum properties: type: type: integer example: 42 enum: type: array items: type: integer - type: object description: Number with range validation required: - type - minimum - maximum properties: type: type: number example: 3.14 minimum: type: number maximum: type: number - type: object description: Boolean required: - type properties: type: type: boolean example: true - type: object description: Datetime required: - type - format properties: type: type: string example: string format: type: string example: date-time - type: object description: Date required: - type - format properties: type: type: string example: string format: type: string example: date - type: object description: Time required: - type - format properties: type: type: string example: string format: type: string example: time - type: object description: Email required: - type - format properties: type: type: string example: string format: type: string example: email - type: object description: URI required: - type - format properties: type: type: string example: string format: type: string example: uri - type: object description: UUID required: - type - format properties: type: type: string example: string format: type: string example: uuid required: - attributes - type - id extended_attributes: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/extended_attribute_properties-data' meta: type: object extended_asset_attribute: type: object required: - data properties: data: type: object properties: id: type: string format: uuid type: type: string attributes: type: object properties: name: type: string description: Name of the extended asset attribute value: type: string description: Value of extended attribute for the asset created_at: type: string format: date-time description: '`ISO 8601` timestamp indicating when the extended asset attribute was created' example: '2022-04-14T05:23:45Z' updated_at: type: string format: date-time description: '`ISO 8601` timestamp indicating when the extended asset attribute was updated' example: '2022-04-14T05:23:45Z' required: - value relationships: type: object properties: account_extended_attribute: $ref: '#/components/schemas/relationship_object' registered_asset: $ref: '#/components/schemas/relationship_object' required: - account_extended_attribute - registered_asset required: - attributes - relationships - type - id extended_asset_attributes: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/extended_asset_attribute_properties-data' meta: type: object update_extended_asset_attribute: type: object required: - data properties: data: type: object required: - id - type - attributes properties: id: type: string format: uuid type: type: string attributes: type: object required: - value properties: value: type: string description: Value of extended attribute for the asset internal_user: type: object required: - data properties: data: type: object properties: id: type: string format: uuid type: type: string enum: - internal_users attributes: type: object properties: first_name: type: string description: First name of the internal user maxLength: 50 last_name: type: string description: Last name of the internal user maxLength: 50 email: type: string description: Email of the internal user maxLength: 120 external_reference: type: object description: Reference Identifiers used outside of Decisiv SRM properties: business_system: type: - string - 'null' description: Business System Identifier required: - attributes - type - id internal_users: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/internal_user_properties-data' meta: type: object properties: record-count: type: integer description: Total count across all pages meter_data_eng_hours_registered_asset: type: object required: - data properties: data: type: object properties: id: type: string format: uuid type: type: string attributes: type: object properties: meter_data: type: array description: Engine-hours meter readings to record on the registered asset. items: type: object description: Type of meter data properties: meter: type: string enum: - engine_hours description: Meter data type to be changed unit: type: string enum: - hr description: Unit of measurement for given meter data. Valid unit for `engine_hours` is `hr`. value: type: number description: Reading value for the given meter data meter_data_switch_hours_registered_asset: type: object required: - data properties: data: type: object properties: id: type: string format: uuid type: type: string attributes: type: object properties: meter_data: type: array description: Switch-on-hours meter readings to record on the registered asset. items: type: object description: Type of meter data properties: meter: type: string enum: - switch_on_hours description: Meter data type to be changed unit: type: string enum: - hr description: Unit of measurement for given meter data. Valid unit for `switch_on_hours` is `hr`. value: type: integer description: Reading value for the given meter data meter_data_stand_hours_registered_asset: type: object required: - data properties: data: type: object properties: id: type: string format: uuid type: type: string attributes: type: object properties: meter_data: type: array description: Stand-by-hours meter readings to record on the registered asset. items: type: object description: Type of meter data properties: meter: type: string enum: - stand_by_hours description: Meter data type to be changed unit: type: string enum: - hr description: Unit of measurement for given meter data. Valid unit for `stand_by_hours` is `hr`. value: type: integer description: Reading value for the given meter data meter_data_history: type: object required: - data properties: data: type: object properties: id: type: string format: uuid type: type: string attributes: type: object properties: meter: type: string description: The meter type enum: - odometer - engine_hours - stand_by_hours - switch_on_hours - fuel_consumed example: odometer value: type: integer description: The meter value example: 1234 unit: type: string enum: - mi - km - hr - gal example: mi description: Unit of measurement for given meter data. Valid units for `odometer` are `mi` and `km`; `hr` for `engine_hours`, `stand_by_hours`, and `switch_on_hours`; `gal` for `fuel_consumed` event_timestamps: type: object description: The timestamps of the meter event properties: retrieved_at: type: string format: date-time description: '`ISO 8601` timestamp indicating the time the meter was retrieved' example: '2023-01-31T18:21:23Z' recorded_by: type: string description: The user who recorded the meter data example: user@**** meter_data_odometer_registered_asset: type: object required: - data properties: data: type: object properties: id: type: string format: uuid type: type: string attributes: type: object properties: meter_data: type: array description: Odometer readings to record on the registered asset. items: type: object description: Type of meter data properties: meter: type: string enum: - odometer description: Meter data type to be changed unit: type: string enum: - mi - km description: Unit of measurement for given meter data. Valid units for `odometer` are `mi` and `km`. value: type: number description: Reading value for the given meter data note: type: object required: - data properties: data: type: object properties: id: type: string format: uuid type: type: string enum: - notes attributes: type: object properties: message: type: string description: The message itself examples: - This is a note public: type: boolean description: If the message is public examples: - true created_at: type: string format: date-time description: '`ISO 8601` timestamp indicating when the note was created' examples: - '2022-04-14T05:23:45Z' required: - message - public relationships: type: object properties: subject: $ref: '#/components/schemas/relationship_object' sender: $ref: '#/components/schemas/relationship_object' recipients: $ref: '#/components/schemas/relationship_objects' participants: $ref: '#/components/schemas/relationship_objects' required: - recipients required: - attributes - relationships - type - id notes: type: object required: - data properties: data: type: array items: type: object properties: id: type: string format: uuid type: type: string enum: - notes attributes: type: object properties: message: type: string description: The message itself example: This is a note public: type: boolean description: If the message is public example: true created_at: type: string format: date-time description: '`ISO 8601` timestamp indicating when the note was created' required: - message - public relationships: type: object properties: subject: $ref: '#/components/schemas/relationship_object' sender: $ref: '#/components/schemas/relationship_object' recipients: $ref: '#/components/schemas/relationship_objects' participants: $ref: '#/components/schemas/relationship_objects' required: - recipients required: - type - id - attributes - relationships meta: type: object participant: type: object required: - data properties: data: type: object properties: id: type: string format: uuid type: type: string attributes: type: object properties: name: type: string description: Participant name example: Pilot Travel Centers scopes: type: array description: A list of scopes to which the participant belongs. items: type: string description: Name of the scope minItems: 1 example: - service_provider - billing_customer - customer - originator - other required: - attributes - type - id participants: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/participant_properties-data' meta: type: object participant_recipient: type: object required: - data properties: data: type: object properties: id: type: string format: uuid type: type: string attributes: type: object properties: name: type: string description: Full recipient name example: John Doe email: type: string description: Recipient email example: support@support.com phone: type: string description: Recipient mobile phone example: '12345678910' relationships: type: object properties: affiliation: $ref: '#/components/schemas/relationship_object' required: - attributes - type - id participant_recipients: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/participant_recipient_properties-data' meta: type: object recipient: type: object required: - data properties: data: type: object properties: id: type: string format: uuid type: type: string attributes: type: object properties: username: type: string description: The username inside the system example: support@support.com first_name: type: string description: First name example: John last_name: type: string description: Last name example: Doe name: type: string description: Full name example: John Doe email: type: string description: Contact email example: support@support.com affiliation: type: object properties: account_name: type: string description: The account from the recipient example: Dealer Name recipient_type: type: string example: other required: - attributes - type - id recipients: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/recipient_properties-data' meta: type: object registered_asset: type: object required: - data properties: data: type: object properties: id: type: string format: uuid type: type: string enum: - registered_assets attributes: type: object properties: vin: type: string description: 17 digit vehicle identification number minLength: 17 maxLength: 17 serial_number: type: string description: Production number of the asset minLength: 6 maxLength: 36 unit_number: type: string maxLength: 255 description: Identification number commonly used on assets residing within a fleet chassis_id: type: string maxLength: 255 description: Unique identifier consisting of a letter (chassis series) and six digits (chassis number) fleet_info: type: string maxLength: 255 description: Free-form text associated with the asset. Shown as "Fleet Info" in the fleet UI. No defined format or meaning. make: type: string maxLength: 255 description: Brand of the asset model: type: string maxLength: 255 description: Name of the asset product from the manufacturer year: type: integer minimum: 1970 maximum: 2028 description: 'Calendar year the asset model was released, minimum: 1970, maximum: two years from now' odometer_value: type: number description: Integer representation about the asset odometer odometer_unit: type: string description: ' The unit of measure for odometer value represented in standard or metric (mi = Miles or km = Kilometers)' enum: - mi - km engine_hours: type: - integer - 'null' description: Integer representation about the engine hours of asset stand_by_hours: type: - integer - 'null' description: Integer representation about the stand by hours of asset switch_on_hours: type: - integer - 'null' description: Integer representation about the switch on hours of asset fuel_consumed_value: type: - integer - 'null' description: Integer representation of the total fuel consumed by the asset (stored in gallons) fuel_consumed_unit: type: string description: Unit of measure for fuel consumed. Always returned as `gal`. enum: - gal notes: type: string maxLength: 1000 description: Notes about the asset gvwr: type: object description: Gross Vehicle Weight Rating properties: value: type: string description: The numeral value for the weight unit_of_measure: type: string description: The unit of measure used, can be `kg` or `lb` enum: - kg - lb engine: type: object description: Engine data properties: make: type: string maxLength: 255 description: The make of the engine model: type: string maxLength: 255 description: The model of the engine displacement: type: string maxLength: 50 description: The engine size related in liters or cubic inches serial_number: type: string description: The engine serial number minLength: 1 maxLength: 40 license: type: object description: License plate data properties: number: type: string maxLength: 50 description: The number of the license plate state: type: string minLength: 2 maxLength: 10 description: The second part of the ISO 3166-2 code indicates the license State country: type: string enum: - US - CA - MX - EC minLength: 2 maxLength: 2 description: ISO 3166-1 alpha-2 code indicating the license Country expiration: type: string format: date description: '`ISO 8601` date indicating when the license expires' example: '2029-06-18' vmrs_asset_status: type: string description: 'Valid values are: 01, 02, 12, 13, 15, 16, 31, 33, 40, 41, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61' vmrs: type: object description: VMRS classification of the asset. properties: asset_type: type: object description: VMRS Code Key 2 (Equipment Category). properties: code_key: type: string description: The VMRS code key identifier. Must be `"2"` when supplied on write. example: '2' code: type: string description: The VMRS Code Key 2 code (e.g. `"D"`, `"1"`, `"R"`). Must match an active value from `GET /vmrs/asset_types`. metadata: type: object description: 'Arbitrary key-value pairs for custom asset metadata (max 50 entries). Keys: lowercase snake_case, 1-50 chars, alphanumeric start/end, no double underscores. Values: required strings, max 500 chars.' minProperties: 1 maxProperties: 50 propertyNames: minLength: 1 maxLength: 50 pattern: ^[a-z0-9]+(_{1}[a-z0-9]+)*$ additionalProperties: type: string minLength: 1 maxLength: 500 relationships: type: object properties: depot: $ref: '#/components/schemas/relationship_object' srm_verified_asset: $ref: '#/components/schemas/relationship_object' extended_asset_attributes: $ref: '#/components/schemas/relationship_objects' required: - attributes - type - id registered_asset_patch: type: object required: - data properties: data: type: object properties: id: type: string format: uuid type: type: string enum: - registered_assets attributes: type: object properties: unit_number: type: string maxLength: 255 description: Identification number commonly used on assets residing within a fleet chassis_id: type: string maxLength: 255 description: Unique identifier consisting of a letter (chassis series) and six digits (chassis number) fleet_info: type: string maxLength: 255 description: Free-form text associated with the asset. Shown as "Fleet Info" in the fleet UI. No defined format or meaning. make: type: string maxLength: 255 description: Brand of the asset model: type: string maxLength: 255 description: Name of the asset product from the manufacturer year: type: integer minimum: 1970 maximum: 2028 description: 'Calendar year the asset model was released, minimum: 1970, maximum: two years from now' odometer_value: type: number description: Integer representation about the asset odometer odometer_unit: type: string description: The unit of measure for odometer value represented in standard or metric (mi = Miles or km = Kilometers) enum: - mi - km engine_hours: type: - integer - 'null' description: Integer representation about the engine hours of asset stand_by_hours: type: - integer - 'null' description: Integer representation about the stand by hours of asset switch_on_hours: type: - integer - 'null' description: Integer representation about the switch on hours of asset fuel_consumed_value: type: - number - 'null' description: The total fuel consumed by the asset. Decimal values are accepted and rounded to the nearest integer when stored. Requires `fuel_consumed_unit` when provided. fuel_consumed_unit: type: string description: 'Unit of measure for fuel consumed. Valid values: `gal`, `gallons`, `l`, `liters`. The value is stored and returned in gallons (`gal`). Required when `fuel_consumed_value` is present.' enum: - gal - gallons - l - liters notes: type: string maxLength: 1000 description: Notes about the asset gvwr: type: object description: Gross Vehicle Weight Rating properties: value: type: string description: The numeral value for the weight, serialized as a string unit_of_measure: type: string description: The unit of measure used, can be `kg` or `lb` enum: - kg - lb engine: type: object description: Engine data properties: make: type: string maxLength: 255 description: The make of the engine model: type: string maxLength: 255 description: The model of the engine displacement: type: string maxLength: 50 description: The engine size related in liters or cubic inches serial_number: type: string description: The engine serial number minLength: 1 maxLength: 40 license: type: object description: License plate data properties: number: type: string maxLength: 50 description: The number of the license plate state: type: string minLength: 2 maxLength: 10 description: The second part of the ISO 3166-2 code indicates the license State country: type: string enum: - US - CA - MX - EC minLength: 2 maxLength: 2 description: ISO 3166-1 alpha-2 code indicating the license Country expiration: type: string format: date description: '`ISO 8601` date indicating when the license expires' example: '2029-06-18' vmrs_asset_status: type: string description: 'Valid values are: 01, 02, 12, 13, 15, 16, 31, 33, 40, 41, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61' vmrs: type: object description: 'VMRS classification of the asset. Optional on update. Sending `vmrs.asset_type = null`, `vmrs.asset_type = {}`, `vmrs.asset_type.code = null`, or `vmrs.asset_type.code = ""` clears the existing value. Sending `vmrs = null` is a no-op. ' properties: asset_type: type: - object - 'null' description: VMRS Code Key 2 (Equipment Category). `null` clears the field. properties: code_key: type: string description: The VMRS code key identifier. Must be `"2"` when supplied. example: '2' code: type: - string - 'null' description: The VMRS Code Key 2 code (e.g. `"D"`, `"1"`, `"R"`). Must match an active value from `GET /vmrs/asset_types`. `null` or empty string clears the field. example: R metadata: type: object description: 'Arbitrary key-value pairs for custom asset metadata (max 50 entries). Keys: lowercase snake_case, 1-50 chars, alphanumeric start/end, no double underscores. Values: required strings, max 500 chars.' minProperties: 1 maxProperties: 50 propertyNames: minLength: 1 maxLength: 50 pattern: ^[a-z0-9]+(_{1}[a-z0-9]+)*$ additionalProperties: type: string minLength: 1 maxLength: 500 relationships: type: object properties: depot: type: object description: The depot for the registered asset properties: data: type: object properties: type: type: string example: depots id: type: string example: The UUID of the depot registered_asset_put: type: object required: - data properties: data: type: object properties: id: type: string format: uuid type: type: string enum: - registered_assets attributes: type: object properties: unit_number: type: string maxLength: 255 description: Identification number commonly used on assets residing within a fleet chassis_id: type: string maxLength: 255 description: Unique identifier consisting of a letter (chassis series) and six digits (chassis number) fleet_info: type: string maxLength: 255 description: Free-form text associated with the asset. Shown as "Fleet Info" in the fleet UI. No defined format or meaning. make: type: string maxLength: 255 description: Brand of the asset model: type: string maxLength: 255 description: Name of the asset product from the manufacturer year: type: integer minimum: 1970 maximum: 2028 description: 'Calendar year the asset model was released, minimum: 1970, maximum: two years from now' odometer_value: type: number description: Integer representation about the asset odometer odometer_unit: type: string description: ' The unit of measure for odometer value represented in standard or metric (mi = Miles or km = Kilometers)' enum: - mi - km engine_hours: type: - integer - 'null' description: Integer representation about the engine hours of asset stand_by_hours: type: - integer - 'null' description: Integer representation about the stand by hours of asset switch_on_hours: type: - integer - 'null' description: Integer representation about the switch on hours of asset fuel_consumed_value: type: - number - 'null' description: The total fuel consumed by the asset. Decimal values are accepted and rounded to the nearest integer when stored. Requires `fuel_consumed_unit` when provided. fuel_consumed_unit: type: string description: 'Unit of measure for fuel consumed. Valid values: `gal`, `gallons`, `l`, `liters`. The value is stored and returned in gallons (`gal`). Required when `fuel_consumed_value` is present.' enum: - gal - gallons - l - liters notes: type: string maxLength: 1000 description: Notes about the asset gvwr: type: object description: Gross Vehicle Weight Rating properties: value: type: string description: The numeral value for the weight, serialized as a string unit_of_measure: type: string description: The unit of measure used, can be `kg` or `lb` enum: - kg - lb engine: type: object description: Engine data properties: make: type: string maxLength: 255 description: The make of the engine model: type: string maxLength: 255 description: The model of the engine displacement: type: string maxLength: 50 description: The engine size related in liters or cubic inches serial_number: type: string description: The engine serial number minLength: 1 maxLength: 40 license: type: object description: License plate data properties: number: type: string maxLength: 50 description: The number of the license plate state: type: string minLength: 2 maxLength: 10 description: The second part of the ISO 3166-2 code indicates the license State country: type: string enum: - US - CA - MX - EC minLength: 2 maxLength: 2 description: ISO 3166-1 alpha-2 code indicating the license Country expiration: type: string format: date description: '`ISO 8601` date indicating when the license expires' example: '2029-06-18' vmrs_asset_status: type: string description: 'Valid values are: 01, 02, 12, 13, 15, 16, 31, 33, 40, 41, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61' vmrs: type: object description: 'VMRS classification of the asset. Optional on update. Sending `vmrs.asset_type = null`, `vmrs.asset_type = {}`, `vmrs.asset_type.code = null`, or `vmrs.asset_type.code = ""` clears the existing value. Sending `vmrs = null` is a no-op. ' properties: asset_type: type: - object - 'null' description: VMRS Code Key 2 (Equipment Category). `null` clears the field. properties: code_key: type: string description: The VMRS code key identifier. Must be `"2"` when supplied. example: '2' code: type: - string - 'null' description: The VMRS Code Key 2 code (e.g. `"D"`, `"1"`, `"R"`). Must match an active value from `GET /vmrs/asset_types`. `null` or empty string clears the field. example: R metadata: type: object description: 'Arbitrary key-value pairs for custom asset metadata (max 50 entries). Keys: lowercase snake_case, 1-50 chars, alphanumeric start/end, no double underscores. Values: required strings, max 500 chars.' minProperties: 1 maxProperties: 50 propertyNames: minLength: 1 maxLength: 50 pattern: ^[a-z0-9]+(_{1}[a-z0-9]+)*$ additionalProperties: type: string minLength: 1 maxLength: 500 relationships: type: object properties: depot: type: object description: The depot for the registered asset properties: data: type: object properties: type: type: string example: depots id: type: string example: The UUID of the depot registered_assets: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/registered_asset_properties-data' meta: type: object registered_component_create: type: object required: - data properties: data: type: object properties: type: type: string example: registered_components attributes: type: object required: - name - serial_number properties: name: type: string description: Description of component minLength: 1 maxLength: 255 serial_number: type: string description: Production number of the component minLength: 1 maxLength: 255 make: type: string description: Brand of the component minLength: 1 maxLength: 255 model: type: string description: Name of the component product from the manufacturer minLength: 1 maxLength: 255 year: type: integer description: Calendar year the component model was released minLength: 4 maxLength: 4 minimum: 1000 maximum: 9999 event_timestamps: type: object description: All the timestamps related to the component properties: installed_on: type: string format: date-time description: '`ISO 8601` timestamp indicating the component was installed' example: '2022-04-14T05:23:45Z' metadata: type: object additionalProperties: true relationships: type: object required: - registered_asset properties: registered_asset: $ref: '#/components/schemas/relationship_object' required: - type - attributes - relationships registered_component: type: object required: - data properties: data: type: object properties: id: type: string format: uuid type: type: string example: registered_components attributes: type: object properties: name: type: string description: Description of component minLength: 1 maxLength: 255 serial_number: type: string description: Production number of the component minLength: 1 maxLength: 255 make: type: string description: Brand of the component minLength: 1 maxLength: 255 model: type: string description: Name of the component product from the manufacturer minLength: 1 maxLength: 255 year: type: integer description: Calendar year the component model was released minLength: 4 maxLength: 4 minimum: 1000 maximum: 9999 event_timestamps: type: object description: All the timestamps related to the component properties: installed_on: type: string format: date-time description: '`ISO 8601` timestamp indicating the component was installed' example: '2022-04-14T05:23:45Z' created_at: type: string format: date-time description: '`ISO 8601` timestamp indicating when the component was created' example: '2022-04-14T05:23:45Z' updated_at: type: string format: date-time description: '`ISO 8601` timestamp indicating when the component was updated' example: '2022-04-14T05:23:45Z' metadata: type: object additionalProperties: true relationships: type: object properties: registered_asset: $ref: '#/components/schemas/relationship_object' registered_component_patch: type: object required: - data properties: data: type: object properties: id: type: string format: uuid type: type: string example: registered_components attributes: type: object properties: name: type: string description: Description of component minLength: 1 maxLength: 255 serial_number: type: string description: Production number of the component minLength: 1 maxLength: 255 make: type: - string - 'null' description: Brand of the component minLength: 1 maxLength: 255 model: type: - string - 'null' description: Name of the component product from the manufacturer minLength: 1 maxLength: 255 year: type: - integer - 'null' description: Calendar year the component model was released minLength: 4 maxLength: 4 minimum: 1000 maximum: 9999 event_timestamps: type: object description: All the timestamps related to the component properties: installed_on: type: - string - 'null' format: date-time description: '`ISO 8601` timestamp indicating the component was installed' example: '2022-04-14T05:23:45Z' metadata: type: object additionalProperties: true relationships: type: object properties: registered_asset: $ref: '#/components/schemas/relationship_object' required: - id - type - attributes registered_asset_change: type: object required: - data properties: data: type: object properties: type: type: string id: type: string registered_asset_remove: type: object required: - data properties: data: type: 'null' response_estimate: type: object required: - data properties: data: type: object properties: id: type: string format: uuid type: type: string attributes: type: object properties: line_items: type: array description: Line Items inside the estimate items: type: object properties: id: type: string description: UUID of the line item status: type: string description: Changing the status of each line item indicates the customer response and status of that line item in relation to the Estimate. example: approved enum: - approved - declined - deferred comments: type: string example: Did not like the price reason: type: string description: Reason for declined/deferred line items. MUST be provided for any line item which is not approved. example: defer enum: - defer - labor costs - parts costs - not interested service_provider: type: object required: - data properties: data: type: object properties: id: type: string format: uuid type: type: string attributes: type: object properties: name: type: string description: Name of the Service Provider minLength: 1 maxLength: 150 address1: type: string description: Primary Address for the Service Provider minLength: 0 maxLength: 255 address2: type: string description: Secondary address identifier minLength: 0 maxLength: 255 city: type: string description: City which the Service Provider business resides minLength: 0 maxLength: 30 state: type: string description: 2 Letter state abbreviation minLength: 0 maxLength: 2 postal_code: type: string description: Postal zip code of the Service Provider location minLength: 0 maxLength: 18 country: type: string description: Country of Service Povider, in `ISO 3166-1 alpha-2` format minLength: 0 maxLength: 2 phone: type: string description: Telephone contact information for the Service Provider minLength: 0 maxLength: 30 fax: type: string description: Fax information for the Service Provider minLength: 0 maxLength: 30 email: type: string description: Email contact information for the Service Provider minLength: 0 maxLength: 120 location: type: object description: Geolocation information about the Service Provider properties: latitude: type: number longitude: type: number distance_from_geolocation: type: number external_reference: type: object description: External reference information for the Service Provider properties: srm_account_id: type: string description: SRM Account ID for the Service Provider minLength: 7 maxLength: 7 relationships: type: object properties: service_networks: $ref: '#/components/schemas/relationship_object' required: - attributes service_providers: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/service_provider_properties-data' meta: type: object service_request: type: object required: - data properties: data: type: object properties: id: type: string format: uuid type: type: string enum: - service_requests attributes: type: object properties: complaint: type: string description: Initially reported information from driver or other customer entity examples: - Broken truck po_number: type: string description: PO number examples: - '1234' auth_number: type: string description: The auth number examples: - '1234' note: type: string description: The notes for the service request examples: - Initial note reference_number: type: number description: Integer representation of the service request ID inside of the User Interface status: type: string description: Status of the service request examples: - Pick-up updated_at: type: string format: date-time description: '`ISO 8601` timestamp indicating when the service request was updated' examples: - '2022-04-14T05:23:45Z' created_at: type: string format: date-time description: '`ISO 8601` timestamp indicating when the service request was created' examples: - '2022-04-14T05:23:45Z' asset_information: type: object description: The asset information when the service request was created properties: odometer_value: type: number description: Integer representation about the asset odometer odometer_unit: type: string description: abreviation about the unit of asset can be mi for miles or km for Kilometers examples: - mi breakdown: type: object description: Information about the breakdown location properties: city: type: string description: City of breakdown examples: - North Haven location: type: string description: Exact map location of the breakdown examples: - 41.395022,-72.856326 state: type: string description: State of the breakdown examples: - CT primary_contact: type: object description: Primary contact information properties: first_name: type: string description: First name examples: - Martha last_name: type: string description: Last name examples: - Wayne email: type: string description: Contact email examples: - martha@wayne.com relation: type: string examples: - Bobby phone: type: object description: Phone information properties: mobile: type: string examples: - (582) 123-1234 work: type: string examples: - (582) 123-1234 driver: type: object description: Driver information properties: first_name: type: string description: First name examples: - Martha last_name: type: string description: Last name examples: - Wayne email: type: string description: Contact email examples: - martha@wayne.com phone: type: object description: Phone information properties: mobile: type: string examples: - (582) 123-1234 work: type: string examples: - (582) 123-1234 metadata: type: string additionalProperties: true event_timestamps: type: object description: All the timestamps related to the service request properties: requested_at: type: string format: date-time description: '`ISO 8601` timestamp indicating when the service was requested' examples: - '2022-04-14T05:23:45Z' requested_completion_time: type: string format: date-time description: '`ISO 8601` timestamp indicating the completion time of the case' examples: - '2022-04-14T05:23:45Z' requested_appointment_time: type: string format: date-time description: '`ISO 8601` timestamp indicating the appointment time' examples: - '2022-04-14T05:23:45Z' asset_downtime: type: string format: date-time description: '`ISO 8601` timestamp indicating when the Asset was considered no longer operational' examples: - '2022-04-14T05:23:45Z' relationships: type: object properties: registered_asset: $ref: '#/components/schemas/relationship_object' service_provider: $ref: '#/components/schemas/relationship_object' case: $ref: '#/components/schemas/relationship_object' primary_contact: description: The contact designated as the primary contact for the service request. Resolved from the service request's descriptive primary contact information against the fleet's contacts; absent when no matching contact is found. $ref: '#/components/schemas/relationship_object' required: - attributes - type - id service_requests: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/service_request_properties-data' meta: type: object transfer_registered_asset: type: object required: - data properties: data: type: object properties: id: type: string format: uuid type: type: string attributes: type: object additionalProperties: true relationships: type: object properties: depot: type: object description: The depot for the registered asset properties: data: type: object properties: type: type: string example: depots id: type: string example: The UUID of the depot update_case: type: object required: - data properties: data: type: object properties: id: type: string format: uuid type: type: string enum: - cases attributes: type: object properties: complaint: type: string description: Initially reported information from driver or other customer entity examples: - Broken truck po_number: type: string description: PO number examples: - '1234' auth_number: type: string description: The auth number examples: - '1234' correction: type: string description: Correction details for the case writeOnly: true maxLength: 6000 status: type: string description: Status of the case examples: - Pick-up event_timestamps: type: object description: All the timestamps related to the case properties: requested_completion_time: type: string format: date-time description: '`ISO 8601` timestamp indicating the completion time of the case' examples: - '2022-04-14T05:23:45Z' followup_time: type: string format: date-time description: '`ISO 8601` timestamp indicating the next check-in point between Customer / Provider' examples: - '2022-04-14T05:23:45Z' ro_number: type: string relationships: type: object description: 'Relationships that may be reassigned on update. Each value follows the JSON:API `{ data: { type, id } }` shape; `id` must be the `uuid` of one of the fleet''s own registered contacts.' properties: billing_contact: type: object description: Billing contact on the case. properties: data: type: object properties: type: type: string enum: - contacts - registered_contacts - recipients id: type: string format: uuid required: - type - id required: - data primary_contact: type: object description: Primary contact on the case. properties: data: type: object properties: type: type: string enum: - contacts - registered_contacts - recipients id: type: string format: uuid required: - type - id required: - data required: - id - type - attributes vmrs_asset_type: type: object required: - data properties: data: type: object required: - id - type - attributes properties: id: type: string description: The Code Key 2 `code` value (natural key). example: '01' type: type: string enum: - decisiv_vmrs_asset_types attributes: type: object required: - code_key - code_key_name - code - description properties: code_key: type: string description: VMRS Code Key number. Always `"2"` for asset type lookups. example: '2' code_key_name: type: string description: 'Human-readable label for the Code Key, sourced from the `Vmrs::Coding` data table. For Code Key 2 this is `"Equipment Category"`. ' example: Equipment Category code: type: string maxLength: 2 description: The VMRS Code Key 2 code (e.g. `"01"`, `"D"`). example: '01' description: type: string description: Human-readable name for the asset type / equipment category. example: Truck vmrs_asset_types: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/vmrs_asset_type_properties-data' meta: type: object properties: record-count: type: integer description: Total number of VMRS Asset Type records across all pages. example: 78 vmrs_reason_for_repair: type: object required: - data properties: data: type: object required: - id - type - attributes properties: id: type: string description: The Code Key 14 `code` value (natural key). example: '01' type: type: string enum: - decisiv_vmrs_reasons_for_repair attributes: type: object required: - code_key - code_key_name - code - description - category properties: code_key: type: string description: VMRS Code Key number. Always `"14"` for reason-for-repair lookups. example: '14' code_key_name: type: string description: 'Human-readable label for the Code Key, sourced from the `Vmrs::Coding` data table. For Code Key 14 this is `"Reason for Repair"`. ' example: Reason for Repair code: type: string maxLength: 2 description: The VMRS Code Key 14 code (e.g. `"01"`, `"70"`). example: '01' description: type: string description: Human-readable name for the reason for repair. example: Breakdown category: type: string description: 'The VMRS Code Key 14 `repair_type` grouping the reason belongs to (e.g. `"Maintenance"`, `"Outside Influence"`, `"Management Decision"`). ' example: Maintenance vmrs_reasons_for_repair: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/vmrs_reason_for_repair_properties-data' meta: type: object properties: record-count: type: integer description: Total number of VMRS Reason for Repair records across all pages. example: 60 vmrs_repair_priority: type: object required: - data properties: data: type: object required: - id - type - attributes properties: id: type: string description: The Code Key 16 `code` value (natural key). example: '1' type: type: string enum: - decisiv_vmrs_repair_priorities attributes: type: object required: - code_key - code_key_name - code - description properties: code_key: type: string description: VMRS Code Key number. Always `"16"` for repair-priority lookups. example: '16' code_key_name: type: string description: 'Human-readable label for the Code Key, sourced from the `Vmrs::Coding` data table. For Code Key 16 this is `"Repair Priority Class"`. ' example: Repair Priority Class code: type: string maxLength: 1 description: The VMRS Code Key 16 code (e.g. `"1"`, `"2"`, `"3"`). example: '1' description: type: string description: Human-readable name for the repair priority class. example: Scheduled vmrs_repair_priorities: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/vmrs_repair_priority_properties-data' meta: type: object properties: record-count: type: integer description: Total number of VMRS Repair Priority records across all pages. example: 3 vmrs_repair_site: type: object required: - data properties: data: type: object required: - id - type - attributes properties: id: type: string description: The Code Key 17 `code` value (natural key). example: '1' type: type: string enum: - decisiv_vmrs_repair_sites attributes: type: object required: - code_key - code_key_name - code - description properties: code_key: type: string description: VMRS Code Key number. Always `"17"` for repair-site lookups. example: '17' code_key_name: type: string description: 'Human-readable label for the Code Key, sourced from the `Vmrs::Coding` data table. For Code Key 17 this is `"Repair Site"`. ' example: Repair Site code: type: string maxLength: 1 description: The VMRS Code Key 17 code (e.g. `"1"`, `"2"`, `"3"`). example: '1' description: type: string description: Human-readable name for the repair site. example: Facility (Fleet) vmrs_repair_sites: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/vmrs_repair_site_properties-data' meta: type: object properties: record-count: type: integer description: Total number of VMRS Repair Site records across all pages. example: 3 vmrs_component: type: object required: - data properties: data: type: object required: - id - type - attributes properties: id: type: string description: The Code Key 33 `code` value (natural key). example: 001-000-000 type: type: string enum: - decisiv_vmrs_components attributes: type: object required: - code_key - code_key_name - code - description properties: code_key: type: string description: VMRS Code Key number. Always `"33"` for component lookups. example: '33' code_key_name: type: string description: 'Human-readable label for the Code Key, sourced from the `Vmrs::Coding` data table. For Code Key 33 this is `"Component"`. ' example: Component code: type: string maxLength: 11 description: The VMRS Code Key 33 code (e.g. `"001-000-000"`). example: 001-000-000 description: type: string description: Human-readable name for the component. example: Air Conditioning, Heating & Ventilating System vmrs_components: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/vmrs_component_properties-data' meta: type: object properties: record-count: type: integer description: Total number of VMRS Component records across all pages. example: 2 vmrs_operator_report: type: object required: - data properties: data: type: object required: - id - type - attributes properties: id: type: string description: The Code Key 82 `code` value (natural key). example: '001' type: type: string enum: - decisiv_vmrs_operator_reports attributes: type: object required: - code_key - code_key_name - code - description properties: code_key: type: string description: VMRS Code Key number. Always `"82"` for operator report lookups. example: '82' code_key_name: type: string description: 'Human-readable label for the Code Key, sourced from the `Vmrs::Coding` data table. For Code Key 82 this is `"Operator Vehicle/Equipment Condition Report"`. ' example: Operator Vehicle/Equipment Condition Report code: type: string maxLength: 3 description: The VMRS Code Key 82 code (e.g. `"001"`, `"190"`). example: '001' description: type: string description: Human-readable name for the operator report condition. example: Aim/Alignment (Out of Adjustment) vmrs_operator_reports: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/vmrs_operator_report_properties-data' meta: type: object properties: record-count: type: integer description: Total number of VMRS Operator Report records across all pages. example: 136 vmrs_position: type: object required: - data properties: data: type: object required: - id - type - attributes properties: id: type: string description: The Code Key 79 `code` value (natural key). example: '01' type: type: string enum: - decisiv_vmrs_positions attributes: type: object required: - code_key - code_key_name - code - description properties: code_key: type: string description: VMRS Code Key number. Always `"79"` for position lookups. example: '79' code_key_name: type: string description: 'Human-readable label for the Code Key, sourced from the `Vmrs::Coding` data table. For Code Key 79 this is `"Position"`. ' example: Position code: type: string maxLength: 2 description: The VMRS Code Key 79 code (e.g. `"00"`, `"01"`). example: '01' description: type: string description: Human-readable name for the position. example: Front vmrs_positions: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/vmrs_position_properties-data' meta: type: object properties: record-count: type: integer description: Total number of VMRS Position records across all pages. example: 162 vmrs_work_accomplished: type: object required: - data properties: data: type: object required: - id - type - attributes properties: id: type: string description: The Code Key 15 `code` value (natural key). example: '01' type: type: string enum: - decisiv_vmrs_work_accomplished attributes: type: object required: - code_key - code_key_name - code - description properties: code_key: type: string description: VMRS Code Key number. Always `"15"` for work accomplished lookups. example: '15' code_key_name: type: string description: 'Human-readable label for the Code Key, sourced from the `Vmrs::Coding` data table. For Code Key 15 this is `"Work Accomplished"`. ' example: Work Accomplished code: type: string maxLength: 2 description: The VMRS Code Key 15 code (e.g. `"01"`, `"02"`). example: '01' description: type: string description: Human-readable short label for the work accomplished. example: Adjust vmrs_work_accomplished_list: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/vmrs_work_accomplished_properties-data' meta: type: object properties: record-count: type: integer description: Total number of VMRS Work Accomplished records across all pages. example: 68 vmrs_technician_part_failure_code: type: object required: - data properties: data: type: object required: - id - type - attributes properties: id: type: string description: The Code Key 18 `code` value (natural key). example: '01' type: type: string enum: - decisiv_vmrs_technician_part_failure_codes attributes: type: object required: - code_key - code_key_name - code - description properties: code_key: type: string description: VMRS Code Key number. Always `"18"` for technician part failure code lookups. example: '18' code_key_name: type: string description: 'Human-readable label for the Code Key, sourced from the `Vmrs::Coding` data table. For Code Key 18 this is `"Technician Part Failure Code"`. ' example: Technician Part Failure Code code: type: string maxLength: 2 description: The VMRS Code Key 18 code (e.g. `"00"`, `"01"`). example: '01' description: type: string description: Human-readable name for the technician part failure code. example: Battered, Hammered vmrs_technician_part_failure_codes: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/vmrs_technician_part_failure_code_properties-data' meta: type: object properties: record-count: type: integer description: Total number of VMRS Technician Part Failure Code records across all pages. example: 109 data: type: object properties: id: type: string format: uuid type: type: string attributes: type: object properties: content: type: string description: The case summary text example: Vehicle arrived with check engine light on. Diagnosed as faulty O2 sensor. Replaced and cleared codes. created_at: type: string format: date-time description: '`ISO 8601` timestamp indicating when the case summary was created' example: '2023-10-01T12:00:00Z' updated_at: type: string format: date-time description: '`ISO 8601` timestamp indicating when the case summary was last updated' example: '2023-10-01T12:00:00Z' required: - content - created_at - updated_at relationships: type: object properties: case: $ref: '#/components/schemas/relationship_object' required: - attributes - type - id properties-data: type: object properties: id: type: string format: uuid type: type: string enum: - cases attributes: type: object properties: complaint: type: string description: Initially reported information from driver or other customer entity examples: - Broken truck po_number: type: string description: The Purchase Order number examples: - '1234' auth_number: type: string description: The Authorization number examples: - '1234' ro_number: type: string description: The Repair Order number examples: - '1234' reference_number: type: number description: Integer representation of the Case ID inside of the User Interface closed: type: boolean description: Indicates whether the case has been closed. repair_status: type: string description: Status of the repair examples: - Hold (auth) status: type: string description: Status of the case examples: - Pick-up invoice: type: object description: The invoice information for the case properties: total: type: number description: The total amount of the invoice number: type: string description: The invoice number invoice_date: type: string format: date description: The date of the invoice examples: - '2025-04-07' event_timestamps: type: object description: All the timestamps related to the case properties: started_at: type: string format: date-time description: '`ISO 8601` timestamp indicating when the Case was first opened' examples: - '2022-04-14T05:23:45Z' requested_completion_time: type: string format: date-time description: '`ISO 8601` timestamp indicating the completion time of the case' examples: - '2022-04-14T05:23:45Z' requested_appointment_time: type: string format: date-time description: '`ISO 8601` timestamp indicating the appointment time' examples: - '2022-04-14T05:23:45Z' actual_time_to_repair: type: string format: date-time description: '`ISO 8601` timestamp indicating the time spent to repair the asset' examples: - '2022-04-14T05:23:45Z' estimated_time_to_repair: type: string format: date-time description: '`ISO 8601` timestamp indicating the time estimated to repair the asset' examples: - '2022-04-14T05:23:45Z' followup_time: type: string format: date-time description: '`ISO 8601` timestamp indicating the next check-in point between Customer / Provider' examples: - '2022-04-14T05:23:45Z' asset_arrived: type: string format: date-time description: '`ISO 8601` timestamp indicating when the Asset arrived' examples: - '2022-04-14T05:23:45Z' asset_checked_in: type: string format: date-time description: '`ISO 8601` timestamp indicating when the check-in was performed' examples: - '2022-04-14T05:23:45Z' closed_at: type: string format: date-time description: '`ISO 8601` timestamp indicating when the Case was marked as completed and closed' examples: - '2022-04-14T05:23:45Z' asset_uptime: type: string format: date-time description: '`ISO 8601` timestamp indicating when the Asset became operational, once again' examples: - '2022-04-14T05:23:45Z' asset_downtime: type: string format: date-time description: '`ISO 8601` timestamp indicating when the Asset was considered no longer operational' examples: - '2022-04-14T05:23:45Z' pricing: type: object description: Financial totals for the case, sourced directly from the Estimate properties: parts_total: type: number description: Total cost of parts examples: - 432.5 labor_total: type: number description: Total cost of labor examples: - 250 core_total: type: number description: Total cost of cores examples: - 75 tax: type: number description: Total tax amount examples: - 32.18 haz_waste: type: number description: Total hazardous waste charge examples: - 15 asset_information: type: object description: The asset information when the case was created properties: odometer_value: type: number description: Integer representation about the asset odometer odometer_unit: type: string description: Abbreviation for the asset odometer unit (e.g., `mi` for miles or `km` for kilometers). examples: - mi unit_number: type: string description: The unit number cargo: type: object properties: unit: type: - string - 'null' description: The unit number loaded: type: boolean description: Indicates whether the cargo is loaded. load: type: - string - 'null' description: The load amount breakdown: type: object description: Information about the breakdown location properties: city: type: string description: City of breakdown examples: - North Haven location: type: string description: Exact map location of the breakdown examples: - 41.395022,-72.856326 state: type: string description: State of the breakdown examples: - CT updated_at: type: string format: date-time description: '`ISO 8601` timestamp indicating when the case was last updated' examples: - '2022-04-14T05:23:45Z' created_at: type: string format: date-time description: '`ISO 8601` timestamp indicating when the case was created' examples: - '2022-04-14T05:23:45Z' relationships: type: object properties: registered_asset: $ref: '#/components/schemas/relationship_object' service_provider: $ref: '#/components/schemas/relationship_object' assignee: $ref: '#/components/schemas/relationship_object' billing_contact: $ref: '#/components/schemas/relationship_object' primary_contact: $ref: '#/components/schemas/relationship_object' estimates: $ref: '#/components/schemas/relationship_objects' required: - attributes - type - id attachment_properties-data: type: object properties: id: type: string format: uuid type: type: string attributes: type: object properties: description: type: string maxLength: 1024 description: The description of the file filename: type: - string - 'null' maxLength: 256 description: The name of the file. Null when the attachment was created via URL. example: example.pdf size: type: - integer - 'null' maximum: 10485760 description: The file size in bytes (max allowed is 10 megabytes). Null when the attachment was created via URL. example: 2684355 format: type: - string - 'null' description: The file content type. Null when the attachment was created via URL. example: application/pdf download_url: type: string description: A temporary URL to download the file, or the external URL when the attachment was created via URL. example: https://decisiv.net/shared/downloads/7746422/get_authed?filename=example.pdf&key=184bddd6479a3e3d created_at: type: string format: date-time description: '`ISO 8601` timestamp indicating when the attachment was created' example: '2023-10-01T12:00:00Z' updated_at: type: string format: date-time description: '`ISO 8601` timestamp indicating when the attachment was updated' example: '2023-10-01T12:00:00Z' required: - download_url - created_at - updated_at relationships: type: object properties: publisher: $ref: '#/components/schemas/relationship_object' subject: $ref: '#/components/schemas/relationship_object' required: - attributes - type - id contact_properties-data: type: object properties: id: type: string format: uuid type: type: string enum: - contacts attributes: type: object properties: first_name: type: string description: First name of the contact minLength: 2 maxLength: 100 last_name: type: string description: Last name of the contact minLength: 2 maxLength: 100 notes: type: string description: Notes about the contact minLength: 2 maxLength: 200 address1: type: string description: Primary address information maxLength: 100 address2: type: string description: Secondary address information maxLength: 100 city: type: string description: City in which the business resides maxLength: 100 state: type: string description: Second part of the `ISO 3166-2` code indicating the state minLength: 1 maxLength: 3 example: NJ country: type: string description: '`ISO 3166-1` alpha-2 code indicating the country' minLength: 2 maxLength: 2 example: US postal_code: type: string description: Postal ZIP Code maxLength: 20 communication: type: array description: Array of communication methods for the contact items: type: object properties: method_type: type: string description: Type of communication method (e.g., email, mobile) enum: - email - mobile value: type: string description: Value of the communication method (e.g., email address, phone number) minLength: 2 maxLength: 254 notify: type: boolean description: Indicates if notifications should be sent to this contact required: - method_type - value - notify required: - first_name - last_name - communication relationships: type: object required: - depot properties: depot: $ref: '#/components/schemas/relationship_object' required: - attributes - relationships - type - id participant_properties-data: type: object properties: id: type: string format: uuid type: type: string attributes: type: object properties: name: type: string description: Participant name example: Pilot Travel Centers scopes: type: array description: A list of scopes to which the participant belongs. items: type: string description: Name of the scope minItems: 1 example: - service_provider - billing_customer - customer - originator - other required: - attributes - type - id participant_recipient_properties-data: type: object properties: id: type: string format: uuid type: type: string attributes: type: object properties: name: type: string description: Full recipient name example: John Doe email: type: string description: Recipient email example: support@support.com phone: type: string description: Recipient mobile phone example: '12345678910' relationships: type: object properties: affiliation: $ref: '#/components/schemas/relationship_object' required: - attributes - type - id recipient_properties-data: type: object properties: id: type: string format: uuid type: type: string attributes: type: object properties: username: type: string description: The username inside the system example: support@support.com first_name: type: string description: First name example: John last_name: type: string description: Last name example: Doe name: type: string description: Full name example: John Doe email: type: string description: Contact email example: support@support.com affiliation: type: object properties: account_name: type: string description: The account from the recipient example: Dealer Name recipient_type: type: string example: other required: - attributes - type - id deactivated_asset_properties-data: type: object properties: id: type: string format: uuid type: type: string enum: - registered_assets attributes: type: object properties: vin: type: string description: 17 digit vehicle identification number minLength: 17 maxLength: 17 serial_number: type: string description: Production number of the asset minLength: 8 maxLength: 9 unit_number: type: string maxLength: 255 description: Identification number commonly used on assets residing within a fleet chassis_id: type: string maxLength: 255 description: Unique identifier consisting of a letter (chassis series) and six digits (chassis number) fleet_info: type: string maxLength: 255 description: Free-form text associated with the asset. Shown as "Fleet Info" in the fleet UI. No defined format or meaning. make: type: string maxLength: 255 description: Brand of the asset model: type: string maxLength: 255 description: Name of the asset product from the manufacturer year: type: integer description: Calendar year the asset model was released odometer_value: type: number description: Integer representation about the asset odometer odometer_unit: type: string description: abreviation about the unit of asset can be mi for miles or km for Kilometers example: mi engine_hours: type: string description: Integer representation about the engine hours of asset minLength: 0 maxLength: 25 notes: type: string maxLength: 1000 description: Notes about the asset engine: type: object description: Engine data properties: make: type: string maxLength: 255 description: The make of the engine model: type: string maxLength: 255 description: The model of the engine displacement: type: string maxLength: 255 license: type: object description: License plate data properties: number: type: string maxLength: 20 description: The number of the license plate state: type: string minLength: 2 maxLength: 10 description: The second part of the ISO 3166-2 code indicates the license State country: type: string minLength: 2 maxLength: 2 description: ISO 3166-1 alpha-2 code indicating the license Country expiration: type: string format: date description: '`ISO 8601` date indicating when the license expires' example: '2029-06-18' vmrs_asset_status: type: string vmrs: type: object readOnly: true description: VMRS classification of the asset properties: asset_type: type: object description: VMRS Code Key 2 (Equipment Category) properties: code_key: type: string description: The VMRS code key identifier example: '2' code: type: string description: The VMRS code value for the equipment category (e.g. 'D', '1', 'R') metadata: type: object additionalProperties: true event_timestamps: type: object properties: deactivated_at: type: string format: date-time description: '`ISO 8601` timestamp indicating when the asset was deactivated' required: - attributes - type - id deactivated_depot_properties-data: type: object properties: id: type: string format: uuid type: type: string enum: - depots attributes: type: object properties: name: type: string description: Name of the depot maxLength: 255 example: Depot Company Test 1 address1: type: string description: Primary address line for the depot maxLength: 255 example: Some street address2: type: string description: Secondary address line for the depot maxLength: 255 example: Some complement city: type: string description: City where the depot is located maxLength: 255 example: New York state: type: string description: Second part of the `ISO 3166-2` code indicating the state maxLength: 10 example: NY country: type: string description: '`ISO 3166-1` alpha-2 code indicating the country' maxLength: 10 example: US postal_code: type: string description: Postal or ZIP code for the depot location maxLength: 20 example: '123456' phone: type: string description: Contact phone number for the depot maxLength: 30 example: +1 321 321321 fax: type: - string - 'null' description: Contact fax number for the depot maxLength: 30 example: +1 321 321321 email: type: string description: Contact email address. Validated for syntax and deliverable domain — addresses whose domain has no resolvable DNS host are rejected. maxLength: 254 example: test@test.com note: type: - string - 'null' description: Free-form notes about the depot maxLength: 1000 example: Tricky depot external_reference: type: object properties: fms: type: string maxLength: 40 example: depot-fms-ref-001 metadata: type: object additionalProperties: true required: - name - email required: - attributes - type - id depot_properties-data: type: object properties: id: type: string format: uuid type: type: string enum: - depots attributes: type: object properties: name: type: string description: Name of the depot maxLength: 255 example: Depot Company Test 1 address1: type: string description: Primary address line for the depot maxLength: 255 example: Some street address2: type: string description: Secondary address line for the depot maxLength: 255 example: Some complement city: type: string description: City where the depot is located maxLength: 255 example: New York state: type: string description: Second part of the `ISO 3166-2` code indicating the state maxLength: 10 example: NY country: type: string description: '`ISO 3166-1` alpha-2 code indicating the country' maxLength: 10 example: US postal_code: type: string description: Postal or ZIP code for the depot location maxLength: 20 example: '123456' phone: type: string description: Contact phone number for the depot maxLength: 30 example: +1 321 321321 fax: type: - string - 'null' description: Contact fax number for the depot maxLength: 30 example: +1 321 321321 email: type: string description: Contact email address. Validated for syntax and deliverable domain — addresses whose domain has no resolvable DNS host are rejected. maxLength: 254 example: test@test.com note: type: - string - 'null' description: Free-form notes about the depot maxLength: 1000 example: Tricky depot external_reference: type: object properties: fms: type: string maxLength: 40 example: COMPANY FMS metadata: type: object additionalProperties: true required: - name - email required: - attributes - type - id estimate_properties-data: type: object properties: id: type: string format: uuid type: type: string enum: - estimates attributes: type: object properties: version: type: integer description: Version of the estimate examples: - 1 status: type: string description: Status of the estimate examples: - requested total: type: number description: Total cost of the estimate examples: - 749.86 updated_at: type: string format: date-time description: '`ISO 8601` timestamp indicating when the estimate was updated' examples: - '2022-04-14T05:23:45Z' created_at: type: string format: date-time description: '`ISO 8601` timestamp indicating when the estimate was created' examples: - '2022-04-14T05:23:45Z' totals: type: object description: The detailed description of expenses for the total properties: shop_supplies: type: number description: Detailed cost of shop supplies examples: - 749.86 hazwaste: type: number description: Detailed cost of hazwaste examples: - 749.86 freight: type: number description: Detailed cost of freight examples: - 749.86 tax: type: number description: Detailed cost of tax examples: - 749.86 labor: type: number description: Detailed cost of labor examples: - 749.86 core: type: number description: Detailed cost of core examples: - 749.86 parts: type: number description: Detailed cost of parts examples: - 749.86 event_timestamps: type: object description: All the timestamps related to the estimate properties: estimated_time_to_repair: type: string format: date-time description: '`ISO 8601` timestamp indicating the time estimated to repair the asset' examples: - '2022-04-14T05:23:45Z' reviewed_at: type: string format: date-time description: '`ISO 8601` timestamp indicating when the estimate was reviewed' examples: - '2022-04-14T05:23:45Z' approval_requested_at: type: - string - 'null' format: date-time description: '`ISO 8601` timestamp indicating when approval was requested for this estimate version. Backed by `estimate_versions.created_at` — the same value exposed by the top-level `created_at` attribute.' examples: - '2022-04-14T05:23:45Z' line_items: type: array description: Line items inside the estimate items: type: object properties: id: type: string description: UUID of the line item name: type: string description: Name of the line item status: type: string description: Status of the line item examples: - requested total: type: number description: Total cost of the line item examples: - 749.86 totals: type: object description: The detailed description of expenses for the total properties: labor: type: number description: Detailed cost of labor examples: - 749.86 core: type: number description: Detailed cost of core examples: - 749.86 parts: type: number description: Detailed cost of parts examples: - 749.86 parts: type: array description: Line items parts in the estimate items: type: object properties: name: type: string examples: - hose quantity: type: integer examples: - 1 vmrs: type: array description: Line items vrms in the estimate items: type: object properties: code_key: type: string examples: - '33' code_key_name: type: string examples: - Component Code code: type: string examples: - 013-007-024 description: type: string examples: - Line - Air Coiled relationships: type: object properties: service_writer: $ref: '#/components/schemas/relationship_object' reviewer: $ref: '#/components/schemas/relationship_object' case: $ref: '#/components/schemas/relationship_object' required: - attributes - type - id extended_attribute_properties-data: type: object properties: id: type: string format: uuid type: type: string attributes: type: object properties: name: type: string description: Description of extended attribute minLength: 1 maxLength: 255 schema: type: object oneOf: - type: object description: String with enum validation required: - type - enum properties: type: type: string example: string enum: type: array items: type: string - type: object description: String with length validation required: - type - minLength - maxLength properties: type: type: string example: string minLength: type: integer maxLength: type: integer - type: object description: String with pattern validation required: - type - pattern properties: type: type: string example: string pattern: type: string - type: object description: Integer with range validation required: - type - minimum - maximum properties: type: type: integer example: 42 minimum: type: integer maximum: type: integer - type: object description: Integer with enum validation required: - type - enum properties: type: type: integer example: 42 enum: type: array items: type: integer - type: object description: Number with range validation required: - type - minimum - maximum properties: type: type: number example: 3.14 minimum: type: number maximum: type: number - type: object description: Boolean required: - type properties: type: type: boolean example: true - type: object description: Datetime required: - type - format properties: type: type: string example: string format: type: string example: date-time - type: object description: Date required: - type - format properties: type: type: string example: string format: type: string example: date - type: object description: Time required: - type - format properties: type: type: string example: string format: type: string example: time - type: object description: Email required: - type - format properties: type: type: string example: string format: type: string example: email - type: object description: URI required: - type - format properties: type: type: string example: string format: type: string example: uri - type: object description: UUID required: - type - format properties: type: type: string example: string format: type: string example: uuid required: - attributes - type - id extended_asset_attribute_properties-data: type: object properties: id: type: string format: uuid type: type: string attributes: type: object properties: name: type: string description: Name of the extended asset attribute value: type: string description: Value of extended attribute for the asset created_at: type: string format: date-time description: '`ISO 8601` timestamp indicating when the extended asset attribute was created' example: '2022-04-14T05:23:45Z' updated_at: type: string format: date-time description: '`ISO 8601` timestamp indicating when the extended asset attribute was updated' example: '2022-04-14T05:23:45Z' required: - value relationships: type: object properties: account_extended_attribute: $ref: '#/components/schemas/relationship_object' registered_asset: $ref: '#/components/schemas/relationship_object' required: - account_extended_attribute - registered_asset required: - attributes - relationships - type - id internal_user_properties-data: type: object properties: id: type: string format: uuid type: type: string enum: - internal_users attributes: type: object properties: first_name: type: string description: First name of the internal user maxLength: 50 last_name: type: string description: Last name of the internal user maxLength: 50 email: type: string description: Email of the internal user maxLength: 120 external_reference: type: object description: Reference Identifiers used outside of Decisiv SRM properties: business_system: type: - string - 'null' description: Business System Identifier required: - attributes - type - id registered_asset_properties-data: type: object properties: id: type: string format: uuid type: type: string enum: - registered_assets attributes: type: object properties: vin: type: string description: 17 digit vehicle identification number minLength: 17 maxLength: 17 serial_number: type: string description: Production number of the asset minLength: 6 maxLength: 36 unit_number: type: string maxLength: 255 description: Identification number commonly used on assets residing within a fleet chassis_id: type: string maxLength: 255 description: Unique identifier consisting of a letter (chassis series) and six digits (chassis number) fleet_info: type: string maxLength: 255 description: Free-form text associated with the asset. Shown as "Fleet Info" in the fleet UI. No defined format or meaning. make: type: string maxLength: 255 description: Brand of the asset model: type: string maxLength: 255 description: Name of the asset product from the manufacturer year: type: integer minimum: 1970 maximum: 2028 description: 'Calendar year the asset model was released, minimum: 1970, maximum: two years from now' odometer_value: type: number description: Integer representation about the asset odometer odometer_unit: type: string description: ' The unit of measure for odometer value represented in standard or metric (mi = Miles or km = Kilometers)' enum: - mi - km engine_hours: type: - integer - 'null' description: Integer representation about the engine hours of asset stand_by_hours: type: - integer - 'null' description: Integer representation about the stand by hours of asset switch_on_hours: type: - integer - 'null' description: Integer representation about the switch on hours of asset fuel_consumed_value: type: - integer - 'null' description: Integer representation of the total fuel consumed by the asset (stored in gallons) fuel_consumed_unit: type: string description: Unit of measure for fuel consumed. Always returned as `gal`. enum: - gal notes: type: string maxLength: 1000 description: Notes about the asset gvwr: type: object description: Gross Vehicle Weight Rating properties: value: type: string description: The numeral value for the weight unit_of_measure: type: string description: The unit of measure used, can be `kg` or `lb` enum: - kg - lb engine: type: object description: Engine data properties: make: type: string maxLength: 255 description: The make of the engine model: type: string maxLength: 255 description: The model of the engine displacement: type: string maxLength: 50 description: The engine size related in liters or cubic inches serial_number: type: string description: The engine serial number minLength: 1 maxLength: 40 license: type: object description: License plate data properties: number: type: string maxLength: 50 description: The number of the license plate state: type: string minLength: 2 maxLength: 10 description: The second part of the ISO 3166-2 code indicates the license State country: type: string enum: - US - CA - MX - EC minLength: 2 maxLength: 2 description: ISO 3166-1 alpha-2 code indicating the license Country expiration: type: string format: date description: '`ISO 8601` date indicating when the license expires' example: '2029-06-18' vmrs_asset_status: type: string description: 'Valid values are: 01, 02, 12, 13, 15, 16, 31, 33, 40, 41, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61' vmrs: type: object description: VMRS classification of the asset. properties: asset_type: type: object description: VMRS Code Key 2 (Equipment Category). properties: code_key: type: string description: The VMRS code key identifier. Must be `"2"` when supplied on write. example: '2' code: type: string description: The VMRS Code Key 2 code (e.g. `"D"`, `"1"`, `"R"`). Must match an active value from `GET /vmrs/asset_types`. metadata: type: object description: 'Arbitrary key-value pairs for custom asset metadata (max 50 entries). Keys: lowercase snake_case, 1-50 chars, alphanumeric start/end, no double underscores. Values: required strings, max 500 chars.' minProperties: 1 maxProperties: 50 propertyNames: minLength: 1 maxLength: 50 pattern: ^[a-z0-9]+(_{1}[a-z0-9]+)*$ additionalProperties: type: string minLength: 1 maxLength: 500 relationships: type: object properties: depot: $ref: '#/components/schemas/relationship_object' srm_verified_asset: $ref: '#/components/schemas/relationship_object' extended_asset_attributes: $ref: '#/components/schemas/relationship_objects' required: - attributes - type - id meter_data_fuel_consumed_registered_asset: type: object required: - data properties: data: type: object properties: id: type: string format: uuid type: type: string attributes: type: object properties: meter_data: type: array description: Fuel-consumed meter readings to record on the registered asset. items: type: object description: Type of meter data properties: meter: type: string enum: - fuel_consumed description: Meter data type to be changed unit: type: string enum: - gal - gallons - l - liters description: Unit of measurement for given meter data. Valid units for `fuel_consumed` are `gal`, `gallons`, `l`, and `liters`. The value is always stored and returned in gallons (`gal`). value: type: number description: Reading value for the given meter data. Decimal values are accepted and rounded to the nearest integer when stored. registered_component_properties-data: type: object properties: id: type: string format: uuid type: type: string example: registered_components attributes: type: object properties: name: type: string description: Description of component minLength: 1 maxLength: 255 serial_number: type: string description: Production number of the component minLength: 1 maxLength: 255 make: type: string description: Brand of the component minLength: 1 maxLength: 255 model: type: string description: Name of the component product from the manufacturer minLength: 1 maxLength: 255 year: type: integer description: Calendar year the component model was released minLength: 4 maxLength: 4 minimum: 1000 maximum: 9999 event_timestamps: type: object description: All the timestamps related to the component properties: installed_on: type: string format: date-time description: '`ISO 8601` timestamp indicating the component was installed' example: '2022-04-14T05:23:45Z' created_at: type: string format: date-time description: '`ISO 8601` timestamp indicating when the component was created' example: '2022-04-14T05:23:45Z' updated_at: type: string format: date-time description: '`ISO 8601` timestamp indicating when the component was updated' example: '2022-04-14T05:23:45Z' metadata: type: object additionalProperties: true relationships: type: object properties: registered_asset: $ref: '#/components/schemas/relationship_object' registered_components: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/registered_component_properties-data' meta: type: object service_provider_properties-data: type: object properties: id: type: string format: uuid type: type: string attributes: type: object properties: name: type: string description: Name of the Service Provider minLength: 1 maxLength: 150 address1: type: string description: Primary Address for the Service Provider minLength: 0 maxLength: 255 address2: type: string description: Secondary address identifier minLength: 0 maxLength: 255 city: type: string description: City which the Service Provider business resides minLength: 0 maxLength: 30 state: type: string description: 2 Letter state abbreviation minLength: 0 maxLength: 2 postal_code: type: string description: Postal zip code of the Service Provider location minLength: 0 maxLength: 18 country: type: string description: Country of Service Povider, in `ISO 3166-1 alpha-2` format minLength: 0 maxLength: 2 phone: type: string description: Telephone contact information for the Service Provider minLength: 0 maxLength: 30 fax: type: string description: Fax information for the Service Provider minLength: 0 maxLength: 30 email: type: string description: Email contact information for the Service Provider minLength: 0 maxLength: 120 location: type: object description: Geolocation information about the Service Provider properties: latitude: type: number longitude: type: number distance_from_geolocation: type: number external_reference: type: object description: External reference information for the Service Provider properties: srm_account_id: type: string description: SRM Account ID for the Service Provider minLength: 7 maxLength: 7 relationships: type: object properties: service_networks: $ref: '#/components/schemas/relationship_object' required: - attributes service_request_properties-data: type: object properties: id: type: string format: uuid type: type: string enum: - service_requests attributes: type: object properties: complaint: type: string description: Initially reported information from driver or other customer entity examples: - Broken truck po_number: type: string description: PO number examples: - '1234' auth_number: type: string description: The auth number examples: - '1234' note: type: string description: The notes for the service request examples: - Initial note reference_number: type: number description: Integer representation of the service request ID inside of the User Interface status: type: string description: Status of the service request examples: - Pick-up updated_at: type: string format: date-time description: '`ISO 8601` timestamp indicating when the service request was updated' examples: - '2022-04-14T05:23:45Z' created_at: type: string format: date-time description: '`ISO 8601` timestamp indicating when the service request was created' examples: - '2022-04-14T05:23:45Z' asset_information: type: object description: The asset information when the service request was created properties: odometer_value: type: number description: Integer representation about the asset odometer odometer_unit: type: string description: abreviation about the unit of asset can be mi for miles or km for Kilometers examples: - mi breakdown: type: object description: Information about the breakdown location properties: city: type: string description: City of breakdown examples: - North Haven location: type: string description: Exact map location of the breakdown examples: - 41.395022,-72.856326 state: type: string description: State of the breakdown examples: - CT primary_contact: type: object description: Primary contact information properties: first_name: type: string description: First name examples: - Martha last_name: type: string description: Last name examples: - Wayne email: type: string description: Contact email examples: - martha@wayne.com relation: type: string examples: - Bobby phone: type: object description: Phone information properties: mobile: type: string examples: - (582) 123-1234 work: type: string examples: - (582) 123-1234 driver: type: object description: Driver information properties: first_name: type: string description: First name examples: - Martha last_name: type: string description: Last name examples: - Wayne email: type: string description: Contact email examples: - martha@wayne.com phone: type: object description: Phone information properties: mobile: type: string examples: - (582) 123-1234 work: type: string examples: - (582) 123-1234 metadata: type: string additionalProperties: true event_timestamps: type: object description: All the timestamps related to the service request properties: requested_at: type: string format: date-time description: '`ISO 8601` timestamp indicating when the service was requested' examples: - '2022-04-14T05:23:45Z' requested_completion_time: type: string format: date-time description: '`ISO 8601` timestamp indicating the completion time of the case' examples: - '2022-04-14T05:23:45Z' requested_appointment_time: type: string format: date-time description: '`ISO 8601` timestamp indicating the appointment time' examples: - '2022-04-14T05:23:45Z' asset_downtime: type: string format: date-time description: '`ISO 8601` timestamp indicating when the Asset was considered no longer operational' examples: - '2022-04-14T05:23:45Z' relationships: type: object properties: registered_asset: $ref: '#/components/schemas/relationship_object' service_provider: $ref: '#/components/schemas/relationship_object' case: $ref: '#/components/schemas/relationship_object' primary_contact: description: The contact designated as the primary contact for the service request. Resolved from the service request's descriptive primary contact information against the fleet's contacts; absent when no matching contact is found. $ref: '#/components/schemas/relationship_object' required: - attributes - type - id vmrs_asset_type_properties-data: type: object required: - id - type - attributes properties: id: type: string description: The Code Key 2 `code` value (natural key). example: '01' type: type: string enum: - decisiv_vmrs_asset_types attributes: type: object required: - code_key - code_key_name - code - description properties: code_key: type: string description: VMRS Code Key number. Always `"2"` for asset type lookups. example: '2' code_key_name: type: string description: 'Human-readable label for the Code Key, sourced from the `Vmrs::Coding` data table. For Code Key 2 this is `"Equipment Category"`. ' example: Equipment Category code: type: string maxLength: 2 description: The VMRS Code Key 2 code (e.g. `"01"`, `"D"`). example: '01' description: type: string description: Human-readable name for the asset type / equipment category. example: Truck vmrs_reason_for_repair_properties-data: type: object required: - id - type - attributes properties: id: type: string description: The Code Key 14 `code` value (natural key). example: '01' type: type: string enum: - decisiv_vmrs_reasons_for_repair attributes: type: object required: - code_key - code_key_name - code - description - category properties: code_key: type: string description: VMRS Code Key number. Always `"14"` for reason-for-repair lookups. example: '14' code_key_name: type: string description: 'Human-readable label for the Code Key, sourced from the `Vmrs::Coding` data table. For Code Key 14 this is `"Reason for Repair"`. ' example: Reason for Repair code: type: string maxLength: 2 description: The VMRS Code Key 14 code (e.g. `"01"`, `"70"`). example: '01' description: type: string description: Human-readable name for the reason for repair. example: Breakdown category: type: string description: 'The VMRS Code Key 14 `repair_type` grouping the reason belongs to (e.g. `"Maintenance"`, `"Outside Influence"`, `"Management Decision"`). ' example: Maintenance vmrs_repair_priority_properties-data: type: object required: - id - type - attributes properties: id: type: string description: The Code Key 16 `code` value (natural key). example: '1' type: type: string enum: - decisiv_vmrs_repair_priorities attributes: type: object required: - code_key - code_key_name - code - description properties: code_key: type: string description: VMRS Code Key number. Always `"16"` for repair-priority lookups. example: '16' code_key_name: type: string description: 'Human-readable label for the Code Key, sourced from the `Vmrs::Coding` data table. For Code Key 16 this is `"Repair Priority Class"`. ' example: Repair Priority Class code: type: string maxLength: 1 description: The VMRS Code Key 16 code (e.g. `"1"`, `"2"`, `"3"`). example: '1' description: type: string description: Human-readable name for the repair priority class. example: Scheduled vmrs_repair_site_properties-data: type: object required: - id - type - attributes properties: id: type: string description: The Code Key 17 `code` value (natural key). example: '1' type: type: string enum: - decisiv_vmrs_repair_sites attributes: type: object required: - code_key - code_key_name - code - description properties: code_key: type: string description: VMRS Code Key number. Always `"17"` for repair-site lookups. example: '17' code_key_name: type: string description: 'Human-readable label for the Code Key, sourced from the `Vmrs::Coding` data table. For Code Key 17 this is `"Repair Site"`. ' example: Repair Site code: type: string maxLength: 1 description: The VMRS Code Key 17 code (e.g. `"1"`, `"2"`, `"3"`). example: '1' description: type: string description: Human-readable name for the repair site. example: Facility (Fleet) vmrs_component_properties-data: type: object required: - id - type - attributes properties: id: type: string description: The Code Key 33 `code` value (natural key). example: 001-000-000 type: type: string enum: - decisiv_vmrs_components attributes: type: object required: - code_key - code_key_name - code - description properties: code_key: type: string description: VMRS Code Key number. Always `"33"` for component lookups. example: '33' code_key_name: type: string description: 'Human-readable label for the Code Key, sourced from the `Vmrs::Coding` data table. For Code Key 33 this is `"Component"`. ' example: Component code: type: string maxLength: 11 description: The VMRS Code Key 33 code (e.g. `"001-000-000"`). example: 001-000-000 description: type: string description: Human-readable name for the component. example: Air Conditioning, Heating & Ventilating System vmrs_operator_report_properties-data: type: object required: - id - type - attributes properties: id: type: string description: The Code Key 82 `code` value (natural key). example: '001' type: type: string enum: - decisiv_vmrs_operator_reports attributes: type: object required: - code_key - code_key_name - code - description properties: code_key: type: string description: VMRS Code Key number. Always `"82"` for operator report lookups. example: '82' code_key_name: type: string description: 'Human-readable label for the Code Key, sourced from the `Vmrs::Coding` data table. For Code Key 82 this is `"Operator Vehicle/Equipment Condition Report"`. ' example: Operator Vehicle/Equipment Condition Report code: type: string maxLength: 3 description: The VMRS Code Key 82 code (e.g. `"001"`, `"190"`). example: '001' description: type: string description: Human-readable name for the operator report condition. example: Aim/Alignment (Out of Adjustment) vmrs_position_properties-data: type: object required: - id - type - attributes properties: id: type: string description: The Code Key 79 `code` value (natural key). example: '01' type: type: string enum: - decisiv_vmrs_positions attributes: type: object required: - code_key - code_key_name - code - description properties: code_key: type: string description: VMRS Code Key number. Always `"79"` for position lookups. example: '79' code_key_name: type: string description: 'Human-readable label for the Code Key, sourced from the `Vmrs::Coding` data table. For Code Key 79 this is `"Position"`. ' example: Position code: type: string maxLength: 2 description: The VMRS Code Key 79 code (e.g. `"00"`, `"01"`). example: '01' description: type: string description: Human-readable name for the position. example: Front vmrs_work_accomplished_properties-data: type: object required: - id - type - attributes properties: id: type: string description: The Code Key 15 `code` value (natural key). example: '01' type: type: string enum: - decisiv_vmrs_work_accomplished attributes: type: object required: - code_key - code_key_name - code - description properties: code_key: type: string description: VMRS Code Key number. Always `"15"` for work accomplished lookups. example: '15' code_key_name: type: string description: 'Human-readable label for the Code Key, sourced from the `Vmrs::Coding` data table. For Code Key 15 this is `"Work Accomplished"`. ' example: Work Accomplished code: type: string maxLength: 2 description: The VMRS Code Key 15 code (e.g. `"01"`, `"02"`). example: '01' description: type: string description: Human-readable short label for the work accomplished. example: Adjust vmrs_technician_part_failure_code_properties-data: type: object required: - id - type - attributes properties: id: type: string description: The Code Key 18 `code` value (natural key). example: '01' type: type: string enum: - decisiv_vmrs_technician_part_failure_codes attributes: type: object required: - code_key - code_key_name - code - description properties: code_key: type: string description: VMRS Code Key number. Always `"18"` for technician part failure code lookups. example: '18' code_key_name: type: string description: 'Human-readable label for the Code Key, sourced from the `Vmrs::Coding` data table. For Code Key 18 this is `"Technician Part Failure Code"`. ' example: Technician Part Failure Code code: type: string maxLength: 2 description: The VMRS Code Key 18 code (e.g. `"00"`, `"01"`). example: '01' description: type: string description: Human-readable name for the technician part failure code. example: Battered, Hammered securitySchemes: AccessToken: type: http scheme: bearer bearerFormat: JWT OAuth2AuthorizationCode: type: oauth2 description: OAuth 2.0 Authorization Code flow. This is the required flow for new integrations. See https://api-docs.decisiv.net/docs/api/oauth/ flows: authorizationCode: authorizationUrl: https://login.decisiv.net/auth/api_gateway tokenUrl: https://login.decisiv.net/oauth/token refreshUrl: https://login.decisiv.net/oauth/token scopes: {} OAuth2Password: type: oauth2 description: '**Deprecated.** OAuth 2.0 Password flow. New integrations must use the Authorization Code flow (`OAuth2AuthorizationCode`); this flow remains available only during the migration window and will be removed in a future release. See https://api-docs.decisiv.net/docs/api/oauth/' flows: password: tokenUrl: https://login.decisiv.net/oauth/token scopes: {}