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 "Create Delivery Records Service"
Lsilverman (talk | contribs) |
Lsilverman (talk | contribs) (formatting (by SublimeText.Mediawiker)) |
||
| (9 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| + | [[Web_Services|<< Back to Web Services]] | ||
| + | |||
=== Overview === | === Overview === | ||
| − | This service allows you to create delivery records in TrackAbout based on actual data collected in the field during deliveries. | + | This service allows you to create delivery records in TrackAbout based on actual data collected in the field during deliveries. This service is useful if you are collecting and wish to post delivery data outside of TrackAbout's TAMobile device software. |
| − | |||
| − | |||
| − | + | {{Service Protocol Web Service}} | |
| − | + | {{Service Authentication Web Service}} | |
=== Service Parameters === | === Service Parameters === | ||
| − | The exact format and order of parameters can be retrieved from the service metadata by calling the service with ? | + | The exact format and order of parameters can be retrieved from the service metadata by calling the service with ?wsdl at the end of the URL. See the usage section below for the full URL. |
{| class="wikitable" border="1" cellpadding="5" | {| class="wikitable" border="1" cellpadding="5" | ||
| Line 67: | Line 67: | ||
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 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 Truck and Location must be accessible by the specified user | + | * The Truck and Location must be accessible by the specified user. |
| − | * If the Customer information is not found, a new Customer will be created and associated with the record(s) being created | + | * If the Customer information is not found, a new Customer will be created and associated with the record(s) being created. |
=== Request Output === | === Request Output === | ||
| Line 79: | Line 79: | ||
Production Environment | Production Environment | ||
| − | * '''Web Service URL:''' <nowiki>https://www.trackabout.com | + | * '''Web Service URL:''' <nowiki>https://www.trackabout.com/CreateDeliveryRecords</nowiki> |
| − | * '''Service WSDL:''' | + | * '''Service WSDL:''' https://www.trackabout.com/CreateDeliveryRecords?wsdl |
Test Environment | Test Environment | ||
| − | * '''Web Service URL:''' <nowiki>https://test.trackabout.com | + | * '''Web Service URL:''' <nowiki>https://test.trackabout.com/CreateDeliveryRecords</nowiki> |
| − | * '''Service | + | * '''Service wsdl:''' https://test.trackabout.com/CreateDeliveryRecords?wsdl |
Latest revision as of 15:55, 13 January 2023
Overview
This service allows you to create delivery records in TrackAbout based on actual data collected in the field during deliveries. This service is useful if you are collecting and wish to post delivery data outside of TrackAbout's TAMobile device software.
Service Protocol: SOAP/WSDL Web Service
This is a SOAP/WSDL Web Service (see http://en.wikipedia.org/wiki/Web_service)
Service Authentication
The web service request includes a RequestHeader section, where a username and password must be provided. We strongly recommend that all web service requests be made over SSL (HTTPS).
TrackAbout will provide you with a dedicated user account to use when making web service requests.
Service Parameters
The exact format and order of parameters can be retrieved from the service metadata by calling the service with ?wsdl at the end of the URL. See the usage section below for the full URL.
| Friendly Name | Parameter Name | Description |
|---|---|---|
| User Name | UserName | The username to log into the system |
| Password | Password | The password to authenticate the user name for the request |
| Start Date | StartDate | When the record creation process was started |
| Record Date | RecordDate | When the record creation process was completed. This is the effective date of the record. |
| Accounting User | AccountingUserId | The ID of the user that is submitting the delivery records |
| Customer Information | Customer | Name and address information for the customer that received delivery. Additional detail is available in the WSDL |
| Location | LocationId | The location that the deliveries were made from |
| Truck | TruckId | The Truck that made the deliveries |
| Document Number | DocumentNumber | This is the number used to refer to this delivery. It is the number that the driver would know. It is sometimes the same as either the order number or the invoice number, but it may be different. Some systems call it the shipment number or the delivery number. |
| Notes | Notes | General notes to include in the record. Can be anything. |
| Delivered Asset Information | Assets | A collection of details about the assets that were delivered. Additional information about the data in this collection is available in the WSDL |
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 Truck and Location must be accessible by the specified user.
- If the Customer information is not found, a new Customer will be created and associated with the record(s) being created.
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/CreateDeliveryRecords
- Service WSDL: https://www.trackabout.com/CreateDeliveryRecords?wsdl
Test Environment
- Web Service URL: https://test.trackabout.com/CreateDeliveryRecords
- Service wsdl: https://test.trackabout.com/CreateDeliveryRecords?wsdl