Customer Transaction History Service - Revision history

Lsilverman: formatting (by SublimeText.Mediawiker)

2023-01-13T19:49:57Z

formatting (by SublimeText.Mediawiker)

Jgreco: Initial proofread pass - docs

2021-11-29T18:33:52Z

Initial proofread pass - docs

Jgreco: Initial proofread pass - docs

2021-11-29T18:24:15Z

Initial proofread pass - docs

Tfusco at 18:04, 9 March 2010

2010-03-09T18:04:06Z

Lsilverman at 16:46, 24 February 2010

2010-02-24T16:46:00Z

Lsilverman at 16:37, 24 February 2010

2010-02-24T16:37:59Z

Lsilverman at 16:37, 24 February 2010

2010-02-24T16:37:37Z

Jtaber: /* Usage */

2010-02-19T23:33:26Z

Usage

Jtaber: /* Usage */

2010-02-13T04:24:16Z

Usage

Jtaber: moved Cylinder Transaction History Service to Customer Transaction History Service: Renaming this so it's more generic and not indicative of being tied to only gas cylinders.

2010-02-13T04:23:26Z

moved Cylinder Transaction History Service to Customer Transaction History Service: Renaming this so it's more generic and not indicative of being tied to only gas cylinders.

@@ Line 72: / Line 72: @@
 Production Environment
 * '''Web Service URL:''' <nowiki>https://www.trackabout.com/ws/CustomerTransactionReport.asmx</nowiki>
-* '''Service WADL:''' <nowiki>https://www.trackabout.com/ws/CustomerTransactionReport.asmx?meta</nowiki>
+* '''Service WADL:''' https://www.trackabout.com/ws/CustomerTransactionReport.asmx?meta
 Test Environment
 * '''Web Service URL:''' <nowiki>https://test.trackabout.com/ws/CustomerTransactionReport.asmx</nowiki>
-* '''Service WADL:''' <nowiki>https://test.trackabout.com/ws/CustomerTransactionReport.asmx?meta</nowiki>
+* '''Service WADL:''' https://test.trackabout.com/ws/CustomerTransactionReport.asmx?meta
 A note about date/time values: In order to accommodate customers in different locations, all date and time values stored in TrackAbout are stored as Coordinated Universal Time values (UTC). This means that we typically have to perform a time zone conversion of the provided date and time values to be consistent with how the data is stored. To make this easier, we only accept a few very specific date and time formats:

@@ Line 31: / Line 31: @@
 | End Date
 | endDate
-| Ending date of the date range should should be included in the report.
+| Ending date of the date range that should be included in the report.
 |-
 | Sort Column
@@ Line 78: / Line 78: @@
 * '''Service WADL:''' <nowiki>https://test.trackabout.com/ws/CustomerTransactionReport.asmx?meta</nowiki>
-A note about date/time values: in order to accommodate customers in different locations, all date and time values stored in TrackAbout are stored as Coordinated Universal Time values (UTC). This means that we typically have to perform a time zone conversion of the provided date and time values to be consistent with how the data is stored. To make this easier, we only accept a few very specific date and time formats:
+A note about date/time values: In order to accommodate customers in different locations, all date and time values stored in TrackAbout are stored as Coordinated Universal Time values (UTC). This means that we typically have to perform a time zone conversion of the provided date and time values to be consistent with how the data is stored. To make this easier, we only accept a few very specific date and time formats:
 * '''UTC Time - yyyy-MM-ddTHH:mm:ssZ'''
-** Example: 2009-03-04T08:23:12Z would be evaluated as March 4, 2009 at 8:23:12 AM. The 'Z' on the end denotes a 'zero' UTC offset, meaning the provided value has already been adjusted to UTC time. When a value like this is received by this web service no time zone conversion will be performed.
+** Example: 2009-03-04T08:23:12Z would be evaluated as March 4, 2009 at 8:23:12 AM. The 'Z' on the end denotes a 'zero' UTC offset, meaning the provided value has already been adjusted to UTC time. When a value like this is received by this web service no time zone conversion is performed.
 * '''Local Time with UTC Offset - yyyy-MM-ddTHH:mm:sszzz'''
 ** Example: 2009-05-02T13:34:45-05:00 would initially be evaluated as a local time of May 2, 2009 at 1:34:45 PM. The '-05:00' at the end of the string would signal that the provided time has a negative 5 hour offset from UTC time, meaning that 5 hours would be added to the provided local time in order to convert it to UTC.

@@ Line 78: / Line 78: @@
 * '''Service WADL:''' <nowiki>https://test.trackabout.com/ws/CustomerTransactionReport.asmx?meta</nowiki>
-A note about date/time values: in order to accommodate customers in different locations, all date and time values stored in TrackAbout are stored as Coordinated Universal Time values (UTC). This means that we typically have to perform a time zone conversion of the provided date and time values to be consistent with how the data is stored. To make this easier, we only accept a few very specific date and time formats as outlined below:
+A note about date/time values: in order to accommodate customers in different locations, all date and time values stored in TrackAbout are stored as Coordinated Universal Time values (UTC). This means that we typically have to perform a time zone conversion of the provided date and time values to be consistent with how the data is stored. To make this easier, we only accept a few very specific date and time formats:
 * '''UTC Time - yyyy-MM-ddTHH:mm:ssZ'''
