Cylinder Validation Service - Revision history

Lsilverman: formatting (by SublimeText.Mediawiker)

2023-01-13T20:01:19Z

formatting (by SublimeText.Mediawiker)

Jgreco: Initial proofread pass - docs

2021-11-29T18:40:06Z

Initial proofread pass - docs

Jtaber: /* Processing Rules */

2010-08-25T01:50:17Z

Processing Rules

Jtaber at 01:44, 25 August 2010

2010-08-25T01:44:00Z

Jtaber at 01:41, 25 August 2010

2010-08-25T01:41:27Z

Tfusco: /* Overview */

2010-08-20T19:49:10Z

Overview

Jross: /* Request Output */

2010-05-25T18:38:51Z

Request Output

Jross: /* Request Output */

2010-05-25T18:37:18Z

Request Output

Jtaber at 14:21, 2 April 2010

2010-04-02T14:21:39Z

Tfusco at 18:05, 9 March 2010

2010-03-09T18:05:13Z

@@ Line 58: / Line 58: @@
 Production Environment
-* '''Web Service URL:''' <nowiki>https://www.trackabout.com/CylinderValidation.asmx</nowiki>
+* '''Web Service URL:''' <nowiki>https://www.trackabout.com/ws/CylinderValidation.asmx</nowiki>
-* '''Web Service URL with 'skip auto verify' override parameter:''' <nowiki>https://www.trackabout.com/CylinderValidation.asmx?skipAutoVerify=true</nowiki>
+* '''Web Service URL with 'skip auto verify' override parameter:''' <nowiki>https://www.trackabout.com/ws/CylinderValidation.asmx?skipAutoVerify=true</nowiki>
-* '''Service WADL:''' <nowiki>https://www.trackabout.com/ws/CylinderValidation.asmx?meta</nowiki>
+* '''Service WADL:''' https://www.trackabout.com/ws/CylinderValidation.asmx?meta
 Test Environment
-* '''Web Service URL:''' <nowiki>https://test.trackabout.com/CylinderValidation.asmx</nowiki>
+* '''Web Service URL:''' <nowiki>https://test.trackabout.com/ws/CylinderValidation.asmx</nowiki>
-* '''Web Service URL with 'skip auto verify' override parameter:''' <nowiki>https://test.trackabout.com/CylinderValidation.asmx?skipAutoVerify=true</nowiki>
+* '''Web Service URL with 'skip auto verify' override parameter:''' <nowiki>https://test.trackabout.com/ws/CylinderValidation.asmx?skipAutoVerify=true</nowiki>
-* '''Service WADL:''' <nowiki>https://test.trackabout.com/ws/CylinderValidation.asmx?meta</nowiki>
+* '''Service WADL:''' https://test.trackabout.com/ws/CylinderValidation.asmx?meta

@@ Line 9: / Line 9: @@
 ** If the '''Barcode''' input is missing, a '''MISSING_BARCODE''' error code will be returned.
 ** If the '''LocationCode''' input is missing, a '''MISSING_LOCATION''' error code will be returned.
-** If the '''UserCode''' input is missing, a '''MISSING_USER''' error code will be returned
+** If the '''UserCode''' input is missing, a '''MISSING_USER''' error code will be returned.
-** If the '''ValidationDateTime''' input is missing, a '''MISSING_VALIDATIONDATETIME''' error code will be returned
+** If the '''ValidationDateTime''' input is missing, a '''MISSING_VALIDATIONDATETIME''' error code will be returned.
 * The input is then validated to ensure that all provided fields reference valid entities within the database:
@@ Line 38: / Line 38: @@
 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 XML submitted must conform to the expected schema as outlined in the service metadata.
@@ Line 47: / Line 47: @@
 <syntaxhighlight lang="xml">
 <ServiceResponse>
-  <Barcode>1234</Barcode>
+ <Barcode>1234</Barcode>
-  <SerialNumber>5678</SerialNumber>
+ <SerialNumber>5678</SerialNumber>
-  <WirelessAlert>Alert 1</Wireless_Alert>
+ <WirelessAlert>Alert 1</Wireless_Alert>
-  <ErrorMessage>Not at location</ErrorMessage>
+ <ErrorMessage>Not at location</ErrorMessage>
 </ServiceResponse>
 </syntaxhighlight>

