POST v1/admin/users/detail

ADMIN - Returns the details of a company user for an admin.

Request Information

URI Parameters

None.

Body Parameters

AdminUserDetailsRequestModel
NameDescriptionTypeAdditional information
request_user_id

By default this is UID (GUID) of the requested user. Some API methods may map this to cell number or email etc.

string

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:
{
  "request_user_id": "sample string 1",
  "user_company_id": "sample string 2",
  "user_id": "sample string 3",
  "user_signature": "sample string 4"
}

Response Information

Resource Description

ADMIN - Returns the details of a company user for an admin.

AdminUserDetailsResultModel
NameDescriptionTypeAdditional information
response

AdminUserDetailsResponseModel

None.

meta

Basic meta information for the operation result

MetaModel

None.

Response Format

application/json, text/json

Sample:
{
  "response": {
    "user_details": {
      "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-11-21T09:41:32.9686343+03:00",
      "company_user_enabled": true,
      "company_user_role_id": 19
    },
    "user_company": {
      "company_id": "sample string 2",
      "company_name": "sample string 3",
      "company_phone": "sample string 4",
      "company_phone_extension": "sample string 5",
      "company_cell_number": "sample string 6",
      "company_email": "sample string 7",
      "company_tax_office_name": "sample string 8",
      "company_tax_number": "sample string 9",
      "company_address_city": "sample string 10",
      "company_address_district": "sample string 11",
      "company_address_neighborhood": "sample string 12",
      "company_address_street": "sample string 13",
      "company_address_building_number": "sample string 14",
      "company_address_zip_code": "sample string 15",
      "company_logo": "sample string 16",
      "company_web_url": "sample string 17",
      "company_invoice_info": "sample string 18",
      "company_approved": true,
      "auto_archive_shipments": true,
      "company_shipment_only_driver_show": true,
      "company_create_date": "2018-11-21T09:41:32.9686343+03:00",
      "company_type": 22,
      "company_status": 23
    }
  },
  "meta": {
    "status_code": 1,
    "status_message": "sample string 2"
  }
}