POST v1/admin/companies

ADMIN - List companies according to the approvement status

Request Information

URI Parameters

None.

Body Parameters

AdminListCompanyRequestModel
NameDescriptionTypeAdditional information
company_is_approved

Flag to select approvement status of the companies

boolean

None.

all_company

boolean

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

Response Information

Resource Description

ADMIN - List companies according to the approvement status

BaseMetaResultModelOfAdminListCompanyResponseModel
NameDescriptionTypeAdditional information
response

AdminListCompanyResponseModel

None.

meta

Basic meta information for the operation result

MetaModel

None.

Response Format

application/json, text/json

Sample:
{
  "response": {
    "companies": [
      {
        "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-21T08:30:59.9551411+03:00",
        "company_type": 22,
        "company_status": 23
      },
      {
        "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-21T08:30:59.9551411+03:00",
        "company_type": 22,
        "company_status": 23
      }
    ]
  },
  "meta": {
    "status_code": 1,
    "status_message": "sample string 2"
  }
}