GET 3dCartWebAPI/v1/Admins


Get all Admin Users

Request Information

URI Parameters

NameDescriptionTypeAdditional information
limit

Maximum number of items that can be returned

integer

Default value is 10

offset

Starting point for the return data

integer

Default value is 1

name

Name of the Admin User

string

Default value is

username

Username of the Admin User

string

Default value is

external_id

Admin ExternalId

string

Default value is

countonly

Count the number of rows only

integer

Default value is 0

Body Parameters

None.


Sample Request



Response Information

Resource Description

Collection of Admin
NameDescriptionTypeAdditional information
AdminId

database reference = admins.id

integer

None.

Username

database reference = admins.username

string

String length: inclusive between 0 and 50

Email

database reference = admins.email

string

String length: inclusive between 0 and 255

Name

database reference = admins.name

string

String length: inclusive between 0 and 50

ExternalId

database reference = admins.alt_id

string

String length: inclusive between 0 and 50

Lastlogin

database reference = admins.lastlogin

date

None.

AdminPermissionsList

Collection of AdminPermission

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "AdminId": 1,
    "Username": "sample string 1",
    "Email": "sample string 2",
    "Name": "sample string 3",
    "ExternalId": "sample string 4",
    "Lastlogin": "08/17/2019 16:32",
    "AdminPermissionsList": [
      {
        "Id": 1,
        "Section": "sample string 1",
        "Action": "sample string 2"
      },
      {
        "Id": 1,
        "Section": "sample string 1",
        "Action": "sample string 2"
      }
    ]
  },
  {
    "AdminId": 1,
    "Username": "sample string 1",
    "Email": "sample string 2",
    "Name": "sample string 3",
    "ExternalId": "sample string 4",
    "Lastlogin": "08/17/2019 16:32",
    "AdminPermissionsList": [
      {
        "Id": 1,
        "Section": "sample string 1",
        "Action": "sample string 2"
      },
      {
        "Id": 1,
        "Section": "sample string 1",
        "Action": "sample string 2"
      }
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfAdmin xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Admin>
    <AdminId>1</AdminId>
    <Username>sample string 1</Username>
    <Email>sample string 2</Email>
    <Name>sample string 3</Name>
    <ExternalId>sample string 4</ExternalId>
    <Lastlogin>2019-08-17T16:32:13.0915142-04:00</Lastlogin>
    <AdminPermissionsList>
      <AdminPermission>
        <Id>1</Id>
        <Section>sample string 1</Section>
        <Action>sample string 2</Action>
      </AdminPermission>
      <AdminPermission>
        <Id>1</Id>
        <Section>sample string 1</Section>
        <Action>sample string 2</Action>
      </AdminPermission>
    </AdminPermissionsList>
  </Admin>
  <Admin>
    <AdminId>1</AdminId>
    <Username>sample string 1</Username>
    <Email>sample string 2</Email>
    <Name>sample string 3</Name>
    <ExternalId>sample string 4</ExternalId>
    <Lastlogin>2019-08-17T16:32:13.0915142-04:00</Lastlogin>
    <AdminPermissionsList>
      <AdminPermission>
        <Id>1</Id>
        <Section>sample string 1</Section>
        <Action>sample string 2</Action>
      </AdminPermission>
      <AdminPermission>
        <Id>1</Id>
        <Section>sample string 1</Section>
        <Action>sample string 2</Action>
      </AdminPermission>
    </AdminPermissionsList>
  </Admin>
</ArrayOfAdmin>