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 "Cylinder Validation Service"
| Line 10: | Line 10: | ||
=== Service Parameters === | === Service Parameters === | ||
| − | The exact format and order of parameters can be retrieved from the service metadata by calling the service with ?meta at the end of the URL. See the usage section below for the full URL. | + | The exact format and order of parameters can be retrieved from the service metadata by calling the service with ?meta at the end of the URL. See the usage section below for the full URL. |
| + | There are a number of standard web service parameters that most TrackAbout web services accept that are outlined in the metadata that are not included in the table below. | ||
{| class="wikitable" border="1" cellpadding="5" | {| class="wikitable" border="1" cellpadding="5" | ||
Revision as of 18:21, 23 February 2010
Overview
This service accepts a cylinder validation request to verify that a cylinder within the specified barcode is the specified location. A response will be sent back containing an error code and error message if the validation fails.
You can also force the cylinder's location to be updated in TrackAbout by setting the 'ContinueThroughErrorsAndSave' to true in the submitted cylinder validation request.
Service Protocol
TrackAbout has chosen to implement and architect this web service using what is typically referred to as REST style architecture. This is a resource oriented architecture that uses standard HTTP actions (i.e. GET, POST, DELETE, etc...) to manipulate resources exposed as URLs. Standard HTTP Status Codes are used for success and error codes.
More information on REST architecture can be found at the following resources:
Template:Web Service Authentication
Service Parameters
The exact format and order of parameters can be retrieved from the service metadata by calling the service with ?meta at the end of the URL. See the usage section below for the full URL. There are a number of standard web service parameters that most TrackAbout web services accept that are outlined in the metadata that are not included in the table below.
| Friendly Name | Query String Name | Description |
|---|---|---|
| Skip Auto Verify | skipAutoVerify | 'True' or 'False' value indicating whether or not the service should automatically verify any accounting adjustment records that may have been created in the process of performing the cylinder validation. This is an optional parameter and will default to 'false' if not provided. This means that, by default, any request to this service will automatically verify account adjustment records that get created. |
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
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).