POST 3dCartWebAPI/v1/Admins
Adds a new Admin User to the system
Request Information
URI Parameters
None.
Body Parameters
A Json or XML object containing the new admin user
AdminPOSTName | Description | Type | Additional information |
---|---|---|---|
AdminId |
database reference = admins.id |
integer |
None. |
Username |
database reference = admins.username |
string |
Required String length: inclusive between 0 and 50 |
database reference = admins.email |
string |
Required String length: inclusive between 0 and 255 |
|
Name |
database reference = admins.name |
string |
Required String length: inclusive between 0 and 50 |
Password |
database reference = admins.pass |
string |
Required String length: inclusive between 0 and 50 |
ExternalId |
database reference = admins.alt_id |
string |
String length: inclusive between 0 and 50 |
AdminPermissionsList | Collection of integer |
None. |
Request Formats
application/json, text/json
Sample:
{ "AdminId": 1, "Username": "sample string 1", "Email": "sample string 2", "Name": "sample string 3", "Password": "sample string 4", "ExternalId": "sample string 5", "AdminPermissionsList": [ 1, 2 ] }
application/xml, text/xml
Sample:
<AdminPOST xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <AdminId>1</AdminId> <Username>sample string 1</Username> <Email>sample string 2</Email> <Name>sample string 3</Name> <Password>sample string 4</Password> <ExternalId>sample string 5</ExternalId> <AdminPermissionsList> <int>1</int> <int>2</int> </AdminPermissionsList> </AdminPOST>
Sample Request |
|
Response Information
application/json, text/json
Sample:
[ { "Key":"AdminId", "Value":"1234", "Status":"201", "Message":"Created successfully", } ]
Resource Description
HttpResponseMessageName | Description | Type | Additional information |
---|---|---|---|
Version | Version |
None. |
|
Content | HttpContent |
None. |
|
StatusCode | HttpStatusCode |
None. |
|
ReasonPhrase | string |
None. |
|
Headers | Collection of Object |
None. |
|
RequestMessage | HttpRequestMessage |
None. |
|
IsSuccessStatusCode | boolean |
None. |