Request Extract

Last updated
Save as PDF

requestExtract

The requestExtract web service requests an extract for one to many vehicles. The extract type must be specified.

ExtractFailureVehicle[] requestExtract(AssetIdentifier[] vehicles, String extractType) throws WSException

vehicles: An AssetIdentifier array that uniquely identifies the vehicle(s) for which an extract is requested. No more than 1000 vehicles may be specified.
extractType: The type of extract requested for each vehicle specified. Possible values are:
   F  Request a full extract for every vehicle specified. Always includes reset.
   S  Request a summary extract for every vehicle specified. Never includes reset.
   V  Use the vehicle's default setting to determine the type of extract for each vehicle

Returns null on exceptions; otherwise returns an ExtractFailureVehicle array.

Authorization Requirements

The credentials supplied with this method call (as specified in the accompanying WS-Security header) must be authorized to the following application(s) and their associated role-based permissions.

Required Application Licenses
- Remote Integration

Required User Permissions
- Can use Performance Monitoring

Customer integrators are authorized to their own company's data only.

Sample requestExtract Request

Only the SOAP body is shown. To see a sample SOAP Envelope and Header, click here.

<soap:Body>

<requestExtract>

<vehicles>

<AssetIdentifier>

<id>FIRSTVEH</id>

<scac></scac>

</AssetIdentifier>

<AssetIdentifier>

<id>SECONDVEH</id>

<scac />

</AssetIdentifier>

<AssetIdentifier>

<id>THIRDVEH</id>

<scac/>

</AssetIdentifier>

</vehicles>

<extractType>F</extractType>

</requestExtract>

</soapenv:Body>

Sample requestExtract Response

An empty response conveys success.

<soapenv:Body>

<requestExtractResponse/>

</soapenv:Body>

If one or more extracts could not be requested, a list of extract failure vehicles will be returned.

<soap:Body>

<requestExtractResponse>

<requestExtractReturn>

<ExtractFailureVehicle>

<asset>

<id>FIRSTVEH</id>

<scac></scac>

</asset>

<failureCode>03</failureCode>

<type/>

</ExtractFailureVehicle>

<ExtractFailureVehicle>

<asset>

<id>SECONDVEH</id>

<scac></scac>

</asset>

<failureCode>03</failureCode>

<type/>

</ExtractFailureVehicle>

</requestExtractReturn>

</requestExtractResponse>

</soap:Body>

Exceptions

001 Unknown Error.
002 Required field not specified.
003 Company not authorized for integration.
004 User not authorized.
005 Invalid number of vehicles specified.
006 Invalid vehicle format specified.
007 Extract type invalid.
008 Invalid source of request value specified.