POST - Location
The Location Service comprises of a JSON Object that allows users to create, update, and delete Locations within Location Management in System's Freight Portal. Locations can be generated with custom data points such as user-defined geo-fences, on-time rules, location hours, and dwell time.
In order to get started. you'll have to create a Basic Location Object. The following guides below, help you create (POST), update (PUT), and Delete (DELETE) a Location.
Creating a Locations
The POST /fixedLocation endpoint allows the creation of a specific fixed location in the Freight Portal.
Here is the POST HTTP endpoint:
HTTP Verb: POST
URI: https://{domain}.locationmanagement.services.10-4.com/v1/fixedlocation/
Authentication: Bearer Token
Adding the FixedLocation Reference Details
To create a basic FixedLocation, your internal location code must be supplied in the form of a FixedLocationCode and your internal location name must be supplied in the form of a FixedLocationName. Below are the details of these parameter:
Parameter | Type | Description |
---|---|---|
FixedLocationCode | String | An external reference code for the fixed location. These must be unique. If one is not provided, a unique code will be generated for the record. |
FixedLocationName | String | The external reference to the Fixed Location's name. |
FixedLocationType | The enumeration type of a Fixed Location type. |
Adding the Location Details
To have the FixedLocation Object validate properly, you must supply a method to infer the physical location of the point of interest. Below are the two examples of what you may choose from and their respected parameters, data types, and descriptions.
1. FixedLocationPoint Object
2. StreetAddress1, CityName, PostalCode, StateCode, and CountryCode
Below are the details of these parameters:
Parameter | Type | Description |
---|---|---|
FixedLocationPoint | ||
StreetAddress1 | String | Street address of the fixed location. Max: 250. |
CityName | String | City name of the FixedLocation. |
PostalCode | String | Postal Code of the FixedLocation. |
StateCode | String | State Code of the FixedLocation. |
CountryCode | String | Country Code of the FixedLocation. |
Additional Required Details
Some organizations require an external reference code for the fixed location that is used for organizational tracking separate from the FixedLocationCode. for this we provide the optional value below:
Parameter | Type | Description |
---|---|---|
OrganizationReferenceCode | String | An optional external reference code for the fixed location that is used for organizational tracking separate from the FixedLocationCode. |
Completed Basic FixedLocation Object
Here is an example of a fixed location with and without organization references in use:
{
"FixedLocationName": "Only the Basics",
"FixedLocationCode" : "OTB0",
"FixedLocationPoint" :
{
"Latitude": 50.1234,
"Longitude": -45.5432
},
"FixedLocationType":"1",
}
{
"FixedLocationName": "Only The Basics - Address",
"FixedLocationCode" : "ADDRESSORGPREF",
"streetAddressLine1": "4888 Pearl East Cir",
"streetAddressLine2": "300W",
"cityName": "Boulder",
"stateCode": "CO",
"postalCode": "80301",
"countryCode": "US",
"fixedLocationPoint": {
"latitude": 40.0207039,
"longitude": -105.2391367
},
"organizationReferenceCode": "112222",
"FixedLocationType":"1"
}
Updated about 2 months ago