POST v1/admin/companies/report

WEB - Company Report

Request Information

URI Parameters

None.

Body Parameters

CompanyReportRequest
NameDescriptionTypeAdditional information
start_date

date

None.

end_date

date

None.

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:
{
  "start_date": "2024-05-09T19:27:18.2485803+03:00",
  "end_date": "2024-05-09T19:27:18.2485803+03:00",
  "user_company_id": "sample string 1",
  "user_id": "sample string 2",
  "user_signature": "sample string 3"
}

Response Information

Resource Description

WEB - Company Report

BaseMetaResultModelOfListOfCompanyReportResponse
NameDescriptionTypeAdditional information
response

Collection of CompanyReportResponse

None.

meta

Basic meta information for the operation result

MetaModel

None.

Response Format

application/json, text/json

Sample:
{
  "response": [
    {
      "company_id": 1,
      "company_name": "sample string 2",
      "company_cell_number": "sample string 3",
      "company_email": "sample string 4",
      "company_create_date": "2024-05-09T19:27:18.2485803+03:00",
      "company_approved": true,
      "company_license_count": "sample string 7",
      "company_role_name": "sample string 8",
      "company_user_namesurname": "sample string 9"
    },
    {
      "company_id": 1,
      "company_name": "sample string 2",
      "company_cell_number": "sample string 3",
      "company_email": "sample string 4",
      "company_create_date": "2024-05-09T19:27:18.2485803+03:00",
      "company_approved": true,
      "company_license_count": "sample string 7",
      "company_role_name": "sample string 8",
      "company_user_namesurname": "sample string 9"
    }
  ],
  "meta": {
    "status_code": 1,
    "status_message": "sample string 2"
  }
}