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"
| Line 42: | Line 42: | ||
=== Usage === | === Usage === | ||
| + | |||
| + | Production Environment | ||
* '''Web Service URL:''' <nowiki>https://www.trackabout.com:8002/GetAssetsForDeliveries</nowiki> | * '''Web Service URL:''' <nowiki>https://www.trackabout.com:8002/GetAssetsForDeliveries</nowiki> | ||
* '''Service WSDL:''' <nowiki>https://www.trackabout.com:8002/GetAssetsForDeliveries?WSDL</nowiki> | * '''Service WSDL:''' <nowiki>https://www.trackabout.com:8002/GetAssetsForDeliveries?WSDL</nowiki> | ||
| + | |||
| + | Test Environment | ||
| + | |||
| + | * '''Web Service URL:''' <nowiki>https://test.trackabout.com:8002/GetAssetsForDeliveries</nowiki> | ||
| + | * '''Service WSDL:''' <nowiki>https://test.trackabout.com:8002/GetAssetsForDeliveries?WSDL</nowiki> | ||
Revision as of 13:32, 18 February 2010
This service allows you to receive a list of all assets that are filled and ready for delivery, for a given location.
Web Service Authentication
The web service request includes a RequestHeader section, where a username and password must be provided. We strongly recommend that all web service requests be made over SSL (HTTPS).
TrackAbout will provide you with a dedicated user account to use when making web service requests.
Service Parameters
The exact format and order of parameters can be retrieved from the service metadata by calling the service with ?WSDL at the end of the URL. See the usage section below, for the full URL.
| 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 |
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
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).
Usage
Production Environment
- Web Service URL: https://www.trackabout.com:8002/GetAssetsForDeliveries
- Service WSDL: https://www.trackabout.com:8002/GetAssetsForDeliveries?WSDL
Test Environment
- Web Service URL: https://test.trackabout.com:8002/GetAssetsForDeliveries
- Service WSDL: https://test.trackabout.com:8002/GetAssetsForDeliveries?WSDL