Post Cylinder Fill Data - Revision history

Lsilverman: fix urls (by SublimeText.Mediawiker)

2023-01-13T19:46:13Z

fix urls (by SublimeText.Mediawiker)

Lsilverman: /* Usage */

2013-10-04T21:13:29Z

Usage

Jtaber at 15:57, 14 June 2013

2013-06-14T15:57:25Z

Jtaber: Adding some additional validations

2013-06-14T14:37:06Z

Adding some additional validations

Starafdar at 19:29, 11 January 2013

2013-01-11T19:29:57Z

Starafdar: Created page with "<< Back to Web Services === Overview === This service creates Fill Records for the assets specified in the input document. {{Service Protocol RESTful}} {{..."

2013-01-11T19:07:11Z

Created page with "<< Back to Web Services === Overview === This service creates Fill Records for the assets specified in the input document. {{Service Protocol RESTful}} {{..."

New page

[[Web_Services|<< Back to Web Services]]

=== Overview ===
This service creates Fill Records for the assets specified in the input document.

{{Service Protocol RESTful}}

{{Service Authentication RESTful}}

{{Service Metadata RESTful}}

{{Service Standard Params RESTful}}

=== Validations and Restrictions ===

The following validations are applicable to the data and parameters provided to this service. 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 XML submitted must conform to the expected schema as outlined in the service metadata.

=== Processing Rules ===
The web service uses the standard asset resolution process when trying to locate assets for a provided bar code and serial number. These are the same rules that are applied when an asset is scanned via a hand held device or a record is created by entering bar codes and serial numbers manually through the website. The details of the standard asset resolution process are outside the scope of this article, but it's important to note that this approach can lead to three potential outcomes:

* A single asset is found, and that asset is attached to the 'Fill' record that is created by the web service.
* No matching asset is found, and the creation of the 'Fill' record results in a new asset being created using the provided bar code and serial number.
* One or more partially matching assets are found and the 'Fill' record is created with an asset collision. This collision will need to be resolved manually via the website.

=== Request Output ===

The service will return a standard web service response, and include information on the status of the request. The information in the response will also include an indication of the service version and the status of the request (error codes and messages). When all provided data is processed without any errors, the service returns an HTTP status code of 200. When one or more processing errors are encountered the web service will return those error messages. The format of the error output differs between the different versions of the service. See the WADL for the target version for details.

This service uses the following error codes to denote processing issues that were encountered during the web service request. The 'Category' column in the table below refers to the four categories that errors from this web service fall under:

* '''General''' - These are errors that are not directly attributable to any specific element of the data that was provided in the web service request. For example, an issue with validating the provided XML against the proper schema would fall under this category.
* '''Order Fill''' - These are errors that originate due to an issue with the top-level order fill data element. Unless otherwise noted, these errors will result in the entire 'Order Fill' not being processed.
* '''Asset Line''' - These are errors that originate due to an issue with one of the provided asset line data elements. Unless otherwise noted, these errors will result in all 'Filled Asset' elements beneath this Asset Line to not be processed.
* '''Filled Asset''' - These are errors that originate due to an issue with one of the provided filled asset data elements. Unless otherwise noted, these errors will result in that filled asset element not being processed.

