{ "produces": [ "application/json; version=DEV", "application/json; version=QA", "application/json; version=STG", "application/json; version=2", "application/json" ], "schemes": [ "https" ], "swagger": "2.0", "info": { "title": "Alerts", "description": "Access International SOS alerts. Keys will generally provide access to\nmultiple API versions; keys will provide access to a single audience\n(client, partner, or thirdparty).\n\nExample accessing V2 of the API with curl:\n
\n curl -s -H \"Accept:application/json; version=STG\" \\\n -H Authorization:AUTHORIZATION_KEY \\\n https://api.internationalsos.com/alert/alerts\n\n\nExample of accessing V3 of the API with curl; note the required\nAccept-Language header:\n
\n curl -s -H \"Accept:application/json; version=3\" \\\n -H Authorization:AUTHORIZATION_KEY \\\n -H Accept-Language:en-GB \\\n https://api.internationalsos.com/client/full\n\n\nExample source code for accessing the API ([Go](https://golang.org)):\n\n
\n package main\n //\n import (\n \"fmt\"\n \"io/ioutil\"\n \"net/http\"\n \"os\"\n )\n //\n func main() {\n req, _ := http.NewRequest(\"GET\", \"https://api.internationalsos.com/alert/alerts\", nil)\n // International SOS authorization tokens are passed via HTTP header. Note this is NOT\n // a BASIC authentication header.\n req.Header.Set(\"Authorization\", os.Getenv(\"KEY\"))\n // This is a required header. We recommend using the versioned form to prevent breakages in API changes.\n req.Header.Set(\"Accept\", \"application/json; version=STG\")\n client := http.Client{}\n resp, _ := client.Do(req)\n defer resp.Body.Close()\n data, _ := ioutil.ReadAll(resp.Body)\n fmt.Println(string(data))\n }\n\n\nNote that you can download the raw Swagger YAML and import it into the\n[Swagger Editor](https://editor.swagger.io), which can generate language\nbinding libraries 44 different programming languages.\n", "termsOfService": "Please see your license for TOS details.", "version": "3.1.0" }, "host": "api.internationalsos.com", "basePath": "/alert", "paths": { "/summaries": { "get": { "tags": [ "Version 2" ], "summary": "Alert summaries", "description": "Returns summaries for all active Articles and Alerts. Parameters can\nfilter articles that have changed in either the past N hours, or since\na given date. If no parameters are provided, all active articles are\nreturned. Only active articles are returned in any case.\n", "parameters": [ { "name": "within", "in": "query", "description": "Retrieve only articles changed within this number of previous hours.", "type": "integer", "required": false }, { "name": "since", "in": "query", "description": "Retrieve only articles changed since this date. Overrides\n`within`. The value must conform to RFC3339.\n", "type": "string", "format": "date-time", "required": false } ], "responses": { "200": { "description": "success", "schema": { "$ref": "#/definitions/summary" } } } } }, "/alerts": { "get": { "tags": [ "Version 2" ], "summary": "Alerts and Articles", "description": "Returns all active Articles and Alerts. Parameters can filter articles\nthat have changed in either the past N hours, or since a given date.\nIf no parameters are provided, all active articles are returned. Only\nactive articles are returned in any case.\n", "parameters": [ { "name": "within", "in": "query", "description": "Retrieve only articles changed within this number of previous hours.", "type": "integer", "required": false }, { "name": "since", "in": "query", "description": "Retrieve only articles changed since this date. Overrides\n`within`. The value must conform to RFC3339.\n", "type": "string", "format": "date-time", "required": false } ], "responses": { "200": { "description": "success", "schema": { "$ref": "#/definitions/article" } } } } }, "/headlines": { "get": { "tags": [ "Version 2" ], "summary": "Executive Summary (Security)", "description": "Security alert headlines and executive summary information\n", "responses": { "200": { "description": "success", "schema": { "$ref": "#/definitions/headline" } } } } }, "/version": { "get": { "tags": [ "Version 2" ], "summary": "The currently deployed version of this service", "description": "This service allows querying the application directly to\nidentify which version is deployed. http://semver.org/ is followed,\nand only the major revision is identified in the content negotiation.\n", "produces": [ "text/plain; version=DEV", "text/plain; version=QA", "text/plain; version=STG", "text/plain; version=2", "text/plain" ], "responses": { "200": { "description": "success", "schema": { "type": "string" } } } } }, "/client/full": { "get": { "tags": [ "Version 3 (Clients)" ], "summary": "Alerts API endpoint for clients - full view", "description": "Sample request: \r\n\r\n GET /client/full\r\n\r\nParameter Examples:\r\n\r\n Optional:\r\n {\r\n \"Regions\": 9,10,11\r\n \"Severities\": 1,2\r\n \"Categories\": Terror attack,Explosion\r\n \"Countries\": AFG,GBR\r\n }", "operationId": "Alerts_Find_client_full", "consumes": [], "produces": [ "application/json; version=3", "text/json; version=3", "application/xml; version=3", "text/xml; version=3" ], "parameters": [ { "name": "alertId", "in": "query", "description": "ID of an item\r\n\r\nValid values: a Guid \r\n\r\nDefault value: return all", "required": false, "type": "string", "format": "uuid" }, { "name": "globalOnly", "in": "query", "description": "If true, then includes all items covering more than one region OR any alerts with a 'worldwide' impact\r\n\r\nValid Values: true, false\r\n \r\nDefault value: false", "required": false, "type": "boolean" }, { "name": "status", "in": "query", "description": "The publish status\r\n\r\nValid values: Live, Archived, All \r\n\r\nDefault value: Live", "required": false, "type": "string", "enum": [ "Live", "Archived", "All" ] }, { "name": "startActive", "in": "query", "description": "Return items that are active on or after this date \r\n\r\nValid values: ISO 8601 date formatted date e.g. 2017-04-05T14:30:00Z\r\n\r\nDefault value: min date", "required": false, "type": "string", "format": "date-time" }, { "name": "endActive", "in": "query", "description": "Return items that are active on or before this date \r\n\r\nValid values: ISO 8601 date formatted date e.g. 2017-04-05T14:30:00Z\r\n\r\nDefault value: max date", "required": false, "type": "string", "format": "date-time" }, { "name": "startEvent", "in": "query", "description": "Return items with event start date on or after this date \r\n\r\nValid values: ISO 8601 date formatted date e.g. 2017-04-05T14:30:00Z\r\n\r\nDefault value: max date", "required": false, "type": "string", "format": "date-time" }, { "name": "endEvent", "in": "query", "description": "Return items with event end date on or before this date \r\n\r\nValid values: ISO 8601 date formatted date e.g. 2017-04-05T14:30:00Z\r\n\r\nDefault value: max date", "required": false, "type": "string", "format": "date-time" }, { "name": "regions", "in": "query", "description": "One or more impact regions\r\n\r\nValid Values: Americas = 9, Asia & Pacific = 10, Aftrica = 11, Europe & CIS = 12, Mid East & N Aftrica = 13", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "services", "in": "query", "description": "Services recipieint has subscribed to. \r\n\r\nValid Values: Medical, Security\r\n\r\nDefault value: all", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "severities", "in": "query", "description": "Alert severity\r\n\r\nValid values: Notice = 1, Advisory = 2, Special Advisory = 3, Warning = 4, Stand-by = 5, Evacuate: Non-Essential Staff = 6, Evacuate: Full Evacuation = 7\r\n\r\nDefault value: all", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "categories", "in": "query", "description": "Categories\r\n\r\nValid values: any valid category name (refer to taxonomy) e.g. Terror attack, Explosion\r\n\r\nDefault value: all", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "Accept-Language", "in": "header", "description": "The alert language as a 5-letter language code \r\n\r\nValid values: en-GB, ja-JP, zh-CN, ko-KR, fr-FR, de-DE, it-IT, es-ES", "required": true, "type": "string" }, { "name": "startPublish", "in": "query", "description": "Return items published on or after this date \r\n\r\nValid values: ISO 8601 date formatted date (default min date) e.g. 2017-04-05T14:30:00Z", "required": false, "type": "string", "format": "date-time" }, { "name": "endPublish", "in": "query", "description": "Return items published on or before this date \r\n\r\nValid values: ISO 8601 date formatted date (default max date) e.g. 2017-04-05T14:30:00Z", "required": false, "type": "string", "format": "date-time" }, { "name": "countries", "in": "query", "description": "One or more impact countries\r\n\r\nValid Values: 3 letter iso country code e.g GBR\r\n\r\nLimit: 20", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "sort", "in": "query", "description": "Field to sort by\r\n\r\nValid values: any field that exists in output e.g -published will sort via published field in descending order, +published will sort via published field in ascending order", "required": false, "type": "string" }, { "name": "page", "in": "query", "description": "Page number in the results to return\r\n\r\nValid values: any integer\r\n\r\nDefault value: 1", "required": false, "type": "integer", "format": "int32" }, { "name": "pageSize", "in": "query", "description": "Number of results in a page \r\n\r\nValid values: any integer between 1 and 250\r\n\r\nDefault value: 50", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Client_Full" }, "examples": { "application/json": { "Alerts": [ { "Assessment": "", "ManagerAdvice": "", "MoreDetail": "", "TravellerAdvice": "