Please visit our new TrackAbout Knowledge Base at https://supportkb.trackabout.com for the most-up-to-date documentation on TrackAbout and TrackAbout Mobile.
Difference between revisions of "Get Deliverable Assets Service"
(Created page with '=== Overview === This web service allows you to receive a list of all assets that are currently filled, for a given location. {{Web Service Authentication}} === Service Paramet…') |
|||
| Line 1: | Line 1: | ||
| − | + | This service allows you to receive a list of all assets that are filled and ready for delivery, for a given location. | |
| − | This | ||
{{Web Service Authentication}} | {{Web Service Authentication}} | ||
Revision as of 14:45, 12 February 2010
This service allows you to receive a list of all assets that are filled and ready for delivery, for a given location.
Template:Web Service Authentication
Service Parameters
In order to support versioning of this service, the parameters for the service are provided via an xml document. This allows the service to receive requests with different parameters and values, and handle each request with the appropriate version of the service.
Version 1
The parameters for Version 1 of the service are as follows:
| Friendly Name | Parameter Name | Description |
|---|---|---|
| Asset Location | LocationId | The ID of the location that contains the assets being delivered |
| User Name | UserName | The username to log into the system |
| Password | Password | The password to authenticate the user name for the request |
| Server Version Number | Version | Used to determine which version of the service to execute. Must be "1" for Version 1 of the service. |
Validations and Restrictions
The following validations are applicable to the parameters provided to this request. If one or more of these validations fail, the web service will return a response status code and error message that indicates the source of the failure.
- The username and password provided must be valid
- The location must be valid and must contain assets that are filled and ready for delivery.
- The location must be accessible by the username provided
- The version number must be a valid service version
Request Output
The resulting data will be an xml document containing all of the assets that match the request. The information in the xml response will also include an indication of the service version and the status of the request (error codes and messages).
Service Version Schema Files
The following XML schema files (.xsd) are used to validate the incoming requests for the specified version of the service. Failure to validate against the schema for the specified version will result in the service aborting and returning an error status and message, stating the reason for the validation failure.
| Version | Request Schema File | Response Schema File |
|---|---|---|
| Version 1 | link to file here | link to file here |