{| class="wikitable" border="1" cellpadding="5"
|-
! Error Code
! Error Category
! Error Description
! Applies to Version(s)
! Notes
|-
| 1
| General
| Unexpected Error
| All
| This error is used when an expected error caused and issue with the processing. This can be related to a technical (e.g. network or database) issue.
|-
| 2
| Order Fill
| Unknown Location
| All
| This error indicates that the 'Location Id' value in one of the provided Order Fill elements did not match any location in the database.
|-
| 3
| Order Fill
| Unknown Customer
| All
| This error indicates that the 'Customer Number' value in one of the provided Order Fill elements did not match any customers in the database.
|-
| 4
| Asset Line
| Unknown Product Code
| All
| This error indicates that one of the 'Product Code' values in one of the provided Asset Line elements was not found in the database, and that the web service was unable to create that product code on the fly. '''Note that while this error stems from the Asset Line element, any single instance of this error will result in the entire parent Order Fill element not being processed.'''
|-
| 5
| Order Fill
| Invalid Lot Number
| All
| This error indicates that one of the 'Lot Number' values provided failed the lot number validation logic that is configured for your database. Depending on the version of the web service being used, the 'lot number' field can be sent in either the 'Asset Line' or 'Filled Asset' element. '''Note that while this error stems from the Filled Asset or Asset Line elements, any single instance of this error will result in the entire parent Order Fill element not being processed.'''
|-
| 6
| Order Fill
| Missing Order
| All
| This error indicates that the provided 'Order Number' did not match any existing order in the database. '''Note that this error does not halt processing on the Order Fill in which it occurs.''' Due to timing issues it's possible that this web service request can come in prior to the actual order data, so the web service will continue processing this data even if the order does not year appear in the database.
|-
| 7
| Filled Asset
| Missing Asset
| All
| This error indicates that the web service was unable to locate a single asset in the database matching the provided bar code and serial number.
|-
| 8
| Filled Asset
| Duplicate Assets
| All
| This error indicates that multiple assets were found using the provided bar code and serial number or that the web service was unable to find a single asset that appeared to be a perfect match for the provided bar code and serial number.
|-
| 9
| Order Fill
| Fill Date Conflict
| All
| This error indicates that there is already a record in the database for one of the provided assets with the exact same date and time as the provided 'Fill Date'.
|-
| 10
| Order Fill
| Fill Date Too Far In Past
| All
| This error indicates that the provided 'Fill Date' is too far in the past.
|-
| 11
| Order Fill
| Fill Date Too Far In Future
| All
| This error indicates that the provided 'Fill Date' is too far in the future.
|-
| 12
| Filled Asset
| Asset Matched On Old Bar Code
| 3
| This error indicates that the provided bar code and serial number were successfully matched to a single asset, but that the web service had to look at previously used bar codes in order to make that match. '''Note that this error does not halt processing and that the fill record will continue to be created using the found asset.'''
|-
| 13
| Filled Asset
| Missing Bar Code and Serial Number
| 3
| This error indicates that the filled asset element was missing both a bar code and serial number. At least one of these values must be provided for each filled asset element.
|}

=== Usage ===

Production Environment

* '''Web Service URL:''' <nowiki>https://www.trackabout.com/Fills.asmx</nowiki>
* '''Service WADL:''' <nowiki>https://www.trackabout.com/ws/Fills.asmx?meta</nowiki>

Test Environment

* '''Web Service URL:''' <nowiki>https://test.trackabout.com/Fills.asmx</nowiki>
* '''Service WADL:''' <nowiki>https://test.trackabout.com/ws/Fills.asmx?meta</nowiki>

@@ Line 34: / Line 34: @@
 Production Environment
-* '''Web Service URL:''' https://www.trackabout.com/Fills.asmx
+* '''Web Service URL:''' https://www.trackabout.com/ws/Fills.asmx
 * '''Service WADL:''' https://www.trackabout.com/ws/Fills.asmx?meta
 Test Environment
-* '''Web Service URL:''' https://test.trackabout.com/Fills.asmx
+* '''Web Service URL:''' https://test.trackabout.com/ws/Fills.asmx
 * '''Service WADL:''' https://test.trackabout.com/ws/Fills.asmx?meta

@@ Line 18: / Line 18: @@
 * The username and password provided must be valid
 * The XML submitted must conform to the expected schema as outlined in the service metadata.
 === Processing Rules ===

@@ Line 28: / Line 28: @@
 === Request Output ===
-The service will return a standard web service response, and include information on the status of the request. The information in the response will also include an indication of the service version and the status of the request (error codes and messages). When all provided data is processed without any errors, the service returns an HTTP status code of 200. When one or more processing errors are encountered the web service will return those error messages. The format of the error output differs between the different versions of the service. See the WADL for the target version for details.
+When all provided data is processed without any errors, the service returns a HTTP status code of 200. When one or more processing errors are encountered, the HTTP status will be set to an HTTP error code. The body of the response will contain text describing the error that occurred.
 === Usage ===