Ambassador API Documentation

This document provides the necessary details to interact with the Ambassador API endpoints. The API allows users to retrieve information about Ambassador, including various filtering options.

Base URL

https://hungerstationsa.boolanga.com/api/v2

Endpoints

GET /checks

Retrieve information about ambassador checks. This endpoint allows various filtering options to narrow down the results based on the provided parameters.

Query Parameters

Parameter	Type	Description
recorder_id	bigint	(optional) Filter by ambassador ID.
rider_id	bigint	(optional) Filter by rider ID.
check_date_from	date	(optional) Filter by check date (start range).
check_date_to	date	(optional) Filter by check date (end range).
is_validation	boolean	(optional) Filter by ID validation status.
license_plate	boolean	(optional) Filter by license plate validation status.

Response

The response will be a JSON array of ambassador check details. Each object in the array contains the following fields:

Field	Description
ID	(bigint) ID of the ambassador check.
Rider_ID	(bigint) ID of the rider.
Rider_name	(text) Name of the rider.
3PL	(text) Name of the third-party logistics.
Recorder_ID	(bigint) ID of the ambassador.
Check_date	(datetime) Date when the check was performed.
ID_validation	(boolean) ID validation status.
License_plate	(boolean) License plate validation status.
Reported_item	(array) Array of reported items.
Questioner	(array) Array of questioner answers.

Example Request

GET checks?recorder_id=1389838&check_date_from=2025-06-30&check_date_to=2025-07-01

[
  {
    "ID": 334397,
    "Country_code": "SA",
    "Rider_ID": "2074369",
    "Rider_name": "علي عبد ال لطيف",
    "3PL": "masarat_almadinah_shift_ftr",
    "Recorder_ID": "1389838",
    "Check_date": "2025-06-30 09:32:27",
    "Timezone": "UTC +3",
    "ID_validation": 1,
    "License_plate": 1,
    "Reported_item": null,
    "Questioner": [
      {
        "question": "Is the uniform complete?",
        "question_id": "1",
        "answer": "Yes",
        "imageUrl": "https://hungerstationsa.boolanga.com/storage/questioner_questions/1/94/photo.jpeg",
        "evidenceImageUrl": "https://hungerstationsa.boolanga.com/storage/patroller_checks/334397/1194175/image.jpg",
        "score": "1",
        "category": "Appearance"
      },
      {
        "question": "What are the missing elements?",
        "question_id": "2",
        "answer": null,
        "imageUrl": "https://hungerstationsa.boolanga.com/storage/questioner_questions/2/117/photo.jpeg",
        "evidenceImageUrl": null,
        "score": null,
        "category": "Appearance"
      },
      {
        "question": "Is the uniform in good condition?",
        "question_id": "31",
        "answer": "Yes",
        "imageUrl": "https://hungerstationsa.boolanga.com/storage/questioner_questions/31/391/photo.jpeg",
        "evidenceImageUrl": "https://hungerstationsa.boolanga.com/storage/patroller_checks/334397/1194176/image.jpg",
        "score": "1",
        "category": "Hygiene"
      },
      {
        "question": "What looks unclean about the rider's items?",
        "question_id": "16",
        "answer": null,
        "imageUrl": "https://hungerstationsa.boolanga.com/storage/questioner_questions/16/95/photo.jpeg",
        "evidenceImageUrl": null,
        "score": null,
        "category": "Hygiene"
      },
      {
        "question": "What is the rider's vehicle type?",
        "question_id": "19",
        "answer": "Bike",
        "imageUrl": null,
        "evidenceImageUrl": null,
        "score": "0",
        "category": "Other"
      },
      {
        "question": "Is the car clean, both exterior and interior?",
        "question_id": "32",
        "answer": null,
        "imageUrl": null,
        "evidenceImageUrl": null,
        "score": null,
        "category": "Vehicle"
      },
      {
        "question": "Does the bike have an HS box?",
        "question_id": "22",
        "answer": "Yes",
        "imageUrl": "https://hungerstationsa.boolanga.com/storage/questioner_questions/22/129/photo.jpeg",
        "evidenceImageUrl": "https://hungerstationsa.boolanga.com/storage/patroller_checks/334397/1194177/image.jpg",
        "score": "1",
        "category": "Vehicle"
      },
      {
        "question": "Is the HS box light on?",
        "question_id": "23",
        "answer": "Yes",
        "imageUrl": "https://hungerstationsa.boolanga.com/storage/questioner_questions/23/131/photo.jpeg",
        "evidenceImageUrl": "https://hungerstationsa.boolanga.com/storage/patroller_checks/334397/1194178/image.jpg",
        "score": "1",
        "category": "Vehicle"
      },
      {
        "question": "Is the HS box clean?",
        "question_id": "25",
        "answer": "Yes",
        "imageUrl": "https://hungerstationsa.boolanga.com/storage/questioner_questions/25/132/photo.jpeg",
        "evidenceImageUrl": "https://hungerstationsa.boolanga.com/storage/patroller_checks/334397/1194179/image.jpg",
        "score": "1",
        "category": "Vehicle"
      },
      {
        "question": "Add other remarks",
        "question_id": "27",
        "answer": null,
        "imageUrl": null,
        "evidenceImageUrl": null,
        "score": "0",
        "category": "Other"
      }
    ]
  }
]

Notes

Ensure that the date format for assign_date_from and assign_date_to is YYYY-MM-DD. The parameter names are case-sensitive. If no parameters are provided, the endpoint returns all ambassador check details.

Example

Scenario: Filtering by Ambassador ID and Date Range To retrieve ambassador checks performed by ambassador with ID 89025 between 2024-01-01 and 2024-06-01:

GET /checks?recorder_id=89025&check_date_from=2024-01-01&check_date_to=2024-06-01

Response

[
    {
        "ID": 93,
        "Rider_ID": 152200,
        "Rider_name": "Monisha Alva-TEST",
        "3PL": "Talabat Internal Rider",
        "Recorder_ID": 89025,
        "Check_date": "2024-05-08 10:20:03",
        "ID_validation": 1,
        "License_plate": 1,
        "Reported_item": [],
        "Questioner": [
            {
                "question": "Is the Rider Apperance in Compliance?",
                "answer": "Uniform is complete but dirty",
                "imageUrl": "https://hungerstationsa.boolanga.com/storage/questioner_questions/4/261785/photo.png",
                "evidenceImageUrl": null,
                "score": "0",
                "category": "Appearance"
            }
        ]
    }
]