POST api/User/Create
Request Information
URI Parameters
None.
Body Parameters
CreateUserParm| Name | Description | Type | Additional information |
|---|---|---|---|
| auth | string |
None. |
|
| LogonName | string |
None. |
|
| Password | string |
None. |
|
| FirstName | string |
None. |
|
| LastName | string |
None. |
|
| EmailAddress | string |
None. |
|
| OfficeNumber | string |
None. |
|
| FaxNumber | string |
None. |
|
| MobileNumber | string |
None. |
|
| ConfirmedOn | date |
None. |
|
| ActiveOn | date |
None. |
|
| InactiveOn | date |
None. |
|
| PasswordChange | boolean |
None. |
|
| OfficeID | integer |
None. |
|
| TimezoneID | string |
None. |
|
| CountryID | string |
None. |
|
| CurrencyID | string |
None. |
|
| WeightUOM | string |
None. |
|
| SizeUOM | string |
None. |
|
| TemperatureUOM | string |
None. |
|
| DistanceUOM | string |
None. |
|
| PLTMSPermitted | boolean |
None. |
|
| PLTMSRole | string |
None. |
|
| PLSHIPPermitted | boolean |
None. |
|
| PLSHIPRole | string |
None. |
|
| PLSHIPAccountNumber | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"auth": "sample string 1",
"LogonName": "sample string 2",
"Password": "sample string 3",
"FirstName": "sample string 4",
"LastName": "sample string 5",
"EmailAddress": "sample string 6",
"OfficeNumber": "sample string 7",
"FaxNumber": "sample string 8",
"MobileNumber": "sample string 9",
"ConfirmedOn": "2025-12-03T12:33:23.1491654+00:00",
"ActiveOn": "2025-12-03T12:33:23.1491654+00:00",
"InactiveOn": "2025-12-03T12:33:23.1491654+00:00",
"PasswordChange": true,
"OfficeID": 1,
"TimezoneID": "sample string 11",
"CountryID": "sample string 12",
"CurrencyID": "sample string 13",
"WeightUOM": "sample string 14",
"SizeUOM": "sample string 15",
"TemperatureUOM": "sample string 16",
"DistanceUOM": "sample string 17",
"PLTMSPermitted": true,
"PLTMSRole": "sample string 19",
"PLSHIPPermitted": true,
"PLSHIPRole": "sample string 21",
"PLSHIPAccountNumber": "sample string 22"
}
application/xml, text/xml
Sample:
<CreateUserParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models"> <ActiveOn>2025-12-03T12:33:23.1491654+00:00</ActiveOn> <ConfirmedOn>2025-12-03T12:33:23.1491654+00:00</ConfirmedOn> <CountryID>sample string 12</CountryID> <CurrencyID>sample string 13</CurrencyID> <DistanceUOM>sample string 17</DistanceUOM> <EmailAddress>sample string 6</EmailAddress> <FaxNumber>sample string 8</FaxNumber> <FirstName>sample string 4</FirstName> <InactiveOn>2025-12-03T12:33:23.1491654+00:00</InactiveOn> <LastName>sample string 5</LastName> <LogonName>sample string 2</LogonName> <MobileNumber>sample string 9</MobileNumber> <OfficeID>1</OfficeID> <OfficeNumber>sample string 7</OfficeNumber> <PLSHIPAccountNumber>sample string 22</PLSHIPAccountNumber> <PLSHIPPermitted>true</PLSHIPPermitted> <PLSHIPRole>sample string 21</PLSHIPRole> <PLTMSPermitted>true</PLTMSPermitted> <PLTMSRole>sample string 19</PLTMSRole> <Password>sample string 3</Password> <PasswordChange>true</PasswordChange> <SizeUOM>sample string 15</SizeUOM> <TemperatureUOM>sample string 16</TemperatureUOM> <TimezoneID>sample string 11</TimezoneID> <WeightUOM>sample string 14</WeightUOM> <auth>sample string 1</auth> </CreateUserParm>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
CreateUserResp| Name | Description | Type | Additional information |
|---|---|---|---|
| IsSuccessful | boolean |
None. |
|
| ErrorMessage | string |
None. |
|
| UserID | integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"IsSuccessful": true,
"ErrorMessage": "sample string 2",
"UserID": 3
}
application/xml, text/xml
Sample:
<CreateUserResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models"> <ErrorMessage>sample string 2</ErrorMessage> <IsSuccessful>true</IsSuccessful> <UserID>3</UserID> </CreateUserResp>