POST v1/admin/users

ADMIN - Returns a list of company users for an admin.

Request Information

URI Parameters

None.

Body Parameters

AdminListUserRequestModel
NameDescriptionTypeAdditional information
user_status

Flag to select active or passive users

boolean

Required

user_company_id

Company UID of the active user

string

Required

Data type: Text

user_id

User ID (GUID)

string

Required

Data type: Text

user_signature

MD5 hash signature for the active user to validate the request

string

Required

Data type: Text

Request Format

application/json, text/json

Sample:
{
  "user_status": true,
  "user_company_id": "sample string 2",
  "user_id": "sample string 3",
  "user_signature": "sample string 4"
}

Response Information

Resource Description

ADMIN - Returns a list of company users for an admin.

AdminListUserResultModel
NameDescriptionTypeAdditional information
response

AdminListUserResponseModel

None.

meta

Basic meta information for the operation result

MetaModel

None.

Response Format

application/json, text/json

Sample:
{
  "response": {
    "users": [
      {
        "company_user_id": "sample string 2",
        "company_user_company_uid": "sample string 3",
        "company_user_first_name": "sample string 4",
        "company_user_family_name": "sample string 5",
        "company_user_email": "sample string 6",
        "company_user_cell_number": "sample string 7",
        "company_user_can_create_shipment": true,
        "company_user_can_delete_shipment": true,
        "company_user_can_approve_offer": true,
        "company_user_can_make_payment": true,
        "company_user_can_finalize_shipment": true,
        "company_user_can_add_new_user": true,
        "company_user_is_admin": true,
        "company_user_is_insurance_admin": true,
        "company_name": "sample string 16",
        "company_user_create_date": "2018-07-18T21:03:37.6251233+03:00",
        "company_user_enabled": true,
        "company_user_role_id": 19
      },
      {
        "company_user_id": "sample string 2",
        "company_user_company_uid": "sample string 3",
        "company_user_first_name": "sample string 4",
        "company_user_family_name": "sample string 5",
        "company_user_email": "sample string 6",
        "company_user_cell_number": "sample string 7",
        "company_user_can_create_shipment": true,
        "company_user_can_delete_shipment": true,
        "company_user_can_approve_offer": true,
        "company_user_can_make_payment": true,
        "company_user_can_finalize_shipment": true,
        "company_user_can_add_new_user": true,
        "company_user_is_admin": true,
        "company_user_is_insurance_admin": true,
        "company_name": "sample string 16",
        "company_user_create_date": "2018-07-18T21:03:37.6251233+03:00",
        "company_user_enabled": true,
        "company_user_role_id": 19
      }
    ]
  },
  "meta": {
    "status_code": 1,
    "status_message": "sample string 2"
  }
}