{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","name":"Incident API","description":"The Incident API allows importing of R2, R3, MIR or FSCA reports (with or without attachments) for your organisation.\n\n# **Connecting to the API**\n\n**MORE**\n\n| Environment | URL |\n| --- | --- |\n| UAT | [https://vh-more-api-uat.redant.cloud/v1/integration/incidents](https://vh-more-api-uat.redant.cloud/v1/integration/incidents) |\n| Production | [https://vh-more-api.redant.cloud/v1/integration/incidents](https://vh-more-api.redant.cloud/v1/integration/incidents) |\n\n**Yellowcard**\n\n| Environment | URL |\n| --- | --- |\n| UAT | [https://vh-ehr-api-uat.redant.cloud/v1/integration/incidents](https://vh-ehr-api-uat.redant.cloud/v1/integration/incidents) |\n| Production | [https://vh-ehr-api.redant.cloud/v1/integration/incidents](https://vh-ehr-api.redant.cloud/v1/integration/incidents) |\n\n# Authentication\n\nAll requests to the Incidents API require the following headers to be sent.\n\n| Header | Value |\n| --- | --- |\n| authorization | API_KEY |\n| X-App-Id | 7a4a8e1e-cac9-4c0c-9421-52f07dfc737f |\n\n> Replace the values within {{}} with your details i.e. an API Key of '1234' would become 'API_KEY 1234' \n  \n\n# Getting access\n\nBefore making requests to the Incident API a App Id and API Key are required. The ability to view your App ID and create a API Key are within the platform within the 'Developer' area. The 'Developer' area is within the burger menu and is located near the bottom of the list.\n\n> You will need an account on a platform before contining. \n  \n\n## X-App-Id\n\nThe application ID is assigned to your organisation and is displayed within the developer section.\n\n<img src=\"https://s3.eu-west-1.amazonaws.com/adr-mhra-docs-assets.redant.cloud/more/access-keys-blank.png\">\n\n## API Key\n\nMultiple API keys can be generated with a name to help you organise the keys. Once the key has been displayed it will not be shown again, so make sure to copy this before closing the modal.\n\nTo create your key:\n\n1. Tap on 'Generate API Key'\n    \n2. Enter a name for your key\n    \n\n<img src=\"https://s3.eu-west-1.amazonaws.com/adr-mhra-docs-assets.redant.cloud/more/access-keys-create-1.png\">\n\n3\\. Click 'Generate'  \n4\\. The API key will be displayed, copy this and keep safe\n\n<img src=\"https://s3.eu-west-1.amazonaws.com/adr-mhra-docs-assets.redant.cloud/more/access-keys-create-2.png\">\n\n5\\. When closed the API Key will appear within the table. Each key has the ability to be revoked.\n\n<img src=\"https://s3.eu-west-1.amazonaws.com/adr-mhra-docs-assets.redant.cloud/more/access-keys-table.png\">\n\n## Organisation ID(s)\n\n> This section is only relevant for platforms that show the \"Organisation ID\" section within the Developer tile. \n  \n\nThe following table is available in the Developer area which will display the Organisation ID(s) for any manufactuer organisation you are associated to.\n\n<img src=\"https://content.pstmn.io/2234bae5-86ee-446e-aa2c-4e88a1852f37/U2NyZWVuc2hvdCAyMDIzLTAxLTEyIGF0IDE2LjQ1LjMwLnBuZw==\">\n\nWhen submitting a report via the incident API:\n\n- Identify the organisation you want the report to be associated to\n    \n- Copy the organisation id by clicking the 'copy button' on the far right in the table\n    \n- Put the organisation Id in the request body of the API\n    \n\n### Example request\n\n``` json\n{\n    \"reportType\": \"MIR\",\n     \"envelope\": {\n        \"receiverOrganisation\": {\n            \"id\": \"00000\"\n        }\n    },\n    \"report\": \"XML\"\n}\n\n ```\n\n# Attachments\n\nThe API for submitting reports also support the ability to supply attachments; related files to the case. If attachments are supplied the sender will need to follow the attachment workflow.\n\nAttachments are supported by both MIR and FSCA.\n\n1. Send a request to submit a report and include the attachments payload\n    \n    1. Documented under 'Attachments Payload' within each collection\n        \n2. Once accepted the endpoint will return an array of pre-signed URLs in the response\n    \n    1. Example below.\n        \n3. The sender should upload the files to each pre-signed URL\n    \n    1. The HTTP method should be `PUT`\n        \n    2. `Content-Type` header of the request should match the file being uploaded\n        \n\n> The pre-signed URL contains the expected content type as a query parameter as `Content-Type`.  \nFor example the 'Example Response' below shows a pre-signed URL with the content type query value is `Content-Type=image/jpeg` \n  \n\n## Uploading attachments\n\nOn a successful report submissions with attachments the payoad returned will include a the property `attachmenturls`. For each `url` the sender should send a `PUT` request to the supplied pre-signed URL.\n\n> Please note the pre-signedURL is already authorised to make the request. No extra request headers are required. \n  \n\n### Example response\n\n``` json\n{\n    \"success\": true,\n    \"report\": {\n        \"id\": \"81270077-de6a-451f-8887-b23f3359a076\",\n        \"extReportId\": \"2022/000/000/501/000\"\n    },\n    \"attachmenturls\": [\n        {\n            \"id\": \"8df1713a-5c53-4e58-b590-03eebf3a3bd9\",\n            \"url\": \"https://s3-eu-west-1.amazonaws.com/hostname.redant.cloud/ab951055-ffe7-45be-ae15-94cb56a2c282/d30fb7f4-6447-49d3-968a-35f2583eb288/photo.jpg?AWSAccessKeyId=TESTABCD123ABCD123&Content-Type=image/jpeg&Expires=1652515565&Signature=8dlKM9TH9EgnsybeWJFH+WE1ngE=&x-amz-meta-applicationid=cc2b7113-a1e8-4495-8e98-0c6999e99c36&x-amz-meta-attachmentid=cc2b7113-a1e8-4495-8e98-0c6999e99c36&x-amz-meta-requestedate=2022-02-13T08:06:05.926Z\"\n        }\n    ]\n}\n\n ```\n\nA `200`response for a `PUT` request to the pre-signed URL should be considered as successful and the platform will have the attachment.\n\n# Frequently asked questions (FAQs)\n\n## You do not have permission to view this\n\n``` json\n{\n    \"statusCode\": 403,\n    \"code\": \"RA-01-03\",\n    \"message\": \"You do not have permission to view this.\"\n}\n\n ```\n\nThis error when making a request indicates there is an issue with the authorization headers. The request has been defined. Please ensure the following headers are defined:\n\n| Header | Value |\n| --- | --- |\n| authorization | API_KEY **INSERT_KEY_HERE** |\n| X-App-Id | **INSERT_APP_ID_HERE** |\n\nFor ease of use the Postman collection is setup with environment variables:\n\n- APP_ID\n    \n- API_KEY\n    \n\nSee Postman documentation on [environment variables](https://learning.postman.com/docs/sending-requests/variables/variables-intro/).\n\n---\n\n## Additional Security Considerations\n\nIncident API requires a secure connection using TLS 1.2 or TLS 1.3. This is a security measure to ensure data integrity and confidentiality during transmission.\n\n# Incident API Requests","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"1822051","team":129542,"collectionId":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","publishedId":"Uyxeo8DX","public":true,"publicUrl":"https://more-developer-api.redant.cloud","privateUrl":"https://go.postman.co/documentation/1822051-8762e877-66ab-4f0c-8fff-1cf946ca6d31","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2022-05-10T10:09:32.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/7ae76f9c1adc6f225b26c2d033276c190a3fecfbe7a7fcc65e75d5bff5e8ec50","favicon":"https://redant.cloud/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://more-developer-api.redant.cloud/view/metadata/Uyxeo8DX"}