Service Provider: Repair Order/Case Detail
This API should have ability to search all RO/Cases with data in a date range by customer. The API should have a viable and efficient way to have more than one RO/Case update (i.e., one incident vs. collection of incidents).
This GET web service endpoint fetches data for a single RO/Case based on the RO/Case's unique number. Provision for the following data elements or fields should be made accordingly:
- Repair Order/Case Header
- Repair Order/Case Number (string, required)
- Created On (date/time, required)
- Modified On (date/time, required)
- Branch (Branch Summary, required)
- Bill-To Customer Number (string, optional)
- Bill-To Customer Name (string, optional)
- Ship-To Customer Number (string, optional)
- Ship-To Customer Name (string, optional)
- VIN17 (string, required)
- Unit Number (string, optional)
- Status Code (int, required)
- Labor Operations (Labor Operation List, required) - A resource list of labor operations for this RO.
- Annotations (Annotation List, required) - A resource list of annotations for this RO.
- Labor Operation List
- Count (int, required)- The number of labor operations
- Resource URI (string, required) - The URI for the web service endpoint to retrieve the latest data for the labor operations on this RO/Case (see Labor Operation Detail).
NOTE:
If a search request can return many RO/Cases (instead of just one as an embedded list vs. a secondary call), TMC recommends that the data be limited to no more than 300 ROs to ensure lean traffic and resource impact. The API should be versatile enough to get the detail by VIN, and then allow more data to be pulled, as needed. With restrictions, TMC recommends the API use virtual paging across the network. Error handling for dropped transactions should be built into the API to know if when unsuccessful events have occurred.
- Annotation List
- Count (int, required) - The number of labor operations.
- Items (Array [Annotation Summary], required) - The list of annotations on this RO/Case.
- Annotation Summary
- Id (string, required) - The unique identifier used by the service provider for this annotation.
- Resource URI (string, required) - The U RI for the web service endpoint to retrieve the latest data for this annotation (see RO Annotation Detail).
- Branch Summary
- Id (string, required) - The unique identifier used by the service provider for this branch.
- Name (string, optional) - The display name for this branch.
- Resource URI (string, required) - The URI for the web service endpoint to retrieve the latest data for this branch (see Branch Detail).