Order Scheduling API
Batch Update Communication Codes
Operation to bulk remove and add communication codes.
Request
Request URL
Request headers
-
(optional)stringMedia type of the body sent to the API.
-
stringOAuth 2.0 access token obtained from JB Hunt OAuth 2.0 Tst Provider (RHSSO-Security360). Supported grant types: Authorization code.
Request body
{
"communicationCodesToCreate": [
{
"codeType": "string",
"code": "string",
"description": "string"
}
],
"communicationCodesToDelete": [
{
"codeType": "string",
"code": "string"
}
]
}{
"title": "Bulk Communication Code Update Request",
"properties": {
"communicationCodesToCreate": {
"type": "array",
"items": {
"title": "Communication Code Creation Request",
"allOf": [
{
"title": "Communication Code Record",
"type": "object",
"properties": {
"codeType": {
"type": "string",
"description": "Code type of record that defines usage category."
},
"code": {
"type": "string",
"description": "Code of record."
},
"description": {
"type": "string",
"description": "Description of communication code."
}
},
"description": "Record containing scheduling communication codes and descriptions."
}
],
"description": "Data needed to create a new communication record."
},
"description": "Communication codes to add to the collection"
},
"communicationCodesToDelete": {
"type": "array",
"items": {
"title": "Communication Code Delete Request",
"required": [
"codeType",
"code"
],
"properties": {
"codeType": {
"type": "string",
"description": "Code type of record that defines usage category."
},
"code": {
"type": "string",
"description": "Code of record."
}
},
"description": "Request to delete a communication code."
},
"description": "Communication codes to remove from the collection."
}
},
"description": "A collection of create and delete request objects, to be used to add and remove multiple communication codes."
}Responses
204 No Content
Batch updates to communication codes performed.
400 Bad Request
Cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). See RFC 7231, Section 6.5.1.
Representations
{
"type": "about:blank",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"dateTime": {},
"issues": [
{
"description": "string",
"field": {},
"location": "body",
"value": {}
}
]
}{
"title": "Problem Details",
"allOf": [
{
"title": "Core Problem Details",
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "A [URI reference](https://tools.ietf.org/html/rfc3986#section-4.1) that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using [HTML](https://www.w3.org/TR/2014/REC-html5-20141028)). When this member is not present, its value is assumed to be `\"about:blank\"`.",
"default": "about:blank"
},
"title": {
"type": "string",
"description": "A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive [content negotiation](https://tools.ietf.org/html/rfc7231#section-3.4))."
},
"status": {
"maximum": 600.0,
"exclusiveMaximum": true,
"minimum": 100.0,
"type": "integer",
"description": "The [HTTP status code](https://tools.ietf.org/html/rfc7231#section-6) generated by the origin server for this occurrence of the problem."
},
"detail": {
"type": "string",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"instance": {
"type": "string",
"description": "A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced."
}
},
"description": "The core problem details object. See [Section 3.1 of RFC 7807](https://tools.ietf.org/html/rfc7807#section-3.1)."
},
{
"title": "Problem Details Extensions",
"type": "object",
"properties": {
"dateTime": {
"allOf": [
{
"title": "Date Time",
"type": "string",
"description": "As defined by `date-time` in [Section 5.6 of RFC 3339](https://tools.ietf.org/html/rfc3339#section-5.6)",
"format": "date-time"
}
],
"description": "The date and time that the problem occurred."
},
"issues": {
"type": "array",
"items": {
"title": "Issue",
"required": [
"description",
"field",
"location"
],
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "A human-readable explanation of the specific issue."
},
"field": {
"anyOf": [
{
"title": "JSON Pointer",
"pattern": "^(\\/([^/~]|~[01])*)*$",
"type": "string",
"description": "A string representing a JSON Pointer as defined by [RFC 6901](https://tools.ietf.org/html/rfc6901)."
},
{
"type": "string"
}
],
"description": "The name of the field in error. If `location` is `body`, then this MUST be either a [JSON pointer](https://tools.ietf.org/html/rfc6901) or an [XPath expression](https://www.w3.org/TR/1999/REC-xpath-19991116) referring to the field of the body."
},
"location": {
"enum": [
"body",
"header",
"path",
"query"
],
"type": "string",
"description": "The location of the issue.",
"default": "body"
},
"value": {
"allOf": [
{
"title": "Any?",
"allOf": [
{
"title": "Any",
"oneOf": [
{
"title": "Any Primitive",
"oneOf": [
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "string"
}
],
"description": "Any non-nullable primitive JSON value"
},
{
"title": "Any Structured Value",
"oneOf": [
{
"type": "array"
},
{
"type": "object"
}
],
"description": "Any non-nullable structured JSON value"
}
],
"description": "Any non-nullable JSON value"
}
],
"description": "Any nullable JSON value",
"nullable": true
}
],
"description": "The value of the field in error."
}
},
"description": "An object describing the issue of a particular field in an HTTP request message."
},
"description": "An array of issues related to specific fields in the HTTP request message."
}
},
"description": "Custom J.B. Hunt extensions to the problems details format"
}
],
"description": "The [Problem Details for HTTP APIs](https://tools.ietf.org/html/rfc7807) format with extensions."
}Code samples
@ECHO OFF
curl -v -X POST "https://api.nonprod.jbhunt.com/order-scheduling/communication-codes/perform-batch-operations"
-H "Content-Type: application/json"
-H "Api-Key: {subscription key}"
-H "Authorization: {access token}"
--data-ascii "{body}"
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;
namespace CSHttpClientSample
{
static class Program
{
static void Main()
{
MakeRequest();
Console.WriteLine("Hit ENTER to exit...");
Console.ReadLine();
}
static async void MakeRequest()
{
var client = new HttpClient();
var queryString = HttpUtility.ParseQueryString(string.Empty);
// Request headers
client.DefaultRequestHeaders.Add("Api-Key", "{subscription key}");
client.DefaultRequestHeaders.Add("Authorization", "{access token}");
var uri = "https://api.nonprod.jbhunt.com/order-scheduling/communication-codes/perform-batch-operations?" + queryString;
HttpResponseMessage response;
// Request body
byte[] byteData = Encoding.UTF8.GetBytes("{body}");
using (var content = new ByteArrayContent(byteData))
{
content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
response = await client.PostAsync(uri, content);
}
}
}
} // // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class JavaSample
{
public static void main(String[] args)
{
HttpClient httpclient = HttpClients.createDefault();
try
{
URIBuilder builder = new URIBuilder("https://api.nonprod.jbhunt.com/order-scheduling/communication-codes/perform-batch-operations");
URI uri = builder.build();
HttpPost request = new HttpPost(uri);
request.setHeader("Content-Type", "application/json");
request.setHeader("Api-Key", "{subscription key}");
request.setHeader("Authorization", "{access token}");
// Request body
StringEntity reqEntity = new StringEntity("{body}");
request.setEntity(reqEntity);
HttpResponse response = httpclient.execute(request);
HttpEntity entity = response.getEntity();
if (entity != null)
{
System.out.println(EntityUtils.toString(entity));
}
}
catch (Exception e)
{
System.out.println(e.getMessage());
}
}
}
<!DOCTYPE html>
<html>
<head>
<title>JSSample</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>
<script type="text/javascript">
$(function() {
var params = {
// Request parameters
};
$.ajax({
url: "https://api.nonprod.jbhunt.com/order-scheduling/communication-codes/perform-batch-operations?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Content-Type","application/json");
xhrObj.setRequestHeader("Api-Key","{subscription key}");
xhrObj.setRequestHeader("Authorization","{access token}");
},
type: "POST",
// Request body
data: "{body}",
})
.done(function(data) {
alert("success");
})
.fail(function() {
alert("error");
});
});
</script>
</body>
</html>
#import <Foundation/Foundation.h>
int main(int argc, const char * argv[])
{
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
NSString* path = @"https://api.nonprod.jbhunt.com/order-scheduling/communication-codes/perform-batch-operations";
NSArray* array = @[
// Request parameters
@"entities=true",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"POST"];
// Request headers
[_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
[_request setValue:@"{subscription key}" forHTTPHeaderField:@"Api-Key"];
[_request setValue:@"{access token}" forHTTPHeaderField:@"Authorization"];
// Request body
[_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
NSURLResponse *response = nil;
NSError *error = nil;
NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];
if (nil != error)
{
NSLog(@"Error: %@", error);
}
else
{
NSError* error = nil;
NSMutableDictionary* json = nil;
NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
NSLog(@"%@", dataString);
if (nil != _connectionData)
{
json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
}
if (error || !json)
{
NSLog(@"Could not parse loaded json with error:%@", error);
}
NSLog(@"%@", json);
_connectionData = nil;
}
[pool drain];
return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';
$request = new Http_Request2('https://api.nonprod.jbhunt.com/order-scheduling/communication-codes/perform-batch-operations');
$url = $request->getUrl();
$headers = array(
// Request headers
'Content-Type' => 'application/json',
'Api-Key' => '{subscription key}',
'Authorization' => '{access token}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_POST);
// Request body
$request->setBody("{body}");
try
{
$response = $request->send();
echo $response->getBody();
}
catch (HttpException $ex)
{
echo $ex;
}
?>########### Python 2.7 #############
import httplib, urllib, base64
headers = {
# Request headers
'Content-Type': 'application/json',
'Api-Key': '{subscription key}',
'Authorization': '{access token}',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('api.nonprod.jbhunt.com')
conn.request("POST", "/order-scheduling/communication-codes/perform-batch-operations?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64
headers = {
# Request headers
'Content-Type': 'application/json',
'Api-Key': '{subscription key}',
'Authorization': '{access token}',
}
params = urllib.parse.urlencode({
})
try:
conn = http.client.HTTPSConnection('api.nonprod.jbhunt.com')
conn.request("POST", "/order-scheduling/communication-codes/perform-batch-operations?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################require 'net/http'
uri = URI('https://api.nonprod.jbhunt.com/order-scheduling/communication-codes/perform-batch-operations')
request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json'
# Request headers
request['Api-Key'] = '{subscription key}'
# Request headers
request['Authorization'] = '{access token}'
# Request body
request.body = "{body}"
response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
http.request(request)
end
puts response.body