POST api/authorization
Request Information
URI Parameters
None.
Body Parameters
AuthorizationParmName | Description | Type | Additional information |
---|---|---|---|
CompanyID | integer |
None. |
|
LogonName | string |
None. |
|
Password | string |
None. |
|
ApplicationID | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "CompanyID": 1, "LogonName": "sample string 2", "Password": "sample string 3", "ApplicationID": "sample string 4" }
application/xml, text/xml
Sample:
<AuthorizationParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models"> <ApplicationID>sample string 4</ApplicationID> <CompanyID>1</CompanyID> <LogonName>sample string 2</LogonName> <Password>sample string 3</Password> </AuthorizationParm>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
AuthorizationRespName | Description | Type | Additional information |
---|---|---|---|
IsSuccessful | boolean |
None. |
|
ErrorMessage | string |
None. |
|
auth | string |
None. |
|
UserID | integer |
None. |
|
UserGUID | string |
None. |
|
LogonName | string |
None. |
|
FirstName | string |
None. |
|
LastName | string |
None. |
|
EmailAddress | string |
None. |
|
PhoneNumber | string |
None. |
|
CountryID | string |
None. |
|
CurrencyID | string |
None. |
|
CompanyID | integer |
None. |
|
CompanyName | string |
None. |
|
OfficeID | integer |
None. |
|
OfficeName | string |
None. |
|
TimezoneID | string |
None. |
|
WeightUOM | string |
None. |
|
SizeUOM | string |
None. |
|
DistanceUOM | string |
None. |
|
TemperatureUOM | string |
None. |
|
RequireChangePassword | boolean |
None. |
|
DataRestrictions | string |
None. |
|
Roles | string |
None. |
|
PageRestrictions | Collection of PageRestriction |
None. |
Response Formats
application/json, text/json
Sample:
{ "IsSuccessful": true, "ErrorMessage": "sample string 2", "auth": "sample string 3", "UserID": 4, "UserGUID": "sample string 5", "LogonName": "sample string 6", "FirstName": "sample string 7", "LastName": "sample string 8", "EmailAddress": "sample string 9", "PhoneNumber": "sample string 10", "CountryID": "sample string 11", "CurrencyID": "sample string 12", "CompanyID": 13, "CompanyName": "sample string 14", "OfficeID": 15, "OfficeName": "sample string 16", "TimezoneID": "sample string 17", "WeightUOM": "sample string 18", "SizeUOM": "sample string 19", "DistanceUOM": "sample string 20", "TemperatureUOM": "sample string 21", "RequireChangePassword": true, "DataRestrictions": "sample string 23", "Roles": "sample string 24", "PageRestrictions": [ { "PageID": "sample string 1", "PageName": "", "RestrictionCode": "sample string 2" }, { "PageID": "sample string 1", "PageName": "", "RestrictionCode": "sample string 2" } ] }
application/xml, text/xml
Sample:
<AuthorizationResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.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> <IsSuccessful>true</IsSuccessful> <LastName>sample string 8</LastName> <LogonName>sample string 6</LogonName> <OfficeID>15</OfficeID> <OfficeName>sample string 16</OfficeName> <PageRestrictions> <PageRestriction> <PageID>sample string 1</PageID> <RestrictionCode>sample string 2</RestrictionCode> </PageRestriction> <PageRestriction> <PageID>sample string 1</PageID> <RestrictionCode>sample string 2</RestrictionCode> </PageRestriction> </PageRestrictions> <PhoneNumber>sample string 10</PhoneNumber> <RequireChangePassword>true</RequireChangePassword> <Roles>sample string 24</Roles> <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>