Hub object

Internal hub object with comprehensive administrative and operational details

_id

string

required

Unique identifier for the hub (MongoDB ObjectId)

Example:

"65c1f68ea735b522d370ea25"

organizationId

string

required

Organization identifier that owns this hub

Example:

"65c1f4eeca7c4816d94587b2"

name

string

required

Hub name or identifier

Example:

"Jakarta Central Hub"

address

string

required

Full address of the hub

Example:

"Jl. Sudirman No. 123, Jakarta Pusat, DKI Jakarta 10220"

coordinates

object

required

Hub geographic coordinates

Show child attributes

coordinates.latitude

number<float>

Latitude coordinate

Example:

-6.2088

coordinates.longitude

number<float>

Longitude coordinate

Example:

106.8456

status

enum<string>

required

Hub operational status

Available options:

active,

inactive,

maintenance

Example:

"active"

code

string

Short code for the hub

Example:

"JKT-CTR"

timezone

string

Hub timezone

Example:

"Asia/Jakarta"

workingHours

object

Hub operating hours

Show child attributes

workingHours.monday

object

Show child attributes

workingHours.monday.open

string

workingHours.monday.close

string

workingHours.monday.isOpen

boolean

workingHours.tuesday

object

Show child attributes

workingHours.tuesday.open

string

workingHours.tuesday.close

string

workingHours.tuesday.isOpen

boolean

workingHours.wednesday

object

Show child attributes

workingHours.wednesday.open

string

workingHours.wednesday.close

string

workingHours.wednesday.isOpen

boolean

workingHours.thursday

object

Show child attributes

workingHours.thursday.open

string

workingHours.thursday.close

string

workingHours.thursday.isOpen

boolean

workingHours.friday

object

Show child attributes

workingHours.friday.open

string

workingHours.friday.close

string

workingHours.friday.isOpen

boolean

workingHours.saturday

object

Show child attributes

workingHours.saturday.open

string

workingHours.saturday.close

string

workingHours.saturday.isOpen

boolean

workingHours.sunday

object

Show child attributes

workingHours.sunday.open

string

workingHours.sunday.close

string

workingHours.sunday.isOpen

boolean

capacity

object

Hub capacity and limits

Show child attributes

capacity.maxVehicles

integer

Maximum vehicles that can be assigned to this hub

Example:

50

capacity.maxUsers

integer

Maximum users that can access this hub

Example:

100

capacity.storageArea

number

Storage area in square meters

Example:

500.5

contactInfo

object

Hub contact information

Show child attributes

contactInfo.phone

string

Hub phone number

Example:

"+6221123456"

contactInfo.email

string<email>

Hub contact email

Example:

"jakarta.hub@mile.app"

contactInfo.manager

string

Hub manager name

Example:

"Ahmad Supriadi"

services

string[]

Services available at this hub

Example:

[
  "loading",
  "unloading",
  "storage",
  "maintenance",
  "fueling"
]

vehicles

object[]

Vehicles assigned to this hub

Show child attributes

vehicles.id

string

vehicles.name

string

vehicles.inputType

string

The input type of the component (e.g., string, number, date, etc.)

vehicles.status

string

users

object[]

Users with access to this hub

Show child attributes

users.id

string

users.name

string

users.email

string

users.role

string

statistics

object

Hub operational statistics

Show child attributes

statistics.totalTasks

integer

statistics.completedTasks

integer

statistics.activeVehicles

integer

statistics.activeUsers

integer

createdBy

string

Email of admin who created this hub

Example:

"admin@mile.app"

updatedBy

string

Email of admin who last updated this hub

Example:

"admin@mile.app"

createdTime

string<date-time>

ISO 8601 timestamp when hub was created

Example:

"2024-01-10T08:00:00.000000Z"

updatedTime

string<date-time>

ISO 8601 timestamp when hub was last updated

Example:

"2024-02-06T15:30:00.000000Z"

internalNotes

string

Internal administrative notes (not visible to public API)

Example:

"Hub requires infrastructure upgrade for increased capacity"

maintenanceSchedule

object[]

Scheduled maintenance activities

Show child attributes

maintenanceSchedule.inputType

string

The input type of the component (e.g., string, number, date, etc.)

maintenanceSchedule.scheduledDate

string<date-time>

maintenanceSchedule.description

string

maintenanceSchedule.status

string

systemMetadata

object

Internal system metadata

Show child attributes

systemMetadata.migrationStatus

string

systemMetadata.dataVersion

integer

systemMetadata.lastSyncTime

string<date-time>

failedCode

enum<string>

Hub Module business failedCode that indicate specific failure conditions or business rule violations during hub module operations. These codes help identify the failed operation of hub-related and provide standardized failure identification across the system.

Possible values:

hub-031: Duplicate entry - Hub identifier already exists
hub-033: Hub not found - Hub record does not exist
hub-034: Hub name already exists - Hub name already used
hub-035: Access forbidden - User lacks hub permission
hub-036: Hub creation failed - Failed to create hub
hub-037: Hub update failed - Failed to update hub
hub-038: Hub update failed by coordinate - Invalid coordinates provided
hub-039: Hub delete failed assosiated to other things - Hub has associated resources
hub-045: Server failure - Internal server failure

Available options:

hub-031,

hub-033,

hub-034,

hub-035,

hub-036,

hub-037,

hub-038,

hub-039,

hub-045

Getting Started

Webhook

Task

Routing

Flow

Data

Setting

File

Billing

Dashboard

Authentication

Reference

Internal Tools

Objects