GET api/edi/refreshtoken

Refresh the login token

Request Information

URI Parameters

None.

Body Parameters

None.

Request Validation Notes

None.

Response Information

Resource Description

LoginResponse
NameDescriptionTypeAdditional information
AccessToken

Authorization token. This value needs to be passed in the Authorization HTTP header in the format: Bearerauthorization token. e.g. Bearer eyJhbGciOiJIUz...

string

None.

RefreshToken

RefreshToken api can be called when access token expired to get a new access token

  • Credentials not required again, just refresh token
  • Refresh token is valid for 90 days after last use(sliding window)

Note: Use of the refresh token is completely optional. It is intended for consumers like web applications that want to support the Remember Me model. An alternative to calling Refresh Token when the access token expires is to call the Login API again.

string

See See GET api/oversight/RefreshToken

TemperatureUnits

Temperature Units: C or F (°Celsius or °Fahrenheit)

string

None.

DistanceUnits

Distance Units: K or M (Kilometers or Miles)

string

None.

DateFormatEnum

Date Format: 1 (MM/dd/yyyy) or 2 (dd/MM/yyyy)

integer

None.

DateFormatString

Date Format: "MM/dd/yyyy" (1) or "dd/MM/yyyy" (2)

string

None.

IsEmersonAdmin

True if logged in user is an Emerson Administrator

boolean

None.

CanCreateShipment

True if logged in user is has permission to create/edit shipments

boolean

None.

ErrorCode

Error code

integer

ErrorDescription

Error details for the developer (English)

string

LocalizedErrorMessage

Error description for the user (Returned in the language specified by the Accept-Language HTTP header)

string

Response Formats

application/json

Sample:

Sample not available.