@@ Line 85: / Line 85: @@
 ** Example: 2009-05-02T13:34:45-05:00 would initially be evaluated as a local time of May 2, 2009 at 1:34:45 PM. The '-05:00' at the end of the string would signal that the provided time has a negative 5 hour offset from UTC time, meaning that 5 hours would be added to the provided local time in order to convert it to UTC.
 * '''Local Time with no Offset - yyyy-MM-ddTHH:mm:ss'''
-** Example: 2009-11-10T09:45:00 would be evaluated as November 10, 2009 at 9:45:00 AM. Since the provided time wasn't denoted as UTC and no offset was provided, the web service will use the timezone at the location known as "headquarters" for your company to convert the provided time to UTC.
+** Example: 2009-11-10T09:45:00 would be evaluated as November 10, 2009 at 9:45:00 AM. Since the provided time wasn't denoted as UTC and no offset was provided, the web service will use the time zone at the location known as "headquarters" for your company when doing the time conversion.
-Below is a Full Example URL which contains the following parameters
+Below is a Full Example URL which contains the following parameters:
 *Customer ID = ABC123
 *Include Departments = false

← Older revision		Revision as of 18:04, 9 March 2010
Line 1:		Line 1:
		+	[[Web_Services\|<< Back to Web Services]]
		+
	=== Overview ===		=== Overview ===
	This web service allows you to generate a report outlining all assets that were delivered or returned within a given date range for a given customer. Deliveries and returns are matched up on the same line representing a round trip for the asset.		This web service allows you to generate a report outlining all assets that were delivered or returned within a given date range for a given customer. Deliveries and returns are matched up on the same line representing a round trip for the asset.

← Older revision		Revision as of 16:46, 24 February 2010
Line 5:		Line 5:

	{{Service Authentication RESTful}}		{{Service Authentication RESTful}}
−
−	~~{{Web Service Authentication}}~~

	=== Report Parameters ===		=== Report Parameters ===

← Older revision		Revision as of 16:37, 24 February 2010
Line 3:		Line 3:

	{{Service Protocol RESTful}}		{{Service Protocol RESTful}}
		+
		+	{{Service Authentication RESTful}}

	{{Web Service Authentication}}		{{Web Service Authentication}}

@@ Line 2: / Line 2: @@
 This web service allows you to generate a report outlining all assets that were delivered or returned within a given date range for a given customer. Deliveries and returns are matched up on the same line representing a round trip for the asset.
-{{Web Service Architecture}}
+{{Service Protocol RESTful}}
 {{Web Service Authentication}}

@@ Line 65: / Line 65: @@
 === Usage ===
 * '''Allowed HTTP Actions:''' GET
 * '''Input:''' All parameters are provided in the query string. When creating the query string, use the query string key values specified in the [[#Report Parameters]] section above for the corresponding parameter. ''Note: Be sure to properly URL Encode each parameter value. More information on URL Encoding: [http://en.wikipedia.org/wiki/Percent-encoding Wikipedia: URL Encoding]''
 A note about date/time values: in order to accommodate customers in different locations, all date and time values stored in TrackAbout are stored as Coordinated Universal Time values (UTC). This means that we typically have to perform a time zone conversion of the provided date and time values to be consistent with how the data is stored. To make this easier, we only accept a few very specific date and time formats as outlined below:

@@ Line 65: / Line 65: @@
 === Usage ===
-* '''Web Service URL:''' <nowiki>https://www.trackabout.com/ws/CylinderTransactionReport.asmx</nowiki>
+* '''Web Service URL:''' <nowiki>https://www.trackabout.com/ws/CustomerTransactionReport.asmx</nowiki>
 * '''Allowed HTTP Actions:''' GET
 * '''Input:''' All parameters are provided in the query string. When creating the query string, use the query string key values specified in the [[#Report Parameters]] section above for the corresponding parameter. ''Note: Be sure to properly URL Encode each parameter value. More information on URL Encoding: [http://en.wikipedia.org/wiki/Percent-encoding Wikipedia: URL Encoding]''
@@ Line 88: / Line 88: @@
 Full Example URL:
-<nowiki>https://www.trackabout.com/ws/CylinderTransactionReport.asmx?custId=ABC123&startDate=2009-01-01T00%3a00%3a00Z&endDate=2009-12-31T00%3a00%3a00Z&inclDept=False&sortCol=1</nowiki>
+<nowiki>https://www.trackabout.com/ws/CustomerTransactionReport.asmx?custId=ABC123&startDate=2009-01-01T00%3a00%3a00Z&endDate=2009-12-31T00%3a00%3a00Z&inclDept=False&sortCol=1</nowiki>
 * '''Output:''' The resulting report data will be rendered into a PDF file and be returned as binary data in the HTTP response. A 'Content-Disposition' HTTP header will be added with the value 'attachment; filename=<generatedFileName>' where <generatedFileName> will be a unique file name with a sequence number generated from the current system time appended to it.