@@ Line 7: / Line 7: @@
 * The provided input is validated to ensure that all required fields are present:
-** If the '''Barcode''' input is missing a '''MISSING_BARCODE''' error code will be returned.
+** If the '''Barcode''' input is missing, a '''MISSING_BARCODE''' error code will be returned.
-** If the '''LocationCode''' input is missing a '''MISSING_LOCATION''' error code will be returned.
+** If the '''LocationCode''' input is missing, a '''MISSING_LOCATION''' error code will be returned.
-** If the '''UserCode''' input is missing a '''MISSING_USER''' error code will be returned
+** If the '''UserCode''' input is missing, a '''MISSING_USER''' error code will be returned
-** If the '''ValidationDateTime''' input is missing a '''MISSING_VALIDATIONDATETIME''' error code will be returned
+** If the '''ValidationDateTime''' input is missing, a '''MISSING_VALIDATIONDATETIME''' error code will be returned
 * The input is then validated to ensure that all provided fields reference valid entities within the database:
-** If the provided '''UserCode''' value does not match an existing user's Accounting User Code a '''UNKNOWN_USER''' error code will be returned.
+** If the provided '''UserCode''' value does not match an existing user's Accounting User Code, a '''UNKNOWN_USER''' error code will be returned.
-** If the provided '''LocationCode''' value does not match an existing internal location an '''UNKNOWN_LOCATION''' error code will be returned.
+** If the provided '''LocationCode''' value does not match an existing internal location, an '''UNKNOWN_LOCATION''' error code will be returned.
-** If the provided '''Barcode''' value does not match any existing assets an '''UNKNOWN_BARCODE''' error code will be returned.
+** If the provided '''Barcode''' value does not match any existing assets, an '''UNKNOWN_BARCODE''' error code will be returned.
-** If the provided '''Barcode''' value matches more than one existing asset a '''DUPLICATE_CYLINDERS''' error code will be returned.
+** If the provided '''Barcode''' value matches more than one existing asset, a '''DUPLICATE_CYLINDERS''' error code will be returned.
 * If any of the above input validation rules fail, processing is stopped and the corresponding error code is returned.

@@ Line 7: / Line 7: @@
 * The provided input is validated to ensure that all required fields are present:
-** If the ''Barcode'' input is missing a ''MISSING_BARCODE'' error code will be returned.
+** If the '''Barcode''' input is missing a '''MISSING_BARCODE''' error code will be returned.
-** If the ''LocationCode'' input is missing a ''MISSING_LOCATION'' error code will be returned.
+** If the '''LocationCode''' input is missing a '''MISSING_LOCATION''' error code will be returned.
-** If the ''UserCode'' input is missing a ''MISSING_USER'' error code will be returned
+** If the '''UserCode''' input is missing a '''MISSING_USER''' error code will be returned
-** If the ''ValidationDateTime'' input is missing a ''MISSING_VALIDATIONDATETIME'' error code will be returned
+** If the '''ValidationDateTime''' input is missing a '''MISSING_VALIDATIONDATETIME''' error code will be returned
 * The input is then validated to ensure that all provided fields reference valid entities within the database:
-** If the provided ''UserCode'' value does not match an existing user's Accounting User Code a ''UNKNOWN_USER'' error code will be returned.
+** If the provided '''UserCode''' value does not match an existing user's Accounting User Code a '''UNKNOWN_USER''' error code will be returned.
-** If the provided ''LocationCode'' value does not match an existing internal location an ''UNKNOWN_LOCATION'' error code will be returned.
+** If the provided '''LocationCode''' value does not match an existing internal location an '''UNKNOWN_LOCATION''' error code will be returned.
-** If the provided ''Barcode'' value does not match any existing assets an ''UNKNOWN_BARCODE'' error code will be returned.
+** If the provided '''Barcode''' value does not match any existing assets an '''UNKNOWN_BARCODE''' error code will be returned.
-** If the provided ''Barcode'' value matches more than one existing asset a ''DUPLICATE_CYLINDERS'' error code will be returned.
+** If the provided '''Barcode''' value matches more than one existing asset a '''DUPLICATE_CYLINDERS''' error code will be returned.
 * If any of the above input validation rules fail, processing is stopped and the corresponding error code is returned.
-* If the asset is currently at the provided location '''or''' if the provided input's ''ContinueThroughErrorsAndSave'' is set to ''True'', a ''Location Validation'' record is created for the asset. This record will be tagged as having been entered by the user matching the provided ''UserCode'' at the date and time specified in the provided ''ValidationDateTime''. This record will move the asset to the provided internal location if it's not already there.
+* If the asset is currently at the provided location ''or'' if the provided input's '''ContinueThroughErrorsAndSave''' is set to '''True''', a '''Location Validation''' record is created for the asset. This record will be tagged as having been entered by the user matching the provided '''UserCode''' at the date and time specified in the provided '''ValidationDateTime'''. This record will move the asset to the provided internal location if it's not already there.
-* If the asset is not currently at the provided location '''and''' the provided input's ''ContinueThroughErrorsAndSave'' is set to ''False'', an error code indicating whether it is currently at a customer (''At Customer'') or a different internal location (''AT_DIFFERENT_LOCATION'') will be returned.
+* If the asset is not currently at the provided location ''and'' the provided input's '''ContinueThroughErrorsAndSave''' is set to '''False''', an error code indicating whether it is currently at a customer ('''AT_CUSTOMER''') or a different internal location ('''AT_DIFFERENT_LOCATION''') will be returned.
 {{Service Protocol RESTful}}

@@ Line 4: / Line 4: @@
 The purpose of this service is to verify that a cylinder with the specified tag is currently in the specified location. This is commonly used when pulling an asset out of storage to make sure it is all set before it goes through steps to get it ready for use and sending it to a customer.
-A response will be sent back containing an error code and error message if the check fails.
+==== Processing Rules ====
-You can also force the cylinder's location to be changed in TrackAbout by setting the 'ContinueThroughErrorsAndSave' to 'true' in the submitted cylinder validation request. If this is set to true, a new 'Location Validation' record will be created in the system and the cylinder's location will be changed to the provided location if needed. If this value is set to false, no records are created as a result of the request.
+* The provided input is validated to ensure that all required fields are present:
 {{Service Protocol RESTful}}

@@ Line 2: / Line 2: @@
 === Overview ===
-The purpose of this service is to verify that a cylinder with the specified tag is currently in the specified location. A response will be sent back containing an error code and error message if the check fails.
+The purpose of this service is to verify that a cylinder with the specified tag is currently in the specified location. This is commonly used when pulling an asset out of storage to make sure it is all set before it goes through steps to get it ready for use and sending it to a customer.
 You can also force the cylinder's location to be changed in TrackAbout by setting the 'ContinueThroughErrorsAndSave' to 'true' in the submitted cylinder validation request. If this is set to true, a new 'Location Validation' record will be created in the system and the cylinder's location will be changed to the provided location if needed. If this value is set to false, no records are created as a result of the request.

@@ Line 25: / Line 25: @@
 === Request Output ===
-The service will return a standard web service response, and include information on the status of the request. An HTTP status code of '200' indicates that the request was successful. When successful, the service will return an XML document with information about teh asset in teh body of the HTTP response in the following format:
+The service will return a standard web service response, and include information on the status of the request. An HTTP status code of '200' indicates that the request was successful. When successful, the service will return an XML document with information about the asset in the body of the HTTP response in the following format:
 <syntaxhighlight lang="xml">

@@ Line 25: / Line 25: @@
 === 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).
+The service will return a standard web service response, and include information on the status of the request. An HTTP status code of '200' indicates that the request was successful. When successful, the service will return the serial number of the cylinder as plain text as the body of the HTTP response in the following format: "Serial Number: ABC123" where 'ABC123' is the serial number value.
 === Usage ===

← Older revision		Revision as of 18:05, 9 March 2010
Line 1:		Line 1:
		+	[[Web_Services\|<< Back to Web Services]]
		+
	=== Overview ===		=== Overview ===
	The purpose of this service is to verify that a cylinder with the specified tag is currently in the specified location. A response will be sent back containing an error code and error message if the check fails.		The purpose of this service is to verify that a cylinder with the specified tag is currently in the specified location. A response will be sent back containing an error code and error message if the check fails.