Difference between revisions of "Get Deliverable Assets Service"

Latest revision as of 15:52, 13 January 2023

Overview

This service allows you to receive a list of all assets that are filled and ready for delivery, for a given location.

Service Protocol: SOAP/WSDL Web Service

This is a SOAP/WSDL Web Service (see http://en.wikipedia.org/wiki/Web_service)

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/GetDeliverableAssets
Service WSDL: https://www.trackabout.com/GetDeliverableAssets?wsdl

Test Environment

Web Service URL: https://test.trackabout.com/GetDeliverableAssets
Service WSDL: https://test.trackabout.com/GetDeliverableAssets?wsdl

@@ Line 1: / Line 1: @@
+[[Web_Services|<< Back to Web Services]]
 === Overview ===
-This web service allows you to receive a list of all assets that are currently filled, for a given location.
-{{Web Service Authentication}}
+This service allows you to receive a list of all assets that are filled and ready for delivery, for a given location.
+{{Service Protocol Web Service}}
+{{Service Authentication Web Service}}
 === 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:
+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.
 {| class="wikitable" border="1" cellpadding="5"
@@ Line 28: / Line 30: @@
 | 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.
 |}
@@ Line 37: / Line 35: @@
 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 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 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).
+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 ===
+=== Usage ===
-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.
+Production Environment
-{| class="wikitable" border="1" cellpadding="5"
+* '''Web Service URL:''' <nowiki>https://www.trackabout.com/GetDeliverableAssets</nowiki>
-|-
+* '''Service WSDL:''' https://www.trackabout.com/GetDeliverableAssets?wsdl
-! Version
-! Request Schema File
+Test Environment
-! Response Schema File
-|-
+* '''Web Service URL:''' <nowiki>https://test.trackabout.com/GetDeliverableAssets</nowiki>
-| Version 1
+* '''Service WSDL:''' https://test.trackabout.com/GetDeliverableAssets?wsdl
-| link to file here
-| link to file here
-|}