s1 API Host

<back to all web services

GetMaintenancePlanChecklistRequest

The following routes are available for this service:
GET,OPTIONS/api/cars/tecrmi/{tecRmiCarId}/maintenance/bodies/{bodyId}/checklistGet a maintenance plan checklist for tecRmi maintenanceGroupsUser has to be authenticated.
Parameters:
NameParameterData TypeRequiredDescription
tecRmiCarIdpathintYesThe TecRmi car id
bodyIdpathintYesThe chosen body id from /cars/tecrmi/{tecRmiCarId}/maintenance/bodies
workIdsqueryintNo
additionalWorkIdsqueryintNo
ShowTiresqueryboolNoWill not print tire profile depth image if this is set to false.
LicensePlatequerystringNoDefault is Empty. If Given, will display a license plate on the checklist
CarIdquerystringNoThe car id. Default is Empty, If Given, will display the car info on the checklist.

To override the Content-type in your clients HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/GetMaintenancePlanChecklistRequest HTTP/1.1 
Host: s1-api-tst.fource.nl 
Content-Type: application/xml
Content-Length: length

<GetMaintenancePlanChecklistRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/S1.Api.Domain.Models.Cars">
  <AdditionalWorkIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <BodyId>0</BodyId>
  <CarId>String</CarId>
  <LicensePlate>String</LicensePlate>
  <ShowTires>false</ShowTires>
  <TecRmiCarId>0</TecRmiCarId>
  <WorkIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
</GetMaintenancePlanChecklistRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

(byte[])