Overview
This API gives user an ability to process the BOES details and return BOES Number. Please see input parameters, sample request and response from below This API gives user an ability to process the BOES details and return BOES Number. Please see input parameters, sample request and response from below
BOES Login
get /rest/BOES/boesLogin?userName=
This API gives user an ability to login by providing required parameters. Please see input parameters, sample response from below.
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| userName |
String |
M | UserName for login. |
| password |
String |
M | Password for login. |
Success 200
| Field | Type | Description |
|---|---|---|
| userName |
String |
UserName used for login |
| userId |
NUMERIC |
user's primaryId |
| scac |
String |
User SCAC Code. |
| userType |
String |
Type of User. |
| firstName |
String |
FirstName of User. |
| lastName |
String |
LastName of User. |
| loginId |
Numeric |
LoginId User. |
| companyName |
String |
LoggedIn user's Company Name. |
| userTypeId |
Numeric |
LoggedIn user's TypeId. |
|
String |
LoggedIn user's Email Address. | |
| accessToken |
String |
LoggedIn user's AccessToken. |
Samples Response - Success 200
{
"userName": "Username for login",
"userId": "User ID",
"scac": "User scac",
"userType": "User Type",
"firstName": "User first name",
"lastName": "User last name",
"loginId": "User login ID",
"companyName": "User company name",
"userTypeId": "User type ID",
"email": "User email address",
"accessToken": "User access token"
}
Error 4xx/5xx
| Field | Type | Description |
|---|---|---|
| code |
Number |
Error code ( 1= error, 2 =warning, 3=info, 4 =ok) |
| type |
String |
Response type can be of error,warning, info, ok |
| message |
String |
- |
| details |
String |
- |
| apiReqErrors |
String |
error: 1) errorCategory:= Validation Error/ Business Error/ Server Error. 2) errorMessage:= Specific Message based on errorCategory |
Samples Response - Error 4xx/500
{
"code": 1,
"type": "error",
"message": null,
"details": null,
"apiReqErrors": {
"errors": [
{
"transNum": 1,
"errorCategory": "Validation Error(s)",
"errorMessage": "UserName can not be blank,Password can not be blank"
}
]
}
}
Report BOES
post /rest/BOES/badOrderReport
Allows authorized BOES subscribers to put equipment into Out of Service status. Please see input parameters, sample request and response from below
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| accessToken |
String |
M | Unique access token provided by IANA. |
| equipPrefix |
String |
M | Equipment Prefix. |
| equipNumber |
Number |
M | Equipment Number. |
| location |
Number |
M | IANA Location code or SPLC. |
Request samples
{
"badOrderList": [
{
"equipPrefix":"DCLZ",
"equipNumber":"425223",
"location":"9955901"
}
],
"accessToken": "{provided by IANA}"
}
Success 200
| Field | Type | Description |
|---|---|---|
| code |
Number |
Response code (4 =ok) |
| type |
String |
Response type can be of error,warning, info, ok |
| message |
String |
Specific Message about operation success with generated BOES Number. |
Samples Response - Success 200
[
{
"equipPrefix": "DCLZ",
"equipNumber": "425223",
"location": "9955901",
"boesRequestId": "BOES-000012106"
}
]
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<APIRESPONSE>
<CODE>4</CODE>
<TYPE>ok</TYPE>
<MESSAGE>Message with generated BOES Number</MESSAGE>
</APIRESPONSE>
Error 4xx/5xx
| Field | Type | Description |
|---|---|---|
| code |
Number |
Error code ( 1= error, 2 =warning, 3=info, 4 =ok) |
| type |
String |
Response type can be of error,warning, info, ok |
| message |
String |
- |
| apiReqErrors |
String |
error: 1) errorCategory:= Validation Error/ Business Error/ Server Error. 2) errorMessage:= Specific Message based on errorCategory |
Samples Response - Error 4xx/500
{
"code": 1,
"type": "error",
"message": "",
"details": "",
"apiReqErrors": {
"errors": [
{
"transNum": 1,
"errorCategory": "Validation Error(s)",
"errorMessage": "Equipment Number should not be blank"
}
]
}
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<APIRESPONSE>
<CODE>1</CODE>
<TYPE>error</TYPE>
<MESSAGE></MESSAGE>
<APIREQERRORS>
<ERRORS>
<TRANSNUM>1</TRANSNUM>
<ERRORCATEGORY>Business Error(s)</ERRORCATEGORY>
<ERRORMESSAGE>BOES Pin is invalid.</ERRORMESSAGE>
</ERRORS>
</APIREQERRORS>
</APIRESPONSE>
Allows authorized BOES subscribers to pull the list of in Out of Service status. Please see input parameters, sample request and response from below
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| accessToken |
String |
M | Unique access token provided by IANA. |
| equipPrefix |
String |
O | Equipment Prefix |
| equipNumber |
Number |
O | Equipment Number |
| ianaSplcCode |
Number |
O | IANA Location code or SPLC |
| fromTransactionDate |
String(mm/dd/yyyy) |
O | From Date |
| toTransactionDate |
String(mm/dd/yyyy) |
O | To Date |
| poolId |
String |
O | - |
| status |
String |
O | Equipment Status(OUTOFSERVICE / RELEASED) |
Request samples
GET /rest/BOES/listBadOrder?accessToken=
&equipmentPrefix=DCLZ&equipmentNumber=425223&ianaSplcCode=&fromTransactionDate&toTransactionDate=&poolId=&status=
Success 200
| Field | Type | Description |
|---|---|---|
| boesTranId |
Number |
BOES transaction id |
| chassisId |
String |
Chassis Id |
| facility |
String |
Facility name |
| iepScac |
String |
IEP SCAC |
| poolId |
String |
Pool Id |
| Status |
String |
Status |
| createdDate |
String |
Date |
| releaseDate |
String |
Date |
| size |
Number |
Page size |
| totalElements |
Number |
Total size of records |
| totalPages |
Number |
Total pages |
| currentPage |
Number |
Current page |
Samples Response - Success 200
{
"listBOESRecords": [
{
"boesTranId": "12105",
"chassisId": "DCLZ425223",
"facility": "BETHEL CITY DOCK",
"iepScac": "DCLZ",
"poolId": "DC01",
"status": "RELEASED",
"createdDate": "08/30/2022 13:44:55",
"releaseDate": "08/30/2022 13:47:22"
},
{
"boesTranId": "12106",
"chassisId": "DCLZ425223",
"facility": "BETHEL CITY DOCK",
"iepScac": "DCLZ",
"poolId": "DC01",
"status": "RELEASED",
"createdDate": "08/30/2022 13:45:33",
"releaseDate": "08/30/2022 13:47:22"
}
],
"page": {
"size": 10,
"totalElements": 2,
"totalPages": 1,
"currentPage": 1
}
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<APIRESPONSE>
<CODE>4</CODE>
<TYPE>ok</TYPE>
<MESSAGE>Message with generated BOES Number</MESSAGE>
</APIRESPONSE>
Error 4xx/5xx
| Field | Type | Description |
|---|---|---|
| code |
Number |
Error code ( 1= error, 2 =warning, 3=info, 4 =ok) |
| type |
String |
Response type can be of error,warning, info, ok |
| message |
String |
- |
| apiReqErrors |
String |
error: 1) errorCategory:= Validation Error/ Business Error/ Server Error. 2) errorMessage:= Specific Message based on errorCategory |
Samples Response - Error 4xx/500
{
"code": 1,
"type": "error",
"message": "",
"apiReqErrors": {
"errors": [
{
"transNum": 1,
"errorCategory": "Business Error(s)",
"errorMessage": "No records found."
}
]
}
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<APIRESPONSE>
<CODE>1</CODE>
<TYPE>error</TYPE>
<MESSAGE></MESSAGE>
<APIREQERRORS>
<ERRORS>
<TRANSNUM>1</TRANSNUM>
<ERRORCATEGORY>Business Error(s)</ERRORCATEGORY>
<ERRORMESSAGE>BOES Pin is invalid.</ERRORMESSAGE>
</ERRORS>
</APIREQERRORS>
</APIRESPONSE>
post /rest/BOES/badOrderRelease
This API gives subscriber an ability to release equipment from OUTOFSERVICE in BOES by providing required parameters. It also allows users to send multiple bad order releases at the same time. Please see input parameters, sample request and response from below.
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| equipPrefix |
String [ 4 chars ] |
M | Equipment Prefix. |
| equipNumber |
Number [ 6 Digits ] |
M | Equipment Number. |
| boesReqId |
String [ 15 alphanumeric ] |
O | Bad Order Request Id. |
| refId |
String |
O | Reference Id. |
| accessToken |
String [ 15 alphanumeric ] |
M | Unique Access Token Provided by IANA. |
Request samples
{
"releaseList": [
{
"equipPrefix": "Provide Equipment Prefix",
"equipNumber": "ProvideEquipmentNum",
"boesReqId": "Provide BOESCRequest Id",
"refId": "ProvideRefId"
},
{
"equipPrefix": "Provide EquipmentPrefix",
"equipNumber": "Provide EquipmentNum",
"boesReqId": "Provide BOESC Request Id",
"refId": "ProvideRefId"
}
],
"accessToken": "Your Access Token"
}
Success 200
| Field | Type | Description |
|---|---|---|
| code |
Number |
Response code (4 =ok) |
| type |
String |
Response type can be of error,warning, info, ok |
| message |
String |
Specific Message about operation success. |
Samples Response - Success 200
{
"code": 4,
"type": "ok",
"message": "SUCCESS"
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<APIRESPONSE>
<CODE>4</CODE>
<TYPE>ok</TYPE>
<MESSAGE>SUCCESS</MESSAGE>
</APIRESPONSE>
Error 4xx/5xx
| Field | Type | Description |
|---|---|---|
| code |
Number |
Error code ( 1= error, 2 =warning, 3=info, 4 =ok) |
| type |
String |
Response type can be of error,warning, info, ok |
| message |
String |
- |
| apiReqErrors |
String |
error: 1) errorCategory:= Validation Error/ Business Error/ Server Error. 2) errorMessage:= Specific Message based on errorCategory |
Samples Response - Error 4xx/500
{
"code": 1,
"type": "error",
"message": "",
"apiReqErrors": {
"errors": [
{
"transNum": 1,
"errorCategory": "Validation Error(s)",
"errorMessage": "Equipment Number should not be more than 6 characters"
},
{
"transNum": 2,
"errorCategory": "Business Error(s)",
"errorMessage": "BOESREQID already processed in BOES database"
}
]
}
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<APIRESPONSE>
<CODE>1</CODE>
<TYPE>error</TYPE>
<MESSAGE></MESSAGE>
<APIREQERRORS>
<ERRORS>
<TRANSNUM>1</TRANSNUM>
<ERRORCATEGORY>Validation Error(s)</ERRORCATEGORY>
<ERRORMESSAGE>Equipment Number should not be more than 6 characters</ERRORMESSAGE>
</ERRORS>
<ERRORS>
<TRANSNUM>2</TRANSNUM>
<ERRORCATEGORY>Business Error(s)</ERRORCATEGORY>
<ERRORMESSAGE>BOESREQID already processed in BOES database</ERRORMESSAGE>
</ERRORS>
</APIREQERRORS>
</APIRESPONSE>
Overview
This API gives user an ability to process the DVIR details and return DVIR Number. Please see input parameters, sample request and response from below This API gives user an ability to process the DVIR details and return DVIR Number. Please see input parameters, sample request and response from below
Report DVIR
post /rest/v1/DVIR/auth
This API gives user an ability to login by providing required parameters. Please see input parameters, sample response from below.
Parameters
| Field | Type | Required | Descriptio |
|---|---|---|---|
| username |
String |
M | Login username. |
| password |
String |
M | Login password. |
Request samples
{
"username":"Provide username",
"password":"Provide password"
}
Success 200
| Field | Type | Description |
|---|---|---|
| accessToken |
String |
User access token |
Samples Response - Success 200
{
"accessToken": "Access Token"
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<LoginResponse>
<ACCESSTOKEN>eyJzdWIiOiJkdmlyd2ViIi</ACCESSTOKEN>
</LoginResponse>
Error 4xx/5xx
| Field | Type | Description |
|---|---|---|
| code |
Number |
Error code ( 1= error, 2 =warning, 3=info, 4 =ok) |
| type |
String |
Response type can be of error,warning, info, ok |
| message |
String |
- |
| details |
String |
- |
| apiReqErrors |
String |
error: 1) errorCategory:= Validation Error/ Business Error/ Server Error. 2) errorMessage:= Specific Message based on errorCategory |
Samples Response - Error 4xx/500
{
"code": 1,
"type": "error",
"message": "",
"details": "",
"apiReqErrors": {
"errors": [
{
"transNum": 1,
"errorCategory": "Business Error(s)",
"errorMessage": "Invalid User Name or Password."
}
]
}
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<APIRESPONSE>
<CODE>1</CODE>
<TYPE>error</TYPE>
<MESSAGE></MESSAGE>
<APIREQERRORS>
<ERRORS>
<TRANSNUM>1</TRANSNUM>
<ERRORCATEGORY>Business Error(s)</ERRORCATEGORY>
<ERRORMESSAGE>Invalid User Name or Password.</ERRORMESSAGE>
</ERRORS>
</APIREQERRORS>
</APIRESPONSE>
This API gives user an ability to process the DVIR details and return DVIR Number. Please see input parameters, sample request and response from below.
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| accessToken |
String [ 15 alphanumeric ] |
M | Unique Access Token Provided by IANA. |
| equipmentPrefix |
String [ 4 chars ] |
M | Equipment Prefix. |
| equipmentNumber |
Number [ 6 Digit ] |
M | Equipment Number. |
| location |
Number |
M | IANA or SPLC Location. |
| driverLicenseNo |
String |
C | Driver License No. |
| licenseState |
String [ 2 chars ] |
C | License State. |
| iddPin |
Number |
C | Driver PIN. |
| mcScac |
String [ 4 chars ] |
C | Moter Carrier's SCAC (Optional for MC) |
| rcd |
String |
M | RCD should be within (00-09) |
Request samples
{
"accessToken": "Your Access Token",
"equipmentPrefix": "Provide Equipment Prefix",
"equipmentNumber": "Provide Equipment Num",
"location": "Provide IANA Or SPLC Location",
"driverLicenseNo": "Provide Driver License No",
"licenseState": "Provide Driver License State",
"iddPin": "Provide Driver PIN",
"mcScac": "Provide MC SCAC",
"rcd": "Provide RCD in comma separated"
}
Success 200
| Field | Type | Description |
|---|---|---|
| code |
Number |
Response code (4 =ok) |
| type |
String |
Response type can be of error,warning, info, ok |
| message |
String |
Specific Message about operation success with generated DVIR Number. |
Samples Response - Success 200
{
"code": 4,
"type": "ok",
"message": "Message with generated DVIR Number"
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<APIRESPONSE>
<CODE>4</CODE>
<TYPE>ok</TYPE>
<MESSAGE>Message with generated DVIR Number</MESSAGE>
</APIRESPONSE>
Error 4xx/5xx
| Field | Type | Description |
|---|---|---|
| code |
Number |
Error code ( 1= error, 2 =warning, 3=info, 4 =ok) |
| type |
String |
Response type can be of error,warning, info, ok |
| message |
String |
- |
| apiReqErrors |
String |
error: 1) errorCategory:= Validation Error/ Business Error/ Server Error. 2) errorMessage:= Specific Message based on errorCategory |
Samples Response - Error 4xx/500
{
"code": 1,
"type": "error",
"message": "",
"apiReqErrors": {
"errors": [
{
"transNum": 1,
"errorCategory": "Business Error(s)",
"errorMessage": "DVIR Pin is invalid."
}
]
}
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<APIRESPONSE>
<CODE>1</CODE>
<TYPE>error</TYPE>
<MESSAGE></MESSAGE>
<APIREQERRORS>
<ERRORS>
<TRANSNUM>1</TRANSNUM>
<ERRORCATEGORY>Business Error(s)</ERRORCATEGORY>
<ERRORMESSAGE>DVIR Pin is invalid.</ERRORMESSAGE>
</ERRORS>
</APIREQERRORS>
</APIRESPONSE>
get /rest/v1/DVIR/mcwebservice?CHID=&INSID=&STABBR=
This API gives user an ability to process the MC information and return IANA MC Webservice details. Please see input parameters, sample request and response from below
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| CHID |
String |
O | Chassis Prefix |
| INSID |
String |
O | Inspector Id |
| STABBR |
String |
O | Inspection State |
Request samples
/rest/v1/DVIR/mcwebservice?CHID=&INSID=&STABBR=
Success 200
| Field | Type | Description |
|---|---|---|
| status |
String |
Status |
| name |
String |
Company Name |
| dot |
String |
US DOT Number |
| scac |
String |
SCAC |
| chaspool |
String |
Chassis pool code |
| chassisStatus |
String |
OK Or NOTFOUND |
| chassisID |
String |
Chassis ID |
Samples Response - Success 200
{
"authBean": {
"status": "OK"
},
"ianaMCWebserviceDetailsBean": {
"name": "company name",
"dot": "us dot number",
"scac": "scac",
"chaspool": "NOTFOUND",
"chassisStatus": "OK",
"chassisID": ""
}
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<IANAMCWebServiceResponse>
<AUTHENTICATION>
<STATUS>OK</STATUS>
</AUTHENTICATION>
<IEP>
<NAME>company name</NAME>
<DOT>us dot number</DOT>
<SCAC>scac</SCAC>
<CHASPOOL>NOTFOUND</CHASPOOL>
</IEP>
</IANAMCWebServiceResponse>
Error 4xx/5xx
| Field | Type | Description |
|---|---|---|
| code |
Number |
Error code ( 1= error, 2 =warning, 3=info, 4 =ok) |
| type |
String |
Response type can be of error,warning, info, ok |
| message |
String |
- |
| apiReqErrors |
String |
error: 1) errorCategory:= Validation Error/ Business Error/ Server Error. 2) errorMessage:= Specific Message based on errorCategory |
Samples Response - Error 4xx/500
Overview
This API gives user an ability to process the GIER details and return GIER Number. Please see input parameters, sample request and response from below This API gives user an ability to process the GIER details and return GIER Number. Please see input parameters, sample request and response from below
Report GIER
post /rest/GIER/login
This API gives user an ability to login by providing required parameters. Please see input parameters, sample response from below.
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| userName |
String |
M | Username for login. |
| password |
String |
C | Password for Login. |
Request samples
{
"userName":"Provide username",
"password":"Provide password"
}
Success 200
| Field | Type | Description |
|---|---|---|
| accessToken |
String |
Access Token to retrieve other APIs |
| userId |
Number |
User unique id. |
| companyId |
Number |
Company's id in GIER. |
| details |
String |
- |
| selectedCompanyId |
Number |
Company's id in GIER. |
| companyType |
String |
Company's type in GIER(Private/Public....etc). |
| companyTypeId |
Number |
Company's type id in GIER(Private/Public....etc). |
| userClassName |
String |
Name of user class in GIER(Technical....etc). |
| userClassId |
Number |
Id of user class in GIER(Technical....etc). |
| contact |
String |
First and last name of logged-in user. |
| profileId |
Number |
Logged-in user profile id. |
| userType |
String |
Usertype of Logged-in user. |
| companyName |
String |
Logged-in user company name. |
| companyUsDotNumber |
String |
Company us dot number |
| userName |
String |
Username used for login input. |
| firstName |
String |
Logged-in user first name. |
| middleName |
String |
Logged-in user middle name. |
| lastName |
String |
Logged-in user last name. |
|
String |
Logged-in user Email address. | |
| phone |
String |
Logged-in user Phone number. |
| status |
String |
Logged-in user status. |
| secMrvId |
Number |
MRV's secondary user Id. |
| wasCompanySelected |
Boolean |
true |
| inOwnCompany |
Boolean |
true |
| canViewReports |
Boolean |
Whether logged-in user having view access of reports. |
| canScheduleReports |
Boolean |
Whether logged-in user having scheduling access of reports. |
| canViewPublicUserData |
Boolean |
Whether logged-in user having access to view public users information. |
| canViewMasterUserData |
Boolean |
Whether logged-in user having access to view master users information. |
| canViewTechnicalUserData |
Boolean |
Whether logged-in user having access to view technical users information. |
| canViewPrivateTechnicalUserData |
Boolean |
Whether logged-in user having access to view private technical users information. |
Samples Response - Success 200
{
"accessToken": "3iRAakaqnPCcOumEdn1dP5ckzJHR3tcJFHoRgrxTfeJ7a_1qo-QQml4cXpXkSkcG0fyKh3mi2meQGZFknoNMOg",
"userId": 100001,
"companyId": 100003,
"selectedCompanyId": 190001,
"companyType": "Private",
"companyTypeId": 601,
"userClassName": "Technical User",
"userClassId": 7,
"contact": "contact name",
"profileId": null,
"userType": null,
"companyName": "company name",
"companyScac": "scac code",
"companyUsDotNumber": "us dot number",
"userName": "username",
"firstName": "first name",
"middleName": "middle name",
"lastName": "last name",
"email": "user email address",
"phone": "user phone number",
"status": "user status",
"secMrvId": null,
"gierAdmin": false,
"wasCompanySelected": true,
"inOwnCompany": true,
"canViewReports": true,
"canScheduleReports": false,
"canViewPublicUserData": false,
"canViewMasterUserData": false,
"canViewTechnicalUserData": true,
"canViewPrivateTechnicalUserData": true
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<APIRESPONSE>
<CODE>4</CODE>
<TYPE>ok</TYPE>
<MESSAGE>Message with generated GIER Number</MESSAGE>
</APIRESPONSE>
Error 4xx/5xx
| Field | Type | Description |
|---|---|---|
| code |
Number |
Error code ( 1= error, 2 =warning, 3=info, 4 =ok) |
| type |
String |
Response type can be of error,warning, info, ok |
| message |
String |
- |
| details |
String |
- |
| apiReqErrors |
String |
errors: 1) transNum:= 1,2,3.... 2) errorCategory:= Validation Error/ Business Error/ Server Error. 3) errorMessage:= Specific Message based on errorCategory |
Samples Response - Error 4xx/500
{
"code": 1,
"type": "error",
"message": "",
"details": "",
"apiReqErrors": {
"errors": [
{
"transNum": 1,
"errorCategory": "Business Error(s)",
"errorMessage": "Invalid User Id or Password."
}
]
}
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<APIRESPONSE>
<CODE>1</CODE>
<TYPE>error</TYPE>
<MESSAGE></MESSAGE>
<APIREQERRORS>
<ERRORS>
<TRANSNUM>1</TRANSNUM>
<ERRORCATEGORY>Business Error(s)</ERRORCATEGORY>
<ERRORMESSAGE>GIER Pin is invalid.</ERRORMESSAGE>
</ERRORS>
</APIREQERRORS>
</APIRESPONSE>
post /rest/GIER/actionsOnPendingTOC
This API gives user an ability to Accept/Cancel pending chassis TOC by providing required parameters. Please see input parameters, sample request and response from below.
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| actionCd |
String |
M | Action code should be A(Accept) Or C(cancel) |
| tocDate |
String |
C | Transfer of control date(MM/dd/YYYY), mandatory for A(Accept) |
| tocTime |
String |
C | Transfer of control time(hh:mm), mandatory for A(Accept) |
| selectedIds |
String |
M | Transfer of control ids (if multiple, pass comma separated ids) |
| notes |
String |
C | Notes for TOC |
| accessToken |
String |
M | Unique Access Token Provided by IANA |
Request samples
{
"actionCd":"Action code",
"tocDate":"Transfer of control date",
"tocTime":"Transfer of control time",
"selectedIds":"Transfer of control pending ids",
"notes":"notes",
"accessToken":"Your Access Token"
}
Success 200
| Field | Type | Description |
|---|---|---|
| code |
Number |
Response code (4 =ok) |
| type |
String |
Response type can be of error,warning, info, ok |
| message |
String |
Specific Message about operation success with generated GIER Number. |
| details |
String |
- |
| apiReqErrors |
Object |
[] Object of type List |
Samples Response - Success 200
{
"code": 4,
"type": "ok",
"message": "1 of 1 Transfer of Control requests were updated.",
"details": "",
"apiReqErrors": {
"errors": []
}
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<APIRESPONSE>
<CODE>4</CODE>
<TYPE>ok</TYPE>
<MESSAGE>Message with generated GIER Number</MESSAGE>
</APIRESPONSE>
Error 4xx/5xx
| Field | Type | Description |
|---|---|---|
| code |
Number |
Error code ( 1= error, 2 =warning, 3=info, 4 =ok) |
| type |
String |
Response type can be of error,warning, info, ok |
| message |
String |
- |
| details |
String |
- |
| apiReqErrors |
String |
errors: 1) transNum:= 1,2,3.... 2) errorCategory:= Validation Error/ Business Error/ Server Error. 3) errorMessage:= Specific Message based on errorCategory |
Samples Response - Error 4xx/500
{
"code": 1,
"type": "error",
"message": "",
"details": "",
"apiReqErrors": {
"errors": [
{
"transNum": 1,
"errorCategory": "Business Error(s)",
"errorMessage": "We cannot process your request, Please send valid request"
}
]
}
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<APIRESPONSE>
<CODE>1</CODE>
<TYPE>error</TYPE>
<MESSAGE></MESSAGE>
<APIREQERRORS>
<ERRORS>
<TRANSNUM>1</TRANSNUM>
<ERRORCATEGORY>Business Error(s)</ERRORCATEGORY>
<ERRORMESSAGE>GIER Pin is invalid.</ERRORMESSAGE>
</ERRORS>
</APIREQERRORS>
</APIRESPONSE>
This API gives user an ability to fetch equipments owner, Current IEP and Previous IEP information. Please see input parameters, sample request and response from below.
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| accessToken |
String |
M | Unique Access Token Provided by IANA. |
| equipmentPrefix |
String [ 4 chars ] |
C | Equipment Prefix. NOTE: Search with below criteria 1) Equipment Prefix-Number Or 2) License Plate-State-Country |
| equipmentNumber |
Number [ 6 Digit ] |
C | Equipment Number. |
| licensePlate |
String |
C | License Plate. |
| licenseState |
String [ 2 char] |
C | License State. |
| licenseState |
String [ 2 chars ] |
C | License State. |
| licenseCountry |
String |
C | License Country Code(US, USA, CAN, CND, MX, MEX) |
Request samples
/rest/GIER/gierLookup.do?
accessToken=&equipmentPrefix=&equipmentNumber=&licensePlate=&licenseState=&
licenseCountry=
Success 200
| Field | Type | Description | |
|---|---|---|---|
| currentIEP | |||
| scac |
String |
Current IEP SCAC | |
| companyName |
String |
Current IEP Company Name | |
| usDOT |
String |
Current IEP US DOT Number | |
| inspectionDate |
String |
Current IEP Inspection Date | |
| equipmentType |
String |
Current IEP Equipment Type | |
| poolCode |
String |
Current IEP Pool Code | |
| type |
String |
Current IEP Type | |
| category |
String |
Current IEP Category | |
| previousIEP | |||
| scac |
String |
Previous IEP SCAC | |
| companyName |
String |
Previous IEP Company Name | |
| usDOT |
String |
Previous IEP US DOT Number | |
| tocDateTime |
String |
Previous IEP TOC Date-time | |
| contactName |
String |
Previous IEP Contact Name | |
| ownerIEP | |||
| scac |
String |
Owner IEP SCAC | |
| companyName |
String |
Owner IEP Company Name | |
| usDOT |
String |
Owner IEP US DOT Number | |
| vin |
String |
Owner IEP VIN | |
| licensePlate |
String |
Owner IEP License Plate | |
| licenseState |
String |
Owner IEP License State | |
| expiration |
String |
Owner IEP Expiration month/year | |
Samples Response - Success 200
{
"currentIEP": {
"scac": "currentIEP SCAC",
"companyName": "currentIEP Company Name",
"usDOT": "currentIEP US DOT",
"inspectionDate": "currentIEP Inspection Date",
"equipmentType": "currentIEP equipment Type",
"poolCode": "currentIEP pool Code",
"type": "currentIEP Type",
"category": "currentIEP Category"
},
"previousIEP": {
"scac": "previousIEP SCAC",
"companyName": "previousIEP Company Name",
"usDOT": "previousIEP US DOT",
"phone": "previousIEP Phone",
"tocDateTime": "previousIEP TOC Datetime",
"contactName": "previousIEP contact Name"
},
"ownerIEP": {
"scac": "ownerIEP SCAC",
"companyName": "ownerIEP Company Name",
"usDOT": "ownerIEP US DOT",
"vin": "ownerIEP VIN",
"licensePlate": "ownerIEP license plate",
"licenseState": "ownerIEP license state",
"expiration": "ownerIEP expiration month/year"
}
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<APIRESPONSE>
<GIERLOOKUP>
<CURRENT_IEP>
<SCAC>currentIEP SCAC</SCAC>
<COMPANY_NAME>currentIEP Company Name</COMPANY_NAME>
<USDOT>currentIEP US DOT</USDOT>
<INSPECTION_DATE>currentIEP Inspection Date</INSPECTION_DATE>
<EQUIPMENT_TYPE>currentIEP equipment Type</EQUIPMENT_TYPE>
<POOL_CODE>currentIEP pool Code</POOL_CODE>
<TYPE>currentIEP Type</TYPE>
<CATEGORY>currentIEP Category</CATEGORY>
</CURRENT_IEP>
<PREVIOUS_IEP>
<SCAC>previousIEP SCAC</SCAC>
<COMPANY_NAME>previousIEP Company Name</COMPANY_NAME>
<USDOT>previousIEP US DOT</USDOT>
<PHONE>previousIEP Phone</PHONE>
<TOC_DATETIME>previousIEP TOC Datetime</TOC_DATETIME>
<CONTACT_NAME>previousIEP contact Name</CONTACT_NAME>
</PREVIOUS_IEP>
<OWNER_IEP>
<SCAC>ownerIEP SCAC</SCAC>
<COMPANY_NAME>ownerIEP Company Name</COMPANY_NAME>
<USDOT>ownerIEP US DOT</USDOT>
<VIN>ownerIEP VIN</VIN>
<LICENSE_PLATE>ownerIEP license plate</LICENSE_PLATE>
<LICENSE_STATE>ownerIEP license state</LICENSE_STATE>
<EXPIRATION>ownerIEP expiration month/year</EXPIRATION>
</OWNER_IEP>
</GIERLOOKUP>
</APIRESPONSE>
Error 4xx/5xx
| Field | Type | Description |
|---|---|---|
| code |
Number |
Error code ( 1= error, 2 =warning, 3=info, 4 =ok) |
| type |
String |
Response type can be of error,warning, info, ok |
| message |
String |
- |
| details |
String |
- |
| apiReqErrors |
String |
error: 1) errorCategory:= Validation Error/ Business Error/ Server Error. 2) errorMessage:= Specific Message based on errorCategory |
Samples Response - Error 4xx/500
{
"code": 1,
"type": "error",
"message": "",
"apiReqErrors": {
"errors": [
{
"transNum": 1,
"errorCategory": "Validation Error(s)",
"errorMessage": "Equipment Initial/Prefix should not be blank"
}
]
}
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<APIRESPONSE>
<CODE>1</CODE>
<TYPE>error</TYPE>
<MESSAGE></MESSAGE>
<DETAILS></DETAILS>
<APIREQERRORS>
<ERRORS>
<TRANSNUM>1</TRANSNUM>
<ERRORCATEGORY>Validation Error(s)</ERRORCATEGORY>
<ERRORMESSAGE>Equipment Initial/Prefix should not be blank</ERRORMESSAGE>
</ERRORS>
</APIREQERRORS>
</APIRESPONSE>
get /rest/GIER/getTOCPendingList
This API gives user an ability to fetch list of pending toc information. Please see input parameters, sample request and response from below.
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| accessToken |
String [ 15 alphanumeric ] |
M | Unique Access Token Provided by IANA. |
| offset |
Number |
O | OFFSET.(Provide no. of page. e.g 1/2/3) |
| limit |
Number |
O | This field indicates no. of records per page. |
Request samples
/rest/GIER/getTOCPendingList?accessToken=&offset=&limit=
Success 200
| Field | Type | Description |
|---|---|---|
| tocPendingId |
Number |
ID of TOC Pending record |
| eqPrefix |
String |
Equipment Prefix |
| eqNumber |
String |
Equipment Number |
| combinedChassisId |
String |
Merging of eqPrefix + eqNumber |
| transferOfControlDtOnly |
String |
Date-time(MM/dd/yyyy HH:MM) of TOC transfer of control |
| currentUSDOTNumber |
String |
Current IEP USDOT Number/td> |
| currentCompanySCACcd |
String |
Current IEP Company SCAC code |
| newUSDOTNumber |
String |
New IEP USDOT Number |
| newCompanySCACcd |
String |
New IEP Company SCAC Code |
| chPoolName |
String |
This will be chassis pool id - chassis pool name |
| requestDtOnly |
String |
Requested date-time(MM/dd/yyyy HH:MM) |
| didCurrentIEPAgree |
String |
Whether current IEP agree or not(Yes/No) |
| didNewIEPAgree |
String |
Whether new IEP agree or not(Yes/No) |
| isRejectedOrAccepted |
String |
This indicates (empty/Accepted/Rejected/T&C pending/Canceled) |
| rejectedAcceptedDatetime |
String |
This indicates date-time(MM/dd/yyyy HH:MM) of Accepted/Rejected Transfer of control |
| size |
Number |
Indicates limit per page |
| totalElements |
Number |
Indicates total no. of records count |
| totalPages |
Number |
Indicates total pages count |
| currentPage |
Number |
Indicates Current page count |
Samples Response - Success 200
{
"resultList": [
{
"tocPendingId": "Toc Pending Id",
"eqPrefix": "eqPrefix",
"eqNumber": "eqNumber",
"combinedChassisId": "eqPrefix + eqNumber",
"transferOfControlDtOnly": "date-time",
"currentUSDOTNumber": " current usdot number",
"currentCompanySCACcd": "Current IEP Company SCAC Code",
"newUSDOTNumber": "New USDOT Number",
"newCompanySCACcd": "New IEP Company SCAC Code",
"chPoolName": "Chassis Pool ID - Chassis Pool Name",
"requestDtOnly": "Date-time",
"didCurrentIEPAgree": "Yes/No",
"didNewIEPAgree": "Yes/No",
"isRejectedOrAccepted": "Accepted/Rejected",
"rejectedAcceptedDatetime": "Date-time"
}
],
"page": {
"size": 10,
"totalElements": 3,
"totalPages": 1,
"currentPage": 1
}
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<APIRESPONSE>
<GIERLOOKUP>
<CURRENT_IEP>
<SCAC>currentIEP SCAC</SCAC>
<COMPANY_NAME>currentIEP Company Name</COMPANY_NAME>
<USDOT>currentIEP US DOT</USDOT>
<INSPECTION_DATE>currentIEP Inspection Date</INSPECTION_DATE>
<EQUIPMENT_TYPE>currentIEP equipment Type</EQUIPMENT_TYPE>
<POOL_CODE>currentIEP pool Code</POOL_CODE>
<TYPE>currentIEP Type</TYPE>
<CATEGORY>currentIEP Category</CATEGORY>
</CURRENT_IEP>
<PREVIOUS_IEP>
<SCAC>previousIEP SCAC</SCAC>
<COMPANY_NAME>previousIEP Company Name</COMPANY_NAME>
<USDOT>previousIEP US DOT</USDOT>
<PHONE>previousIEP Phone</PHONE>
<TOC_DATETIME>previousIEP TOC Datetime</TOC_DATETIME>
<CONTACT_NAME>previousIEP contact Name</CONTACT_NAME>
</PREVIOUS_IEP>
<OWNER_IEP>
<SCAC>ownerIEP SCAC</SCAC>
<COMPANY_NAME>ownerIEP Company Name</COMPANY_NAME>
<USDOT>ownerIEP US DOT</USDOT>
<VIN>ownerIEP VIN</VIN>
<LICENSE_PLATE>ownerIEP license plate</LICENSE_PLATE>
<LICENSE_STATE>ownerIEP license state</LICENSE_STATE>
<EXPIRATION>ownerIEP expiration month/year</EXPIRATION>
</OWNER_IEP>
</GIERLOOKUP>
</APIRESPONSE>
Error 4xx/5xx
| Field | Type | Description |
|---|---|---|
| code |
Number |
Error code ( 1= error, 2 =warning, 3=info, 4 =ok) |
| type |
String |
Response type can be of error,warning, info, ok |
| message |
String |
- |
| details |
String |
- |
| apiReqErrors |
String |
error: 1) errorCategory:= Validation Error/ Business Error/ Server Error. 2) errorMessage:= Specific Message based on errorCategory |
Samples Response - Error 4xx/500
{
"code": 1,
"type": "error",
"message": "",
"details": "",
"apiReqErrors": {
"errors": [
{
"transNum": 1,
"errorCategory": "Business Error(s)",
"errorMessage": "No Records Found"
}
]
}
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<APIRESPONSE>
<CODE>1</CODE>
<TYPE>error</TYPE>
<MESSAGE></MESSAGE>
<DETAILS></DETAILS>
<APIREQERRORS>
<ERRORS>
<TRANSNUM>1</TRANSNUM>
<ERRORCATEGORY>Validation Error(s)</ERRORCATEGORY>
<ERRORMESSAGE>Equipment Initial/Prefix should not be blank</ERRORMESSAGE>
</ERRORS>
</APIREQERRORS>
</APIRESPONSE>
Overview
This API gives user an ability to process the SIA details and return SIA Number. Please see input parameters, sample request and response from below This API gives user an ability to process the SIA details and return SIA Number. Please see input parameters, sample request and response from below
MC Login
post rest/SIA/siaLogin
This API gives user an ability to verify the login details and return token to access other APIs. Please see input parameters, sample request and response from below
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| scac |
String [ 4 chars ] |
M | MC Scac Code |
| password |
String [ 15 alphanumeric ] |
M | Password |
| role |
String |
M | Type of user role , Use MC For Motor Carrier |
Request samples
{
"scac":"SCAC Code",
"password":"Password",
"role":"User Role"
}
Success 200
| Field | Type | Description |
|---|---|---|
| uiiaAcctNo |
String |
User Account Number |
| scac |
String |
User SCAC code |
| firstName |
String |
User First Name |
| companyName |
String |
Company Name |
|
String |
User Email Address | |
| tpuCompanyName |
String |
Third Pary User Company Name |
| userName |
String |
User Name |
| roleName |
String |
Role |
| sipId |
Number |
User ID |
| status |
String |
Status |
| memType |
String |
Define User Type, Primary or Secondary |
| iddPin |
Number |
Driver Pin |
| drvLicenseNo |
String |
Driver Locense No |
| drvLicenseState |
String |
Driver Locense State |
| ipAddress |
String |
IP Address |
| accessToken |
String |
LoggedIn User AccessToken. |
| configDetailsSetFlag |
Boolean |
Configuration Flag |
| permissions |
String |
User Permissions |
| lname |
String |
User Last Name |
| mname |
String |
User Middle Name |
| fname |
String |
User First Name |
Samples Response - Success 200
{
"uiiaAcctNo": "Account Number",
"scac": "SCAC",
"companyName": "Company Name",
"tpuCompanyName": "Third Party Company Name",
"userName": "User Name",
"roleName": "User Role",
"sipId": "User Id",
"status": "User Status",
"memType": "Member Type",
"iddPin": "Driver Pin",
"drvLicenseNo": "Driver License Number",
"drvLicenseState": "Driver License State",
"ipAddress": "IP Address",
"accessToken": "Access Token",
"configDetailsSetFlag": "Configuration Flag",
"permissions": "User Permissions",
"lname": "User Last Name",
"mname": "User Middle Name",
"fname": "User First Name"
}
Error 4xx/5xx
| Field | Type | Description |
|---|---|---|
| code |
Number |
Error code ( 1= error, 2 =warning, 3=info, 4 =ok) |
| type |
String |
Response type can be of error,warning, info, ok |
| message |
String |
- |
| details |
String |
- |
| apiReqErrors |
String |
error: 1) errorCategory:= Validation Error/ Business Error/ Server Error. 2) errorMessage:= Specific Message based on errorCategory |
Samples Response - Error 4xx/500
{
"code": 1,
"type": "error",
"message": "",
"details": "",
"apiReqErrors": {
"errors": [
{
"transNum": 1,
"errorCategory": "Business Error(s)",
"errorMessage": "The UserName or Password you entered is incorrect."
}
]
}
}
Action
post rest/SI/siAction.do
This API gives EP an ability to APPROVE, REJECT AND CANCEL interchange or street turn request by providing given below required parameters. Please see input parameters, sample request and response from below.
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| contNum |
String |
M | Container Number should be alpha-numeric |
| siRequestId |
String [ 12 chars ] |
M | Street Interchange Request Id |
| reason |
String |
O | Reason is required only when Request Type is REJECT |
| requestType |
String |
M | Request Type can be either APPROVE, REJECT or CANCEL (case insensitive) |
| accessToken |
String [ 15 alphanumeric ] |
M | Unique Access Token Provided by IANA. |
Request samples
{
"contNum": "Provide Container Number",
"siRequestId": "Provide Request ID",
"reason": "Provide Reason",
"requestType": "Provide Request Type",
"accessToken": "Your Access Token"
}
Success 200
| Field | Type | Description |
|---|---|---|
| code |
Number |
Response code (4 =ok) |
| type |
String |
Response type can be of error,warning, info, ok |
| message |
String |
Specific Message about operation success. |
Samples Response - Success 200
{
"code": 4,
"type": "ok",
"message": "Your request for approve interchange request successfully processed"
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<APIRESPONSE>
<CODE>4</CODE>
<TYPE>ok</TYPE>
<MESSAGE>Your request for approve interchange request successfully processed</MESSAGE>
</APIRESPONSE>
Error 4xx/5xx
| Field | Type | Description |
|---|---|---|
| code |
Number |
Error code ( 1= error, 2 =warning, 3=info, 4 =ok) |
| type |
String |
Response type can be of error,warning, info, ok |
| message |
String |
- |
| apiReqErrors |
String |
error: 1) errorCategory:= Validation Error/ Business Error/ Server Error. 2) errorMessage:= Specific Message based on errorCategory |
Samples Response - Error 4xx/500
{
"code": 1,
"type": "error",
"message": "",
"apiReqErrors": {
"errors": [
{
"transNum": 1,
"errorCategory": "Business Error(s)",
"errorMessage": "You are not allowed to perform this operation"
}
]
}
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<APIRESPONSE>
<CODE>1</CODE>
<TYPE>error</TYPE>
<MESSAGE></MESSAGE>
<APIREQERRORS>
<ERRORS>
<TRANSNUM>1</TRANSNUM>
<ERRORCATEGORY>Business Error(s)</ERRORCATEGORY>
<ERRORMESSAGE>You are not allowed to perform this operation</ERRORMESSAGE>
</ERRORS>
</APIREQERRORS>
</APIRESPONSE>
IR Request
post /rest/SI/createIRRequest.do
This API gives subscriber an ability to submit Street Interchange Request into SIA by providing required parameters. Please send request with below input parameters.
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| epScac |
String [ 2-4 chars ] |
M | Equipment/Box Provider's SCAC. |
| mcAScac |
String [ 4 chars ] |
M | Motor Carrier A's SCAC. |
| mcBScac |
String [ 4 chars ] |
M | Motor Carrier B's SCAC. |
| intchgType |
String [ 4 chars ] |
M | Interchange request Type. Valid Interchange request types are LOAD/LOAD, LOAD/EMPTY and EMPTY/LOAD. |
| contNum |
String |
M | Container Number. |
| contType |
String |
M | Container Type |
| contSize |
String |
M | Container Size |
| chassisNum |
String |
O | Chassis Number(By default "ZZZZ999999") |
| chassisType |
String |
C | Chassis Type |
| chassisSize |
String |
C | Chassis Size |
| importBookingNum |
String |
O | Import Booking Number |
| bookingNum |
String |
M | Booking Number |
| gensetNum |
String |
O | Genset Number |
| equipLocNm |
String |
M | Equipment Location IANA Code or SPLC Code |
| originLocNm |
String |
M | Originating Location IANA Code or SPLC Code |
|
String |
O | This Email field is for IDD users only | |
| irRequestType |
String |
M | IRRequestType "StreetInterchange" is fixed as an input value |
| accessToken |
String [ 15 alphanumeric ] |
M | Unique Access Token Provided by IANA. |
Request samples
{
"epScacs":"Provide EP SCAC", "mcAScac":"Provide
MC A SCAC", "mcBScac":"Provide MC B SCAC",
"intchgType":"Provide Interchange Request Type",
"contNum":"Provide Container Number",
"contSize":"Provide Container Size",
"contType":"Provide Container Type",
"chassisNum":"Provide Chassis Number",
"chassisType":"Provide Chassis Type",
"chassisSize":"Provide Chassis Size",
"importBookingNum":"Provide Import Booking Number",
"bookingNum":"Provide Booking Number",
"gensetNum":"Provide Genset Number",
"equipLocNm":"Provide Equipment Location",
"originLocNm":"Provide Originating Location",
"email": "Provide Email address",
"irRequestType": "Provide StreetInterchange value",
"accessToken":"Your Access Token"
}
Success 200
| Field | Type | Description |
|---|---|---|
| code |
Number |
Response code (4 =ok) |
| type |
String |
Response type can be of error,warning, info, ok |
| message |
String |
Specific Message about operation success. |
Samples Response - Success 200
{
"code": 4,
"type": "ok",
"message": "SUCCESS"
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<APIRESPONSE>
<CODE>4</CODE>
<TYPE>ok</TYPE>
<MESSAGE>SUCCESS</MESSAGE>
</APIRESPONSE>
Error 4xx/5xx
| Field | Type | Description |
|---|---|---|
| code |
Number |
Error code ( 1= error, 2 =warning, 3=info, 4 =ok) |
| type |
String |
Response type can be of error,warning, info, ok |
| message |
String |
- |
| apiReqErrors |
String |
error: 1) errorCategory:= Validation Error/ Business Error/ Server Error. 2) errorMessage:= Specific Message based on errorCategory |
Samples Response - Error 4xx/500
{
"code": 1,
"type": "error",
"message": "",
"apiReqErrors": {
"errors": [
{
"transNum": 1,
"errorCategory": "Validation Error(s)",
"errorMessage": "Motor Carrier A's SCAC should be 4 alphabets"
}
]
}
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<APIRESPONSE>
<CODE>1</CODE>
<TYPE>error</TYPE>
<MESSAGE></MESSAGE>
<APIREQERRORS>
<ERRORS>
<TRANSNUM>1</TRANSNUM>
<ERRORCATEGORY>Validation Error(s)</ERRORCATEGORY>
<ERRORMESSAGE>Motor Carrier A's SCAC should be 4 alphabets</ERRORMESSAGE>
</ERRORS>
</APIREQERRORS>
</APIRESPONSE>
ST Request
post /rest/SI/createIRRequest.do
This API gives subscriber an ability to submit Street Turn Request into SIA by providing required parameters. Please send request with below input parameters.
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| epScac |
String [ 2-4 chars ] |
M | Equipment/Box Provider's SCAC. |
| mcAScac |
String [ 4 chars ] |
M | Motor Carrier A's SCAC. |
| importBookingNum |
String |
O | Import Booking Number |
| bookingNum |
String |
M | Booking Number |
| contNum |
String |
M | Container Number. |
| chassisNum |
String |
O | Chassis Number(By default "ZZZZ999999") |
| originLocNm |
String |
M | Originating Location IANA Code or SPLC Code |
|
String |
O | This Email field is for IDD users only | |
| irRequestType |
String |
M | IRRequestType "StreetTurn" is fixed as an input value |
| accessToken |
String [ 15 alphanumeric ] |
M | Unique Access Token Provided by IANA. |
Request samples
{
"epScacs":"Provide EP SCAC",
"mcAScac":"Provide MC A SCAC",
"importBookingNum":"Provide Import Booking Number",
"bookingNum":"Provide Booking Number",
"contNum":"Provide Container Number",
"chassisNum":"Provide Chassis Number",
"originLocNm":"Provide Originating Location",
"irRequestType": "Provide StreetTurn value",
"email": "Provide email address",
"accessToken":"Your Access Token"
}
Success 200
| Field | Type | Description |
|---|---|---|
| code |
Number |
Response code (4 =ok) |
| type |
String |
Response type can be of error,warning, info, ok |
| message |
String |
Specific Message about operation success. |
Samples Response - Success 200
{
"code": 4,
"type": "ok",
"message": "SUCCESS"
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<APIRESPONSE>
<CODE>4</CODE>
<TYPE>ok</TYPE>
<MESSAGE>SUCCESS</MESSAGE>
</APIRESPONSE>
Error 4xx/5xx
| Field | Type | Description |
|---|---|---|
| code |
Number |
Error code ( 1= error, 2 =warning, 3=info, 4 =ok) |
| type |
String |
Response type can be of error,warning, info, ok |
| message |
String |
- |
| apiReqErrors |
String |
error: 1) errorCategory:= Validation Error/ Business Error/ Server Error. 2) errorMessage:= Specific Message based on errorCategory |
Samples Response - Error 4xx/500
{
"code": 1,
"type": "error",
"message": "",
"apiReqErrors": {
"errors": [
{
"transNum": 1,
"errorCategory": "Validation Error(s)",
"errorMessage": "Motor Carrier A's SCAC should be 4 alphabets"
}
]
}
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<APIRESPONSE>
<CODE>1</CODE>
<TYPE>error</TYPE>
<MESSAGE></MESSAGE>
<APIREQERRORS>
<ERRORS>
<TRANSNUM>1</TRANSNUM>
<ERRORCATEGORY>Validation Error(s)</ERRORCATEGORY>
<ERRORMESSAGE>Motor Carrier A's SCAC should be 4 alphabets</ERRORMESSAGE>
</ERRORS>
</APIREQERRORS>
</APIRESPONSE>
Lookup
This API gives user an ability to search street interchange request by providing required parameters. Please see input parameters, sample request and response from below.
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| siRequestId |
String [ 12 chars ] |
O | SI Request ID Like SI-XXXXXXXXX Where X: Numeric Value |
| importBL |
String |
O | Import Bill Of Lading |
| exportBookingNum |
String |
O | Export Booking Number |
| containerNum |
String |
O | Container Number |
| chassisNum |
String |
O | Chassis Number |
| accessToken |
String [ 15 alphanumeric ] |
M | Unique Access Token Provided by IANA. |
Request samples
/rest/SI/siLookup.do?accessToken=&exportBookingNum=&importBL=&containerNum=
&chassisNum=&siRequestId=
Success 200
| Field | Type | Description |
|---|---|---|
| siRequestId |
String [ 12 chars ] |
SI Request ID associated with this record |
| exportBookingNum |
String |
Export Booking Number |
| importBL |
String |
Import Bill Of Lading |
| containerNum |
String |
Container Number |
| chassisNum |
String |
Chassis Number |
| epScac |
String [ 2-4 chars ] |
Equipment Provider SCAC |
| mcaScac |
String [ 4 chars ] |
Motor Carrier A SCAC |
| mcbScac |
String [ 4 chars ] |
Motor Carrier B SCAC |
| iepScac |
String |
Intermodal Equipment Provider SCAC if present |
| originIntchgLocName |
String |
Origin Interchange Location Name |
| originIntchgLocState |
String [ 2 chars ] |
Origin Interchange Location State |
| originIntchgLocZip |
String |
Origin Interchange Location Zip |
| status |
String |
Interchange Request Current Status |
| lastUpdated |
String |
Interchange Request Last Updated Date & time |
Samples Response - Success 200
[
{
"siRequestId": "SI-000000189",
"exportBookingNum": "EXP001",
"importBL": "IBN001",
"containerNum": "CONT001",
"chassisNum": "APLZ10001",
"epScac": "APLU",
"mcaScac": "CPGP",
"mcbScac": "FBPE",
"iepScac": "IEP NOT FOUND IN GIER",
"originIntchgLocName": "APL DUTCH HARBOR",
"originIntchgLocState": "AK",
"originIntchgLocZip": "99692",
"status": "CANCELLED",
"lastUpdated": "01/12/2017 18:46:16"
},
{
"siRequestId": "SI-000000188",
"exportBookingNum": "EXP001",
"importBL": "IBN001",
"containerNum": "CONT001",
"chassisNum": "APLZ10001",
"epScac": "APLU",
"mcaScac": "CPGP",
"mcbScac": "FBPE",
"iepScac": "IEP NOT FOUND IN GIER",
"originIntchgLocName": "APL DUTCH HARBOR",
"originIntchgLocState": "AK",
"originIntchgLocZip": "99692",
"status": "REJECTED",
"lastUpdated": "02/01/2017 16:10:04"
}
]
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<APIRESPONSE>
<SILOOKUP>
<SI_REQUEST_ID>SI-000000189</SI_REQUEST_ID>
<EXPORT_BOOKING_NUM>EXP001</EXPORT_BOOKING_NUM>
<IMPORT_BL>IBN001</IMPORT_BL>
<CONTAINER_NUM>CONT001</CONTAINER_NUM>
<CHASSIS_NUM>APLZ10001</CHASSIS_NUM>
<EP_SCAC>APLU</EP_SCAC>
<MCA_SCAC>CPGP</MCA_SCAC>
<MCB_SCAC>FBPE</MCB_SCAC>
<IEP_SCAC>IEP NOT FOUND IN GIER</IEP_SCAC>
<ORIGIN_INTCHG_LOC_NAME>APL DUTCH HARBOR</ORIGIN_INTCHG_LOC_NAME>
<ORIGIN_INTCHG_LOC_STATE>AK</ORIGIN_INTCHG_LOC_STATE>
<ORIGIN_INTCHG_LOC_ZIP>99692</ORIGIN_INTCHG_LOC_ZIP>
<STATUS>CANCELLED</STATUS>
<LAST_UPDATED>01/12/2017 18:46:16</LAST_UPDATED>
</SILOOKUP>
<SILOOKUP>
<SI_REQUEST_ID>SI-000000188</SI_REQUEST_ID>
<EXPORT_BOOKING_NUM>EXP001</EXPORT_BOOKING_NUM>
<IMPORT_BL>IBN001</IMPORT_BL>
<CONTAINER_NUM>CONT001</CONTAINER_NUM>
<CHASSIS_NUM>APLZ10001</CHASSIS_NUM>
<EP_SCAC>APLU</EP_SCAC>
<MCA_SCAC>CPGP</MCA_SCAC>
<MCB_SCAC>FBPE</MCB_SCAC>
<IEP_SCAC>IEP NOT FOUND IN GIER</IEP_SCAC>
<ORIGIN_INTCHG_LOC_NAME>APL DUTCH HARBOR</ORIGIN_INTCHG_LOC_NAME>
<ORIGIN_INTCHG_LOC_STATE>AK</ORIGIN_INTCHG_LOC_STATE>
<ORIGIN_INTCHG_LOC_ZIP>99692</ORIGIN_INTCHG_LOC_ZIP>
<STATUS>REJECTED</STATUS>
<LAST_UPDATED>02/01/2017 16:10:04</LAST_UPDATED>
</SILOOKUP>
</APIRESPONSE>
Error 4xx/5xx
| Field | Type | Description |
|---|---|---|
| code |
Number |
Error code ( 1= error, 2 =warning, 3=info, 4 =ok) |
| type |
String |
Response type can be of error,warning, info, ok |
| message |
String |
- |
| apiReqErrors |
String |
error: 1) errorCategory:= Validation Error/ Business Error/ Server Error. 2) errorMessage:= Specific Message based on errorCategory |
Samples Response - Error 4xx/500
{
"code": 1,
"type": "error",
"message": "",
"apiReqErrors": {
"errors": [
{
"transNum": 1,
"errorCategory": "Business Error(s)",
"errorMessage": "No Records Found"
}
]
}
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<APIRESPONSE>
<CODE>1</CODE>
<TYPE>error</TYPE>
<MESSAGE></MESSAGE>
<APIREQERRORS>
<ERRORS>
<TRANSNUM>1</TRANSNUM>
<ERRORCATEGORY>Business Error(s)</ERRORCATEGORY>
<ERRORMESSAGE>No Records Found</ERRORMESSAGE>
</ERRORS>
</APIREQERRORS>
</APIRESPONSE>
Overview
This API gives user an ability to process the UIIA details and return UIIA Number. Please see input parameters, sample request and response from below This API gives user an ability to process the UIIA details and return UIIA Number. Please see input parameters, sample request and response from below
Login
post /auth
This API gives user an ability to verify the login details and return token to access other APIs. Please see input parameters, sample request and response from below
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| clientId |
String |
M | Client ID |
| clientSecret |
String |
M | Client Secret |
Request samples
{
"clientId": "Client ID",
"clientSecret": "Clent Secret"
}
Success 200
| Field | Type | Description |
|---|---|---|
| token_type |
String |
Type of Token |
| expires_in |
Number |
Token Expire Time |
| ext_expires_in |
Number |
Ext Expire Time |
| access_token |
String |
Access Token |
Samples Response - Success 200
{
"token_type": "Token Type",
"expires_in": "Time",
"ext_expires_in": "Time",
"access_token": "Access Token"
}
Error 4xx/5xx
| Field | Type | Description |
|---|---|---|
| code |
Number |
Error code ( 1= error, 2 =warning, 3=info, 4 =ok) |
| type |
String |
Response type can be of error,warning, info, ok |
| errorCategory |
String |
Validation Error/ Business Error/ Server Error. |
| errorMessage |
String |
Specific Message about error/exception or validation. |
Samples Response - Error 4xx/500
{
"code": 1,
"type": "error",
"errorCategory": "Validation Error(s)",
"errorMessage": "Please provide the valid credentials."
}
Create Web Query
This API gives user an ability to create web query
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| AN |
String [ 50 alphanumeric ] |
M | Username |
| PS |
String [ 150 alphanumeric ] |
M | Password |
| UN |
String [ 50 alphanumeric ] |
O | Secondary user's Username. |
| DRILIC |
String[ 50 alphanumeric ] |
O | Driver's License. |
| EPSCAC |
String [ 2-4 alphanumeric ] |
M | Equipment/Box Provider's SCAC. |
| MCSCAC |
String [ 4 alphanumeric ] |
M | Motor Carrier's SCAC |
Request samples
/rest/createwebquery.do?AN=username&PS=password&EPSCAC=epscac&MCSCAC=mcscac
Success 200
| Field | Type | Description |
|---|---|---|
| STATUS-TIMESTAMP |
Number [ 14 ] |
Current Time Stamp Details. |
| STATUS-ERROR |
Character |
1- Login OK 2- Login Not Valid 3- REST Interface Not Allowed 4- Specific Service Not Available |
| STATUS-DESC |
String[ 100 alphanumeric ] |
Login Authentication Result |
| EP-SCAC |
String[ 2-4 alphanumeric ] |
Equipment/Box Provider's SCAC. |
| EP-FOUND |
Character |
FOUND |
| EP-AVAILABLE |
Character |
AVAILABLE |
| EP-CMPY_NAME |
String [ 100 alphanumeric ] |
Equipment/Box Provider's Company Name |
| EP-VALID_UIIA |
Character |
EP valid in UIIA? |
| MC-SCAC |
String [ 4 alphanumeric ] |
Motor Carrier's SCAC. |
| MC-FOUND |
Character |
FOUND |
| MC-CMPY_NAME |
String [ 100 alphanumeric ] |
Motor Carrier's Company Name | MC-VALID_UIIA |
Character |
MC valid in UIIA? | MC-VALID_EP_MC |
Character |
EP MC STATUS VALIDATION | MC-TRANZ_CODE |
String [ 7 alphanumeric ] |
TRANZ_CODE | MC-CONTACT-NAME |
String [ 225 alphanumeric ] |
Contact Name | MC-CONTACT-ADR1 |
String [ 100 alphanumeric ] |
Contact Address Details | MC-CONTACT-CITY |
String [ 100 alphanumeric ] |
City | MC-CONTACT-STATE |
String [ 100 alphanumeric ] |
State | MC-CONTACT-ZIP |
String [ 10 alphanumeric ] |
ADDR_ZIP |
| MC-CONTACT-PHONE |
String [ 20 alphanumeric ] |
PHONE |
| MC-CONTACT-FAX |
String [ 20 alphanumeric ] |
FAX |
| MC-POLICY_EXP-AUTO |
Number [ 8 ] |
Auto Policy Expiry Date |
| MC-POLICY_EXP-GENERAL |
Number [ 8 ] |
General Policy Expiry Date |
| MC-POLICY_EXP-CARGO |
Number [ 8 ] |
Cargo Policy Expiry Date |
| MC-POLICY_EXP-TRAILER |
Number [ 8 ] |
Trailer Interchange Policy Expiry Date |
Samples Response - Success 200
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<RESPONSE>
<TIMESTAMP>20160728181751</TIMESTAMP>
<DESC>Login OK</DESC>
<EP>
<FOUND>T</FOUND>
<CMPY_NAME>Yangming Marine Transport</CMPY_NAME>
</EP>
<SCAC>TOPD</SCAC>
<CMPY_NAME>Topline Transportation,Inc.</CMPY_NAME>
<VALID_EP_MC>T</VALID_EP_MC>
<CONTACT>
<ADR1>3930-b River Road</ADR1>
<STATE>NC</STATE>
<PHONE>(910)793-7511</PHONE>
</CONTACT>
<AUTO>20150607</AUTO>
<CARGO>20150607</CARGO>
</POLICY_EXP>
</RESPONSE>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<STATUS>
<ERROR>0</ERROR>
</STATUS>
<SCAC>YMLU</SCAC>
<AVAILABLE>T</AVAILABLE>
<VALID_UIIA>T</VALID_UIIA>
<MC>
<FOUND>T</FOUND>
<VALID_UIIA>T</VALID_UIIA>
<TRANZ_CODE>JYF4JIT</TRANZ_CODE>
<NAME>Michael Lanier</NAME>
<CITY>Wilmington</CITY>
<ZIP>28412-0900</ZIP>
<FAX>(301)982-3414</FAX>
<POLICY_EXP>
<GENERAL>20150607</GENERAL>
<TRAILER>20150607</TRAILER>
</POLICY_EXP>
</MC>
</RESPONSE>
Error 4xx/5xx
| Field | Type | Description |
|---|---|---|
| code |
Number |
Error code ( 1= error, 2 =warning, 3=info, 4 =ok) |
| type |
String |
Response type can be of error,warning, info, ok |
| message |
String |
Specific Message about error/exception or validation. |
Samples Response - Error 4xx/500
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<APIRESPONSE>
<CODE>1</CODE>
<TYPE>error</TYPE>
<MESSAGE>We cannot process your request, Please send a valid request.</MESSAGE>
</APIRESPONSE>
IDD Lookup
This API gives user an ability to fetch Driver's information from IDD. Please see input parameters, sample request and response from below.
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| accessToken |
String [ 15 alphanumeric ] |
M | Unique Access Token Provided by IANA. |
| driverLicenseNo |
String |
C | Driver License No. |
| licenseState |
String [ 2 chars ] |
C | License State. |
| iddPin |
Number |
C | IDD Driver PIN |
| mcSCAC |
String [ 4 chars) ] |
M | Motor Carrier's SCAC |
**You can provide Driver's license number & license state of issuance or IDD pin to look up the driver.
Access Token Will be provided by IANA after signing up as authorized web services subscriber
Request samples
{
"accessToken": "Your Access Token",
"driverLicenseNo": "Provide driver License No",
"licenseState": "Provide license State",
"iddPin": "Provide driver PIN",
"mcSCAC": "Provide MC SCAC"
}
Success 200
| Field | Type | Description |
|---|---|---|
| firstName |
String |
First Name |
| lastName |
String |
Last Name |
| driverLicenseNo |
String |
Driver License No |
| licenseState |
String |
License State |
| licenseExpiryDate |
String |
License Expiry Date |
| status |
String |
Status |
| mcSCAC |
String |
Motor Carrier's SCAC |
| iddPin |
String |
IDD Driver PIN |
Samples Response - Success 200
[
{
"firstName": "First Name",
"lastName": "Last Name",
"driverLicenseNo": "Driver License No",
"licenseState": "License State",
"licenseExpiryDate": "License Expiry Date",
"status": "Status",
"mcSCAC": "Motor Carrier SCAC",
"iddPin": "IDD PIN"
}
]
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<APIRESPONSE>
<IDDDRIVERS>
<IDDDRIVER>
<FIRSTNAME>First Name</FIRSTNAME>
<LASTNAME>Last Name</LASTNAME>
<LICENSENUMBER>License No</LICENSENUMBER>
<LICENSESTATE>License State</LICENSESTATE>
<LICENSE_EXPIRYDATE>License Expiry Date</LICENSE_EXPIRYDATE>
<STATUS>Status</STATUS>
<MCSCAC>Motor Carrier SCAC</MCSCAC>
<IDDPIN>IDD PIN</IDDPIN>
</IDDDRIVER>
</IDDDRIVERS>
</APIRESPONSE>
Error 4xx/5xx
| Field | Type | Description |
|---|---|---|
| code |
Number |
Error code ( 1= error, 2 =warning, 3=info, 4 =ok) |
| type |
String |
Response type can be of error,warning, info, ok |
| message |
String |
Specific Message about error/exception or validation. |
| apiReqErrors |
String |
error: 1) errorCategory:= Validation Error/ Business Error/ Server Error. 2) errorMessage:= Specific Message based on errorCategory. |
Samples Response - Error 4xx/500
{
"code": 1,
"type": "error",
"message": "",
"apiReqErrors": {
"errors": [
{
"transNum": 1,
"errorCategory": "Business Error(s)",
"errorMessage": "Motor Carrier's SCAC doesn't exist in our System."
}
]
}
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<APIRESPONSE>
<CODE>1</CODE>
<TYPE>error</TYPE>
<MESSAGE></MESSAGE>
<APIREQERRORS>
<ERRORS>
<TRANSNUM>1</TRANSNUM>
<ERRORCATEGORY>Business Error(s)</ERRORCATEGORY>
<ERRORMESSAGE>Motor Carrier's SCAC doesn't exist in our System.</ERRORMESSAGE>
</ERRORS>
</APIREQERRORS>
</APIRESPONSE>
