Railcar API
Toolswork load equipment
Bulk load equipment with groupings and weights; supports on-the-fly grouping creation.
POST
/
ims
/
equipment
/
load-toolswork
Toolswork load equipment
curl --request POST \
--url https://api-lg.arms.cedarai.com/ims/equipment/load-toolswork \
--header 'Content-Type: application/json' \
--header 'x-arms-api-key: <api-key>' \
--header 'x-arms-assume-user: <api-key>' \
--data '
{
"carrierId": 1,
"details": [
{
"initialAndNumber": "HUEH 862431",
"netWeightTons": 2000,
"grossWeightTons": 3000,
"comments": "very nice",
"groupings": [
{
"type": "bin",
"name": "bin 0"
},
{
"type": "ash type",
"name": "ash type 0"
}
]
},
{
"initialAndNumber": "YHZT 582774",
"netWeightTons": 2000,
"grossWeightTons": 3000,
"groupings": [
{
"type": "bin",
"name": "bin 1"
},
{
"type": "ash type",
"name": "ash type 1"
}
]
}
],
"trackName": "Jacob Flores",
"waybillTemplateId": 11
}
'import requests
url = "https://api-lg.arms.cedarai.com/ims/equipment/load-toolswork"
payload = {
"carrierId": 1,
"details": [
{
"initialAndNumber": "HUEH 862431",
"netWeightTons": 2000,
"grossWeightTons": 3000,
"comments": "very nice",
"groupings": [
{
"type": "bin",
"name": "bin 0"
},
{
"type": "ash type",
"name": "ash type 0"
}
]
},
{
"initialAndNumber": "YHZT 582774",
"netWeightTons": 2000,
"grossWeightTons": 3000,
"groupings": [
{
"type": "bin",
"name": "bin 1"
},
{
"type": "ash type",
"name": "ash type 1"
}
]
}
],
"trackName": "Jacob Flores",
"waybillTemplateId": 11
}
headers = {
"x-arms-api-key": "<api-key>",
"x-arms-assume-user": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-arms-api-key': '<api-key>',
'x-arms-assume-user': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
carrierId: 1,
details: [
{
initialAndNumber: 'HUEH 862431',
netWeightTons: 2000,
grossWeightTons: 3000,
comments: 'very nice',
groupings: [{type: 'bin', name: 'bin 0'}, {type: 'ash type', name: 'ash type 0'}]
},
{
initialAndNumber: 'YHZT 582774',
netWeightTons: 2000,
grossWeightTons: 3000,
groupings: [{type: 'bin', name: 'bin 1'}, {type: 'ash type', name: 'ash type 1'}]
}
],
trackName: 'Jacob Flores',
waybillTemplateId: 11
})
};
fetch('https://api-lg.arms.cedarai.com/ims/equipment/load-toolswork', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-lg.arms.cedarai.com/ims/equipment/load-toolswork",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'carrierId' => 1,
'details' => [
[
'initialAndNumber' => 'HUEH 862431',
'netWeightTons' => 2000,
'grossWeightTons' => 3000,
'comments' => 'very nice',
'groupings' => [
[
'type' => 'bin',
'name' => 'bin 0'
],
[
'type' => 'ash type',
'name' => 'ash type 0'
]
]
],
[
'initialAndNumber' => 'YHZT 582774',
'netWeightTons' => 2000,
'grossWeightTons' => 3000,
'groupings' => [
[
'type' => 'bin',
'name' => 'bin 1'
],
[
'type' => 'ash type',
'name' => 'ash type 1'
]
]
]
],
'trackName' => 'Jacob Flores',
'waybillTemplateId' => 11
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-arms-api-key: <api-key>",
"x-arms-assume-user: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-lg.arms.cedarai.com/ims/equipment/load-toolswork"
payload := strings.NewReader("{\n \"carrierId\": 1,\n \"details\": [\n {\n \"initialAndNumber\": \"HUEH 862431\",\n \"netWeightTons\": 2000,\n \"grossWeightTons\": 3000,\n \"comments\": \"very nice\",\n \"groupings\": [\n {\n \"type\": \"bin\",\n \"name\": \"bin 0\"\n },\n {\n \"type\": \"ash type\",\n \"name\": \"ash type 0\"\n }\n ]\n },\n {\n \"initialAndNumber\": \"YHZT 582774\",\n \"netWeightTons\": 2000,\n \"grossWeightTons\": 3000,\n \"groupings\": [\n {\n \"type\": \"bin\",\n \"name\": \"bin 1\"\n },\n {\n \"type\": \"ash type\",\n \"name\": \"ash type 1\"\n }\n ]\n }\n ],\n \"trackName\": \"Jacob Flores\",\n \"waybillTemplateId\": 11\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-arms-api-key", "<api-key>")
req.Header.Add("x-arms-assume-user", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-lg.arms.cedarai.com/ims/equipment/load-toolswork")
.header("x-arms-api-key", "<api-key>")
.header("x-arms-assume-user", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"carrierId\": 1,\n \"details\": [\n {\n \"initialAndNumber\": \"HUEH 862431\",\n \"netWeightTons\": 2000,\n \"grossWeightTons\": 3000,\n \"comments\": \"very nice\",\n \"groupings\": [\n {\n \"type\": \"bin\",\n \"name\": \"bin 0\"\n },\n {\n \"type\": \"ash type\",\n \"name\": \"ash type 0\"\n }\n ]\n },\n {\n \"initialAndNumber\": \"YHZT 582774\",\n \"netWeightTons\": 2000,\n \"grossWeightTons\": 3000,\n \"groupings\": [\n {\n \"type\": \"bin\",\n \"name\": \"bin 1\"\n },\n {\n \"type\": \"ash type\",\n \"name\": \"ash type 1\"\n }\n ]\n }\n ],\n \"trackName\": \"Jacob Flores\",\n \"waybillTemplateId\": 11\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-lg.arms.cedarai.com/ims/equipment/load-toolswork")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-arms-api-key"] = '<api-key>'
request["x-arms-assume-user"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"carrierId\": 1,\n \"details\": [\n {\n \"initialAndNumber\": \"HUEH 862431\",\n \"netWeightTons\": 2000,\n \"grossWeightTons\": 3000,\n \"comments\": \"very nice\",\n \"groupings\": [\n {\n \"type\": \"bin\",\n \"name\": \"bin 0\"\n },\n {\n \"type\": \"ash type\",\n \"name\": \"ash type 0\"\n }\n ]\n },\n {\n \"initialAndNumber\": \"YHZT 582774\",\n \"netWeightTons\": 2000,\n \"grossWeightTons\": 3000,\n \"groupings\": [\n {\n \"type\": \"bin\",\n \"name\": \"bin 1\"\n },\n {\n \"type\": \"ash type\",\n \"name\": \"ash type 1\"\n }\n ]\n }\n ],\n \"trackName\": \"Jacob Flores\",\n \"waybillTemplateId\": 11\n}"
response = http.request(request)
puts response.read_body{}{
"message": "<string>"
}Authorizations
Your ARMS API key
Email of a user assigned to the appropriate user group
Query Parameters
Carrier identifier; required for all endpoints
Optional user group context
Body
application/json
Carrier identifier for the load.
List of equipment and attributes to load.
Show child attributes
Show child attributes
Track name where toolswork is loaded.
Waybill template identifier to use for the load.
Optional timestamp of the load event.
Response
OK
The response is of type object.
Related topics
API IntroductionCreate Truck Load TenderUpdate Truck Load TenderGet Truck Load TenderList Truck Load TendersWas this page helpful?
⌘I
Toolswork load equipment
curl --request POST \
--url https://api-lg.arms.cedarai.com/ims/equipment/load-toolswork \
--header 'Content-Type: application/json' \
--header 'x-arms-api-key: <api-key>' \
--header 'x-arms-assume-user: <api-key>' \
--data '
{
"carrierId": 1,
"details": [
{
"initialAndNumber": "HUEH 862431",
"netWeightTons": 2000,
"grossWeightTons": 3000,
"comments": "very nice",
"groupings": [
{
"type": "bin",
"name": "bin 0"
},
{
"type": "ash type",
"name": "ash type 0"
}
]
},
{
"initialAndNumber": "YHZT 582774",
"netWeightTons": 2000,
"grossWeightTons": 3000,
"groupings": [
{
"type": "bin",
"name": "bin 1"
},
{
"type": "ash type",
"name": "ash type 1"
}
]
}
],
"trackName": "Jacob Flores",
"waybillTemplateId": 11
}
'import requests
url = "https://api-lg.arms.cedarai.com/ims/equipment/load-toolswork"
payload = {
"carrierId": 1,
"details": [
{
"initialAndNumber": "HUEH 862431",
"netWeightTons": 2000,
"grossWeightTons": 3000,
"comments": "very nice",
"groupings": [
{
"type": "bin",
"name": "bin 0"
},
{
"type": "ash type",
"name": "ash type 0"
}
]
},
{
"initialAndNumber": "YHZT 582774",
"netWeightTons": 2000,
"grossWeightTons": 3000,
"groupings": [
{
"type": "bin",
"name": "bin 1"
},
{
"type": "ash type",
"name": "ash type 1"
}
]
}
],
"trackName": "Jacob Flores",
"waybillTemplateId": 11
}
headers = {
"x-arms-api-key": "<api-key>",
"x-arms-assume-user": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-arms-api-key': '<api-key>',
'x-arms-assume-user': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
carrierId: 1,
details: [
{
initialAndNumber: 'HUEH 862431',
netWeightTons: 2000,
grossWeightTons: 3000,
comments: 'very nice',
groupings: [{type: 'bin', name: 'bin 0'}, {type: 'ash type', name: 'ash type 0'}]
},
{
initialAndNumber: 'YHZT 582774',
netWeightTons: 2000,
grossWeightTons: 3000,
groupings: [{type: 'bin', name: 'bin 1'}, {type: 'ash type', name: 'ash type 1'}]
}
],
trackName: 'Jacob Flores',
waybillTemplateId: 11
})
};
fetch('https://api-lg.arms.cedarai.com/ims/equipment/load-toolswork', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-lg.arms.cedarai.com/ims/equipment/load-toolswork",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'carrierId' => 1,
'details' => [
[
'initialAndNumber' => 'HUEH 862431',
'netWeightTons' => 2000,
'grossWeightTons' => 3000,
'comments' => 'very nice',
'groupings' => [
[
'type' => 'bin',
'name' => 'bin 0'
],
[
'type' => 'ash type',
'name' => 'ash type 0'
]
]
],
[
'initialAndNumber' => 'YHZT 582774',
'netWeightTons' => 2000,
'grossWeightTons' => 3000,
'groupings' => [
[
'type' => 'bin',
'name' => 'bin 1'
],
[
'type' => 'ash type',
'name' => 'ash type 1'
]
]
]
],
'trackName' => 'Jacob Flores',
'waybillTemplateId' => 11
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-arms-api-key: <api-key>",
"x-arms-assume-user: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-lg.arms.cedarai.com/ims/equipment/load-toolswork"
payload := strings.NewReader("{\n \"carrierId\": 1,\n \"details\": [\n {\n \"initialAndNumber\": \"HUEH 862431\",\n \"netWeightTons\": 2000,\n \"grossWeightTons\": 3000,\n \"comments\": \"very nice\",\n \"groupings\": [\n {\n \"type\": \"bin\",\n \"name\": \"bin 0\"\n },\n {\n \"type\": \"ash type\",\n \"name\": \"ash type 0\"\n }\n ]\n },\n {\n \"initialAndNumber\": \"YHZT 582774\",\n \"netWeightTons\": 2000,\n \"grossWeightTons\": 3000,\n \"groupings\": [\n {\n \"type\": \"bin\",\n \"name\": \"bin 1\"\n },\n {\n \"type\": \"ash type\",\n \"name\": \"ash type 1\"\n }\n ]\n }\n ],\n \"trackName\": \"Jacob Flores\",\n \"waybillTemplateId\": 11\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-arms-api-key", "<api-key>")
req.Header.Add("x-arms-assume-user", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-lg.arms.cedarai.com/ims/equipment/load-toolswork")
.header("x-arms-api-key", "<api-key>")
.header("x-arms-assume-user", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"carrierId\": 1,\n \"details\": [\n {\n \"initialAndNumber\": \"HUEH 862431\",\n \"netWeightTons\": 2000,\n \"grossWeightTons\": 3000,\n \"comments\": \"very nice\",\n \"groupings\": [\n {\n \"type\": \"bin\",\n \"name\": \"bin 0\"\n },\n {\n \"type\": \"ash type\",\n \"name\": \"ash type 0\"\n }\n ]\n },\n {\n \"initialAndNumber\": \"YHZT 582774\",\n \"netWeightTons\": 2000,\n \"grossWeightTons\": 3000,\n \"groupings\": [\n {\n \"type\": \"bin\",\n \"name\": \"bin 1\"\n },\n {\n \"type\": \"ash type\",\n \"name\": \"ash type 1\"\n }\n ]\n }\n ],\n \"trackName\": \"Jacob Flores\",\n \"waybillTemplateId\": 11\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-lg.arms.cedarai.com/ims/equipment/load-toolswork")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-arms-api-key"] = '<api-key>'
request["x-arms-assume-user"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"carrierId\": 1,\n \"details\": [\n {\n \"initialAndNumber\": \"HUEH 862431\",\n \"netWeightTons\": 2000,\n \"grossWeightTons\": 3000,\n \"comments\": \"very nice\",\n \"groupings\": [\n {\n \"type\": \"bin\",\n \"name\": \"bin 0\"\n },\n {\n \"type\": \"ash type\",\n \"name\": \"ash type 0\"\n }\n ]\n },\n {\n \"initialAndNumber\": \"YHZT 582774\",\n \"netWeightTons\": 2000,\n \"grossWeightTons\": 3000,\n \"groupings\": [\n {\n \"type\": \"bin\",\n \"name\": \"bin 1\"\n },\n {\n \"type\": \"ash type\",\n \"name\": \"ash type 1\"\n }\n ]\n }\n ],\n \"trackName\": \"Jacob Flores\",\n \"waybillTemplateId\": 11\n}"
response = http.request(request)
puts response.read_body{}{
"message": "<string>"
}