Keolis Santé EventHub API (2.1.0)

Download OpenAPI specification:Download

EventHub API definition

Request Body schema: application/json

EventHub input topics

required	Array of objects (transportEvent) Action to perform on transports.
required	Array of objects (employeeEvent) Action to perform on employees.
required	Array of objects (vehicleEvent) Action to perform on vehicles.
required	Array of objects (requirementEvent) Actions to perform on requirements.
required	Array of objects (areaEvent) Actions to perform the area.

Responses

Request samples

Payload

Content type

application/json

{"transport": [{"actionDate": "string",
"action": "CREATE",
"transport": {"id": "string",
"depotId": "string",
"validityDate": "string",
"patient": {"firstName": "string",
"lastName": "string"
},
"origin": {"coordinates": {"latitude": 0,
"longitude": 0
},
"address": "string",
"zipCode": "string",
"city": "string",
"country": "string"
},
"destination": {"coordinates": {"latitude": 0,
"longitude": 0
},
"address": "string",
"zipCode": "string",
"city": "string",
"country": "string"
},
"transportTimeWindow": {"start": "string",
"end": "string"
},
"timeWindowType": "origin",
"pickupDuration": "string",
"dropoffDuration": "string",
"parkingAccessDuration": "string",
"possibleVehicleTypes": ["TAXI"
],
"numberSeatsNeeded": 0,
"sharedTransportAllowed": true,
"requirementIds": ["string"
],
"direction": "GO",
"timeWindowAccuracy": true,
"delayAllowed": true,
"updateTime": "string"
}
}
],
"employee": [{"actionDate": "string",
"action": "CREATE",
"employee": {"id": "string",
"depotId": "string",
"validityDate": "string",
"name": {"firstName": "string",
"lastName": "string"
},
"servicePriority": 0,
"serviceFirstPickUp": "string",
"serviceLastDropOff": "string",
"serviceAmplitudeMax": "string",
"serviceAmplitudeMin": "string",
"serviceStart": "string",
"serviceEnd": "string",
"diploma": "DEA",
"serviceAssignments": ["AMBU"
],
"remainingWeekTime": 0,
"requirementIds": ["string"
]
}
}
],
"vehicle": [{"actionDate": "string",
"action": "CREATE",
"vehicle": {"id": "string",
"depotId": "string",
"validityDate": "string",
"licensePlate": "string",
"type": "TAXI",
"requirementIds": ["string"
]
}
}
],
"requirement": [{"actionDate": "string",
"action": "CREATE",
"requirement": {"id": "string",
"name": "string",
"type": "VEHICLE",
"constraint": "SOFT"
}
}
],
"area": [{"actionDate": "string",
"action": "CREATE",
"area": {"sectors": [{"id": "string",
"name": "string"
}
],
"regulations": [{"id": "string",
"name": "string",
"sectorId": "string"
}
],
"territories": [{"id": "string",
"name": "string",
"regulationId": "string"
}
],
"depots": [{"id": "string",
"name": "string",
"territoryId": "string",
"location": {"coordinates": {"latitude": 0,
"longitude": 0
},
"address": "string",
"zipCode": "string",
"city": "string",
"country": "string"
}
}
]
}
}
]
}

Response samples

Content type

application/json

{"routes": [{"employeeId": "string",
"vehicleId": "string",
"steps": {"stepType": "MOVE",
"start": "string",
"end": "string",
"distance": 0,
"transportId": "string",
"nbPassengers": 0
}
}
],
"parameters": [{"name": "string",
"value": "string"
}
]
}