institution-status

Fetch institution status details front-door

Fetches institution-specific current outage as well as a list of all incidents and scheduled outages.

get/status/institutions/{institution_id}/details

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/status/institutions/{institution_id}/details
  • Auth: none required

Path parameters

institution_idstring required

Description of the update.

Example:Est reprehenderit nihil.

Query parameters

pageinteger

Page number for paginating outages list.

Example:8800569860965088000
outage_type'scheduled' | 'incident'

Filter where, if provided, filters by scheduled outages or incidents.

Example:scheduled

Response

Created response.

has_next_pageboolean required

Whether the list of outages has a next page.

institution_idstring required

Institution ID of which the details has been requested.

institution_logo_urlstring required

URL of the institution logo page.

institution_namestring required

Name of the institution which corresponds to the ID being queried.

institution_status'Healthy' | 'Outage' required

Status of the institution whose details are being currently queried.

Example response

{
  "current_incident": {
    "created_at": "Autem omnis reprehenderit dolores sit.",
    "description": "Temporibus consequatur accusamus aliquid et accusamus quia.",
    "end_at": "Ea commodi.",
    "id": "Aspernatur quia nulla praesentium illum.",
    "incident_updates": [
      {
        "description": "Ab enim nihil excepturi dolores suscipit.",
        "status": "Omnis hic officia laudantium id dicta fugiat.",
        "update_at": "Autem expedita animi at quod aut explicabo."
      },
      {
        "description": "Ab enim nihil excepturi dolores suscipit.",
        "status": "Omnis hic officia laudantium id dicta fugiat.",
        "update_at": "Autem expedita animi at quod aut explicabo."
      },
      {
        "description": "Ab enim nihil excepturi dolores suscipit.",
        "status": "Omnis hic officia laudantium id dicta fugiat.",
        "update_at": "Autem expedita animi at quod aut explicabo."
      }
    ],
    "start_at": "Qui minima.",
    "title": "Distinctio aut voluptatem ipsum dolores sit."
  },
  "current_scheduled_outage": {
    "id": "Ad dicta in molestiae.",
    "institution_id": "Cum et quibusdam.",
    "is_partial": false,
    "outage_end": "Vitae dolores aspernatur sapiente possimus deleniti ipsum.",
    "outage_reason": "Repellat tempore quasi adipisci nostrum.",
    "outage_start": "Quisquam magni sequi ut facilis quibusdam ad."
  },
  "has_next_page": true,
  "institution_id": "1",
  "institution_logo_url": "Perspiciatis aut.",
  "institution_name": "NAB",
  "institution_status": "Outage",
  "next_scheduled_outage": {
    "id": "Ad dicta in molestiae.",
    "institution_id": "Cum et quibusdam.",
    "is_partial": false,
    "outage_end": "Vitae dolores aspernatur sapiente possimus deleniti ipsum.",
    "outage_reason": "Repellat tempore quasi adipisci nostrum.",
    "outage_start": "Quisquam magni sequi ut facilis quibusdam ad."
  },
  "outages": [
    {
      "description": "Ut in.",
      "duration": 7113594325144523000,
      "end_at": "Omnis asperiores ad officiis quos.",
      "id": "Et eius delectus sed iure.",
      "incident_updates": [
        {
          "description": "Ab enim nihil excepturi dolores suscipit.",
          "status": "Omnis hic officia laudantium id dicta fugiat.",
          "update_at": "Autem expedita animi at quod aut explicabo."
        },
        {
          "description": "Ab enim nihil excepturi dolores suscipit.",
          "status": "Omnis hic officia laudantium id dicta fugiat.",
          "update_at": "Autem expedita animi at quod aut explicabo."
        }
      ],
      "outage_type": "Incident",
      "start_at": "Est ab a nisi et voluptatem commodi.",
      "status": "Enim exercitationem.",
      "title": "Exercitationem quo amet et."
    },
    {
      "description": "Ut in.",
      "duration": 7113594325144523000,
      "end_at": "Omnis asperiores ad officiis quos.",
      "id": "Et eius delectus sed iure.",
      "incident_updates": [
        {
          "description": "Ab enim nihil excepturi dolores suscipit.",
          "status": "Omnis hic officia laudantium id dicta fugiat.",
          "update_at": "Autem expedita animi at quod aut explicabo."
        },
        {
          "description": "Ab enim nihil excepturi dolores suscipit.",
          "status": "Omnis hic officia laudantium id dicta fugiat.",
          "update_at": "Autem expedita animi at quod aut explicabo."
        }
      ],
      "outage_type": "Incident",
      "start_at": "Est ab a nisi et voluptatem commodi.",
      "status": "Enim exercitationem.",
      "title": "Exercitationem quo amet et."
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.