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 "Receive From Customer Service"
| Line 15: | Line 15: | ||
{{Web Service SkipAutoVerify Param Table}} | {{Web Service SkipAutoVerify Param Table}} | ||
| + | |||
| + | === 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 XML submitted must conform to the expected schema as outlined in the service metadata. | ||
| + | |||
| + | === 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). | ||
| + | |||
| + | === Usage === | ||
| + | |||
| + | Production Environment | ||
| + | |||
| + | * '''Web Service URL:''' <nowiki>https://www.trackabout.com/ReceiveFromCustomer.asmx</nowiki> | ||
| + | * '''Web Service URL with 'skip auto verify' override parameter:''' <nowiki>https://www.trackabout.com/ReceiveFromCustomer.asmx?skipAutoVerify=true</nowiki> | ||
| + | * '''Service WADL:''' <nowiki>https://www.trackabout.com/ws/ReceiveFromCustomer.asmx?meta</nowiki> | ||
| + | |||
| + | Test Environment | ||
| + | |||
| + | * '''Web Service URL:''' <nowiki>https://test.trackabout.com/ReceiveFromCustomer.asmx</nowiki> | ||
| + | * '''Web Service URL with 'skip auto verify' override parameter:''' <nowiki>https://test.trackabout.com/ReceiveFromCustomer.asmx?skipAutoVerify=true</nowiki> | ||
| + | * '''Service WADL:''' <nowiki>https://test.trackabout.com/ws/ReceiveFromCustomer.asmx?meta</nowiki> | ||
Revision as of 18:42, 23 February 2010
Overview
This service accepts a request to verify that a cylinder is currently with a customer. A response will be sent back containing an error code and error message if the validation fails.
You can also force a record to be created for the cylinder in TrackAbout by setting 'ContinueThroughErrors and Save' to true in the submitted 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 Metadata
TrackAbout creates Web Application Description Language (WADL) documents for all web services that make use of REST architecture. The WADL for a service is accessible via the web service's URL with the word 'meta' appended as a query string parameter. For example, to access the WADL for the simple 'Echo' web service, you would use the following URL: https://www.trackabout.com/ws/Echo.asmx?meta
You can also specify a particular version of a web service to retrieve metadata for by including the major, minor, and revision numbers of the desired version in the query string. For example, to get the WADL for version 2.0.0 of the 'Echo' service, the URL becomes: https://www.trackabout.com/ws/Echo.asmx?v2.0.0&meta
More information on WADL can be found at the following resources:
Service Parameters
The exact format and order of parameters can be retrieved from the service metadata. 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
Other Service Parameters
In addition to the standard service parameters, this service also accepts the following parameters:
| 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
- The XML submitted must conform to the expected schema as outlined in the service metadata.
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).
Usage
Production Environment
- Web Service URL: https://www.trackabout.com/ReceiveFromCustomer.asmx
- Web Service URL with 'skip auto verify' override parameter: https://www.trackabout.com/ReceiveFromCustomer.asmx?skipAutoVerify=true
- Service WADL: https://www.trackabout.com/ws/ReceiveFromCustomer.asmx?meta
Test Environment
- Web Service URL: https://test.trackabout.com/ReceiveFromCustomer.asmx
- Web Service URL with 'skip auto verify' override parameter: https://test.trackabout.com/ReceiveFromCustomer.asmx?skipAutoVerify=true
- Service WADL: https://test.trackabout.com/ws/ReceiveFromCustomer.asmx?meta