POST v1/admin/mobileUsers

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

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
user_status	Flag to select active or passive users	boolean	Required
user_available		boolean	None.
user_wait_available		boolean	None.
page_number		integer	None.
page_length		integer	None.
order		string	None.
order_asc		boolean	None.
filter_user_id		integer	None.
user_cell_number		string	None.
user_citizenship_number		string	None.
user_first_name		string	None.
company_uid		string	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:

{
  "user_status": true,
  "user_available": true,
  "user_wait_available": true,
  "page_number": 2,
  "page_length": 3,
  "order": "sample string 4",
  "order_asc": true,
  "filter_user_id": 6,
  "user_cell_number": "sample string 7",
  "user_citizenship_number": "sample string 8",
  "user_first_name": "sample string 9",
  "company_uid": "sample string 10",
  "user_company_id": "sample string 11",
  "user_id": "sample string 12",
  "user_signature": "sample string 13"
}

Response Information

Resource Description

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

AdminListMobileUserResultModel

Name	Description	Type	Additional information
response		AdminListMobileUserResponseModel	None.
meta	Basic meta information for the operation result	MetaModel	None.

Response Format

application/json, text/json

Sample:

{
  "response": {
    "users": [
      {
        "user_id": 1,
        "user_uid": "sample string 2",
        "user_first_name": "sample string 3",
        "user_cell_number": "sample string 4",
        "user_citizenship_number": "sample string 5",
        "user_image": "sample string 6",
        "user_mailing_address": "sample string 7",
        "user_driving_license_image_front": "sample string 8",
        "user_driving_license_image_back": "sample string 9",
        "user_src_document_image": "sample string 10",
        "user_psyc_document_image": "sample string 11",
        "user_available": true,
        "user_active": true,
        "user_rating": 1,
        "user_type": 12,
        "user_insurance_approved": true,
        "user_create_date": "2024-11-25T22:39:00.3495964+03:00",
        "enable_shipment_notifications": true,
        "user_confirmation_date": "2024-11-25T22:39:00.3495964+03:00",
        "user_confirmation_company_user_uid": "sample string 16",
        "company_name": "sample string 18",
        "user_vehicle_licence_plate": "sample string 19",
        "user_last_location_time": "2024-11-25T22:39:00.3495964+03:00",
        "user_vehicle_is_company_vehicle": true,
        "user_confirmation_company_user": "sample string 21",
        "filter_user_id": 22,
        "user_iban": "sample string 23",
        "user_tk_iban": "sample string 24"
      },
      {
        "user_id": 1,
        "user_uid": "sample string 2",
        "user_first_name": "sample string 3",
        "user_cell_number": "sample string 4",
        "user_citizenship_number": "sample string 5",
        "user_image": "sample string 6",
        "user_mailing_address": "sample string 7",
        "user_driving_license_image_front": "sample string 8",
        "user_driving_license_image_back": "sample string 9",
        "user_src_document_image": "sample string 10",
        "user_psyc_document_image": "sample string 11",
        "user_available": true,
        "user_active": true,
        "user_rating": 1,
        "user_type": 12,
        "user_insurance_approved": true,
        "user_create_date": "2024-11-25T22:39:00.3495964+03:00",
        "enable_shipment_notifications": true,
        "user_confirmation_date": "2024-11-25T22:39:00.3495964+03:00",
        "user_confirmation_company_user_uid": "sample string 16",
        "company_name": "sample string 18",
        "user_vehicle_licence_plate": "sample string 19",
        "user_last_location_time": "2024-11-25T22:39:00.3495964+03:00",
        "user_vehicle_is_company_vehicle": true,
        "user_confirmation_company_user": "sample string 21",
        "filter_user_id": 22,
        "user_iban": "sample string 23",
        "user_tk_iban": "sample string 24"
      }
    ],
    "total_count": 1
  },
  "meta": {
    "status_code": 1,
    "status_message": "sample string 2"
  }
}