ToolChest Web Service

ToolChest

Click here for a complete list of operations.

ServiceVehicleGetById

Returns the service vehicle matching the specified identifier.

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /PROD-R4-1/Toolchest.asmx HTTP/1.1
Host: servicestationapi.bartecautoid.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://bartecautoid.com/ServiceVehicleGetById"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthHeader xmlns="http://bartecautoid.com/">
      <ApiUsername>string</ApiUsername>
      <ApiPassword>string</ApiPassword>
    </AuthHeader>
  </soap:Header>
  <soap:Body>
    <ServiceVehicleGetById xmlns="http://bartecautoid.com/">
      <authenticatedUser>
        <Oid>guid</Oid>
        <Username>string</Username>
        <UserRegion>US or Europe</UserRegion>
        <UtcOffset>short</UtcOffset>
        <PhoneNumber>string</PhoneNumber>
      </authenticatedUser>
      <serviceVehicleId>int</serviceVehicleId>
    </ServiceVehicleGetById>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ServiceVehicleGetByIdResponse xmlns="http://bartecautoid.com/">
      <ServiceVehicleGetByIdResult>
        <Success>boolean</Success>
        <ErrorMessage>string</ErrorMessage>
        <Data>
          <Id>int</Id>
          <Region>string</Region>
          <UserOid>guid</UserOid>
          <VIN>string</VIN>
          <ServiceMileage>int</ServiceMileage>
          <ServiceRegistration>string</ServiceRegistration>
          <YearOfFirstRegistration>dateTime</YearOfFirstRegistration>
          <Make>string</Make>
          <Model>string</Model>
          <Qualifier>string</Qualifier>
          <Year>int</Year>
          <YearFrom>int</YearFrom>
          <YearTo>int</YearTo>
          <MonthFrom>int</MonthFrom>
          <MonthTo>int</MonthTo>
          <Comments>string</Comments>
          <VehicleCustomerId>int</VehicleCustomerId>
          <TpmsServices>
            <TpmsService xsi:nil="true" />
            <TpmsService xsi:nil="true" />
          </TpmsServices>
          <ObdServices>
            <ObdService xsi:nil="true" />
            <ObdService xsi:nil="true" />
          </ObdServices>
          <TreadServices>
            <TreadService xsi:nil="true" />
            <TreadService xsi:nil="true" />
          </TreadServices>
        </Data>
      </ServiceVehicleGetByIdResult>
    </ServiceVehicleGetByIdResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /PROD-R4-1/Toolchest.asmx HTTP/1.1
Host: servicestationapi.bartecautoid.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <AuthHeader xmlns="http://bartecautoid.com/">
      <ApiUsername>string</ApiUsername>
      <ApiPassword>string</ApiPassword>
    </AuthHeader>
  </soap12:Header>
  <soap12:Body>
    <ServiceVehicleGetById xmlns="http://bartecautoid.com/">
      <authenticatedUser>
        <Oid>guid</Oid>
        <Username>string</Username>
        <UserRegion>US or Europe</UserRegion>
        <UtcOffset>short</UtcOffset>
        <PhoneNumber>string</PhoneNumber>
      </authenticatedUser>
      <serviceVehicleId>int</serviceVehicleId>
    </ServiceVehicleGetById>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <ServiceVehicleGetByIdResponse xmlns="http://bartecautoid.com/">
      <ServiceVehicleGetByIdResult>
        <Success>boolean</Success>
        <ErrorMessage>string</ErrorMessage>
        <Data>
          <Id>int</Id>
          <Region>string</Region>
          <UserOid>guid</UserOid>
          <VIN>string</VIN>
          <ServiceMileage>int</ServiceMileage>
          <ServiceRegistration>string</ServiceRegistration>
          <YearOfFirstRegistration>dateTime</YearOfFirstRegistration>
          <Make>string</Make>
          <Model>string</Model>
          <Qualifier>string</Qualifier>
          <Year>int</Year>
          <YearFrom>int</YearFrom>
          <YearTo>int</YearTo>
          <MonthFrom>int</MonthFrom>
          <MonthTo>int</MonthTo>
          <Comments>string</Comments>
          <VehicleCustomerId>int</VehicleCustomerId>
          <TpmsServices>
            <TpmsService xsi:nil="true" />
            <TpmsService xsi:nil="true" />
          </TpmsServices>
          <ObdServices>
            <ObdService xsi:nil="true" />
            <ObdService xsi:nil="true" />
          </ObdServices>
          <TreadServices>
            <TreadService xsi:nil="true" />
            <TreadService xsi:nil="true" />
          </TreadServices>
        </Data>
      </ServiceVehicleGetByIdResult>
    </ServiceVehicleGetByIdResponse>
  </soap12:Body>
</soap12:Envelope>