POST api/authorization
Use this method to get security authorization to use the Open API. The auth field in the response is required on all calls to the web API methods.
Request Information
URI Parameters
None.
Body Parameters
AuthorizationParmName | Description | Type | Additional information |
---|---|---|---|
LogonName |
The logon name (user) requesting authorization |
string |
None. |
Password |
The Password of the user |
string |
None. |
Request Formats
application/json, text/json
{ "LogonName": "sample string 1", "Password": "sample string 2" }
application/xml, text/xml
<AuthorizationParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Shipper.Models"> <LogonName>sample string 1</LogonName> <Password>sample string 2</Password> </AuthorizationParm>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
AuthorizationRespName | Description | Type | Additional information |
---|---|---|---|
IsSuccessful |
Used to determine if method call was successful (true) or failure (false) |
boolean |
None. |
ErrorMessage |
The error message if method call was not successful |
string |
None. |
auth |
The authorization token used to pass to API method calls |
string |
None. |
UserID |
The user identifier number |
integer |
None. |
UserGUID |
The user global identifier |
string |
None. |
LogonName |
The logon name (user) |
string |
None. |
FirstName |
The first name of the user |
string |
None. |
LastName |
The last name of the user |
string |
None. |
EmailAddress |
The email address of the user |
string |
None. |
PhoneNumber |
The phone number of user |
string |
None. |
CountryID |
The home country of the user |
string |
None. |
CurrencyID |
The currency of the user |
string |
None. |
CompanyID |
The user company identifier |
integer |
None. |
CompanyName |
The user company name |
string |
None. |
OfficeID |
The user office identifier |
integer |
None. |
OfficeName |
The name of the office of the usr |
string |
None. |
TimezoneID |
The timezone of the user |
string |
None. |
WeightUOM |
The weight unit of the user (LB,KG) |
string |
None. |
SizeUOM |
The size unit of the user (IN,CM) |
string |
None. |
DistanceUOM |
The distance unit of the user (MI,KM) |
string |
None. |
TemperatureUOM |
The temperature unit of the user (F,C) |
string |
None. |
RequireChangePassword |
Should the user be required to change password on next logon (true,false) |
boolean |
None. |
DataRestrictions |
Data restrictions N=none, R=region, O=office, S=sales person |
string |
None. |
Roles |
The application roles assigned to this user |
string |
None. |
HideRouting |
Show Routing (shipper related) |
boolean |
None. |
ShowMap |
Show Map (shipper related) |
boolean |
None. |
ShowRates |
Show Rates (shipper related) |
boolean |
None. |
ReferenceTypeID | integer |
None. |
|
ReferenceTypeID2 | integer |
None. |
|
ReferenceTypeID3 | integer |
None. |
|
ReferenceTypeID4 | integer |
None. |
|
ReferenceTypeID5 | integer |
None. |
|
ReferenceTypeID6 | integer |
None. |
|
ReferenceTypeID7 | integer |
None. |
|
ReferenceTypeID8 | integer |
None. |
|
ReferenceTypeID9 | integer |
None. |
Response Formats
application/json, text/json
{ "CompanyID": 13, "CompanyName": "sample string 14", "CountryID": "sample string 11", "CurrencyID": "sample string 12", "DataRestrictions": "sample string 23", "DistanceUOM": "sample string 20", "EmailAddress": "sample string 9", "ErrorMessage": "sample string 2", "FirstName": "sample string 7", "HideRouting": true, "IsSuccessful": true, "LastName": "sample string 8", "LogonName": "sample string 6", "OfficeID": 15, "OfficeName": "sample string 16", "PhoneNumber": "sample string 10", "ReferenceTypeID": 1, "ReferenceTypeID2": 1, "ReferenceTypeID3": 1, "ReferenceTypeID4": 1, "ReferenceTypeID5": 1, "ReferenceTypeID6": 1, "ReferenceTypeID7": 1, "ReferenceTypeID8": 1, "ReferenceTypeID9": 1, "RequireChangePassword": true, "Roles": "sample string 24", "ShowMap": true, "ShowRates": true, "SizeUOM": "sample string 19", "TemperatureUOM": "sample string 21", "TimezoneID": "sample string 17", "UserGUID": "sample string 5", "UserID": 4, "WeightUOM": "sample string 18", "auth": "sample string 3" }
application/xml, text/xml
<AuthorizationResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Shipper.Models"> <CompanyID>13</CompanyID> <CompanyName>sample string 14</CompanyName> <CountryID>sample string 11</CountryID> <CurrencyID>sample string 12</CurrencyID> <DataRestrictions>sample string 23</DataRestrictions> <DistanceUOM>sample string 20</DistanceUOM> <EmailAddress>sample string 9</EmailAddress> <ErrorMessage>sample string 2</ErrorMessage> <FirstName>sample string 7</FirstName> <HideRouting>true</HideRouting> <IsSuccessful>true</IsSuccessful> <LastName>sample string 8</LastName> <LogonName>sample string 6</LogonName> <OfficeID>15</OfficeID> <OfficeName>sample string 16</OfficeName> <PhoneNumber>sample string 10</PhoneNumber> <ReferenceTypeID>1</ReferenceTypeID> <ReferenceTypeID2>1</ReferenceTypeID2> <ReferenceTypeID3>1</ReferenceTypeID3> <ReferenceTypeID4>1</ReferenceTypeID4> <ReferenceTypeID5>1</ReferenceTypeID5> <ReferenceTypeID6>1</ReferenceTypeID6> <ReferenceTypeID7>1</ReferenceTypeID7> <ReferenceTypeID8>1</ReferenceTypeID8> <ReferenceTypeID9>1</ReferenceTypeID9> <RequireChangePassword>true</RequireChangePassword> <Roles>sample string 24</Roles> <ShowMap>true</ShowMap> <ShowRates>true</ShowRates> <SizeUOM>sample string 19</SizeUOM> <TemperatureUOM>sample string 21</TemperatureUOM> <TimezoneID>sample string 17</TimezoneID> <UserGUID>sample string 5</UserGUID> <UserID>4</UserID> <WeightUOM>sample string 18</WeightUOM> <auth>sample string 3</auth> </AuthorizationResp>