Horse Fleet Information

CLtd maintains a small fleet (herd) or horses that are used to make deliveries. Information about these horses can be retrieved from this service.

Each horse has a unique id, this is a string of characters that provides a shorthand method of referring to one horse in the fleet without repeatedly listing all its properties twice. Beyond their ids, this service can be used to find each horse's;

• "name": Human-readable name of the horse.
• "carry capacity": Delivery weight this horse can comfortably handle (given in kg).
• "relative speed": Relative travel speed that this horse makes deliveries at.
• "additional notes": A field maintained by CLtd that contains some extra notes about each horse.

Valid Horse ids

There are 11 horses in the fleet, whose ids and names are (in no particular order);

• lotr-btp: Bill the Pony,
• lotr-sfx: Shadowfax,
• lotr-smn: Snowmane,
• es-sdm: Shadowmare,
• es-fst: Frost,
• es-avk: Arvak,
• wtr-rch: Roach,
• gmy-pbs: Phobos,
• gmy-pgs: Pegasus,
• gmy-tjn: Trojan,
• wtp-eor: Eeyore.

The horses/information service provides information about a horse given its id. Information about multiple horses can be requested at once if necessary. The response is a json file of as many entries as unique horse ids that were given. Each entry in the file contains keys "id", "name", "carry capacity", "relative speed", "additional notes" corresponding to the information above.

Querying

To query for information about the horses with ids X, Y, and Z:

• horses/information?id=X,Y,Z
• horses/information?id=X&id=Y&id=Z

Parameters

• id: A series of string values corresponding to horse id values. Information will be retrieved for each unique horse, and will be returned sorted by the ids. At least one id must be provided.

Examples

• https://rse-with-python.arc.ucl.ac.uk/delivery-info/horses/information?id=es-avk,lotr-btp - fetch information about the horses with ids es-avk and lotr-btp.
• https://rse-with-python.arc.ucl.ac.uk/delivery-info/horses/information?id=es-avk&id=lotr-btp - same as the example above, alternative syntax.

Return format

The horses/information service will return a .json file of as many entries as unique horse ids that were given.

[
    {
        "id": "X",
        "name": "Horse-X",
        "carry capacity": 0.0,
        "relative speed": 1.0,
        "additional notes": "Info on horse X"
    },
    {
        "id": "Y",
        "name": "Horse-Y",
        "carry capacity": 0.0,
        "relative speed": 1.0,
        "additional notes": "Info on horse Y"
    },
    ...
]

No particular order is guaranteed for the ordering of the entries. Keys have the corresponding types:

• "id": str,
• "name": str,
• "carry capacity": float,
• "relative speed": float,
• "additional notes": str.