Unit

Details for the unit collection and detail endpoints

The unit resource is a component part of an event, for example an individual race or ceremony.

An example unit resource for the 2018 winter olympics can be seen below.

{
    "code": "LUGMSINGLES-----------FNL-000100--",
    "description": "Men's Singles Run 1",
    "start": "2017-09-11T00:40:00Z",
    "end": "2017-09-11T01:40:00Z",
    "meta": {
        "medal": "none"
    },
    "type": {
        "code": "ATH",
        "description": "Individuals"
    },
    "scheduleStatus": {
        "code": "FINISHED",
        "description": "Finished",
        "notes": "All play is complete in the unit"
    },
    "phaseType": {
        "code": 3,
        "description": "Competition"
    },
    "venue": {
        "code": "ASL",
        "description": "Olympic Sliding Centre",
        "city": "PyeongChang"
    },
    "games": {
        "code": "OWG2018",
        "description": "Olympic Winter Games PyeongChang 2018"
    },
    "discipline": {
        "code": "LUG",
        "description": "Luge"
    },
    "event": {
        "code": "LUGMSINGLES-----------",
        "description": "Men's Singles",
        "meta": {
            "teamEvent": false
        }
    },
    "gender": {
        "code": "M",
        "description": "Men"
    },
    "phase": {
        "code": "LUGMSINGLES-----------FNL-",
        "description": "Men's Singles"
    },
    "entrant": [],
    "link": [
        {
            "rel": "self",
            "href": "http://olympics.api.pressassociation.io/games/OWG2018/unit/LUGMSINGLES-----------FNL-000100--"
        },
        {
            "rel": "unit-result",
            "href": "http://olympics.api.pressassociation.io/games/OWG2018/unit/LUGMSINGLES-----------FNL-000100--/result"
        },
        {
            "rel": "phase",
            "href": "http://olympics.api.pressassociation.io/games/OWG2018/phase/LUGMSINGLES-----------FNL-"
        }
    ]
}

The table below outlines the possible values exposed in the Unit resource.

PropertyValue(s)Description
codeIOC defined discipline code.
descriptionIOC defined discipline description.
startDate and time of the approx start.
endDate and time of the approx end.
meta.medalnone, bronze, goldBronze medal event for 3rd vs 4th.
Gold medal event for 1st vs 2nd.
typeUnit TypeThe associated unit type.
scheduleStatusSchedule StatusThe associated scheduled status.
phaseTypePhase TypeThe associated phase type.
venueThe associated venue.
gamesGamesThe associated games.
disciplineDisciplineThe associated discipline.
eventThe associated event.
genderGenderThe associated gender.
phasePhaseThe associated phase.
linksHATEOAS links to associated endpoints.

This is an example of how you would query a unit using a start and end parameter.

curl --request GET \
  --url https://olympics.api.pressassociation.io/v3/games/OWG2018/unit?start=2018-01-01&end=2018-02-15

❗️

Date parameters

Calling for a list of any assets that have a date/time association without date parameters will return the current date. Adding date parameters can expose multiple chosen dates.

‘Wrapper’ events signify a group or section of events. The ‘wrapper’ events can update during the progress of the rest of the events within the session, displaying the same status values as the schedules.