ToolChest Web Service

ToolChest

Click here for a complete list of operations.

ServiceVehicleGet

Returns all service vehicles, filtered by the specified criteria.

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/ServiceVehicleGet"

<?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>
    <ServiceVehicleGet xmlns="http://bartecautoid.com/">
      <authenticatedUser>
        <Oid>guid</Oid>
        <Username>string</Username>
        <UserRegion>US or Europe</UserRegion>
        <UtcOffset>short</UtcOffset>
        <PhoneNumber>string</PhoneNumber>
      </authenticatedUser>
      <filterParams>
        <Make>string</Make>
        <Model>string</Model>
        <Year>int</Year>
        <ServiceDateFrom>dateTime</ServiceDateFrom>
        <ServiceDateTo>dateTime</ServiceDateTo>
        <TransferredDateFrom>dateTime</TransferredDateFrom>
        <TransferredDateTo>dateTime</TransferredDateTo>
      </filterParams>
    </ServiceVehicleGet>
  </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>
    <ServiceVehicleGetResponse xmlns="http://bartecautoid.com/">
      <ServiceVehicleGetResult>
        <Success>boolean</Success>
        <ErrorMessage>string</ErrorMessage>
        <Data>
          <ServiceVehicle>
            <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 xsi:nil="true" />
            <ObdServices xsi:nil="true" />
            <TreadServices xsi:nil="true" />
          </ServiceVehicle>
          <ServiceVehicle>
            <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 xsi:nil="true" />
            <ObdServices xsi:nil="true" />
            <TreadServices xsi:nil="true" />
          </ServiceVehicle>
        </Data>
      </ServiceVehicleGetResult>
    </ServiceVehicleGetResponse>
  </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>
    <ServiceVehicleGet xmlns="http://bartecautoid.com/">
      <authenticatedUser>
        <Oid>guid</Oid>
        <Username>string</Username>
        <UserRegion>US or Europe</UserRegion>
        <UtcOffset>short</UtcOffset>
        <PhoneNumber>string</PhoneNumber>
      </authenticatedUser>
      <filterParams>
        <Make>string</Make>
        <Model>string</Model>
        <Year>int</Year>
        <ServiceDateFrom>dateTime</ServiceDateFrom>
        <ServiceDateTo>dateTime</ServiceDateTo>
        <TransferredDateFrom>dateTime</TransferredDateFrom>
        <TransferredDateTo>dateTime</TransferredDateTo>
      </filterParams>
    </ServiceVehicleGet>
  </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>
    <ServiceVehicleGetResponse xmlns="http://bartecautoid.com/">
      <ServiceVehicleGetResult>
        <Success>boolean</Success>
        <ErrorMessage>string</ErrorMessage>
        <Data>
          <ServiceVehicle>
            <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 xsi:nil="true" />
            <ObdServices xsi:nil="true" />
            <TreadServices xsi:nil="true" />
          </ServiceVehicle>
          <ServiceVehicle>
            <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 xsi:nil="true" />
            <ObdServices xsi:nil="true" />
            <TreadServices xsi:nil="true" />
          </ServiceVehicle>
        </Data>
      </ServiceVehicleGetResult>
    </ServiceVehicleGetResponse>
  </soap12:Body>
</soap12:Envelope>