# VDA

<br>

### Environment: `Staging`
### BASE_URL - `https://hermes-api.p-stageenv.xyz/talaria`

## 01. Get Summary
#### URL
> GET /dashboard

#### Headers

> Content-Type : application/json
> Authorization : Token <token>

#### Query Params
> date [string, date, `optional`]

##### Sample Request & Response :

> Request : /dashboard?date=2022-11-07

> Response : Success response with status code `200`:

{
    "message": "Summary",
    "type": "success",
    "code": 200,
    "data": {
        "total_run": 2,
        "completed_run": 1,
        "total_basket": 3,
        "completed_basket": 2,
        "total_order": 3,
        "completed_order": 1,
        "type": 3
    }
}

## 02. Get Transfer run list API

#### URL
> GET /user/transfers

#### Headers
> Content-Type : application/json
> Authorization : Token <token>

#### Query Params
> N/A

##### Sample Request & Response :

> Request : /user/transfers

##### Success Response with status code `200` :

{
    "message": "today's transfer run list",
    "type": "success",
    "code": 200,
    "data": [
        {
            "run_route_id": 1601,
            "order_status": 33,
            "is_close": 0,
            "total": 2,
            "total_basket": 2,
            "from_hub": 1,
            "to_hub": 2,
            "run_status": 0,
            "transfer_type": 24,
            "logistics_type": 1,
            "from_hub_name": "Banani",
            "from_hub_address": "Islam Tower 464/H, West Rampura, DIT Rd, Dhaka 1219",
            "from_hub_contact_name": "Md. Arif Hasan",
            "from_hub_contact_number": "01958522218"
        },
        {
            "run_route_id": 1602,
            "order_status": 33,
            "is_close": 0,
            "total": 1,
            "total_basket": 1,
            "from_hub": 3,
            "to_hub": 1,
            "run_status": 0,
            "transfer_type": 24,
            "logistics_type": 1,
            "from_hub_name": "Mirpur",
            "from_hub_address": "51, Rabeya Vaban, Darussalam, Kallyanpur, Dhaka-1216",
            "from_hub_contact_name": "T.M.Arif Hossain",
            "from_hub_contact_number": "01948888541"
        }
    ]
}

## 03. Get Transfer Run Details API

#### URL
> GET /transfers/<run-route-id>

#### Headers
> Content-Type : application/json
> Authorization : Token <token>

#### Query Params
> NA

##### Sample Request & Response :

> Request : /transfers/1601

##### Success Response with status code `200`:

{
    "message": "transfer run details",
    "type": "success",
    "code": 200,
    "data": {
        "run_route_id": 1601,
        "order_status": 33,
        "is_close": 0,
        "total": 2,
        "total_basket": 2,
        "from_hub_id": 1,
        "to_hub_id": 2,
        "run_status": 1,
        "transfer_type": 24,
        "logistics_type": 1,
        "from_hub_name": "Banani",
        "from_hub_address": "Islam Tower 464/H, West Rampura, DIT Rd, Dhaka 1219",
        "from_hub_contact_name": "Md. Arif Hasan",
        "from_hub_contact_number": "01958522218",
        "from_hub_lat": "23.7794584",
        "from_hub_lon": "90.40536185",
        "to_hub_name": "Uttara",
        "to_hub_address": "House 1, Road 2/A, Sector 4, Uttara-1230",
        "to_hub_contact_name": "Jakir Hossain",
        "to_hub_contact_number": "01711777709",
        "to_hub_lat": "23.87157654",
        "to_hub_lon": "90.40536837",
        "baskets": [
            "BA041022LM6H",
            "BA041022LM7M"
        ],
        "orders": [
            "DC231022AWDDPU",
            "DC231022GJDXVQ"
        ]
    }
}

## 04. Update Transfer run status API

#### URL
> Patch /transfers/:run-route-id

#### Headers
> Content-Type : application/json
> Authorization : Token <token>

#### Query Params
> NA

#### Payload
> run_status [integer, `required`]
> sequence [integer, `required`]
> lat [float, `required`]
> lat [float, `required`]
> weight [float, `optoinal`]

##### Sample Request & Response :

##### Sample Request
> Request : /transfers/1601

{
    "run_status": 1,
    "sequence": 1,
    "lat": 23.983939,
    "lon": 90.783939
}

##### Success Response with status code `200`:

{
    "message": "transfer run status updated",
    "type": "success",
    "code": 200
}