{"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

Connecting to the API

\n

MORE

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
EnvironmentURL
UAThttps://vh-more-api-uat.redant.cloud/v1/integration/incidents
Productionhttps://vh-more-api.redant.cloud/v1/integration/incidents
\n

Yellowcard

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
EnvironmentURL
UAThttps://vh-ehr-api-uat.redant.cloud/v1/integration/incidents
Productionhttps://vh-ehr-api.redant.cloud/v1/integration/incidents
\n

Authentication

\n

All requests to the Incidents API require the following headers to be sent.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HeaderValue
authorizationAPI_KEY
X-App-Id7a4a8e1e-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

Getting access

\n

Before 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

X-App-Id

\n

The application ID is assigned to your organisation and is displayed within the developer section.

\n\n\n

API Key

\n

Multiple 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

To create your key:

\n
    \n

  1. Tap on 'Generate API Key'

    \n
    2. \n

  2. Enter a name for your key

    \n
    3. \n
\n\n\n

3. Click 'Generate'
4. The API key will be displayed, copy this and keep safe

\n\n\n

5. When closed the API Key will appear within the table. Each key has the ability to be revoked.

\n\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

The 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\n

When submitting a report via the incident API:

\n\n

Example request

\n
{\n    \"reportType\": \"MIR\",\n     \"envelope\": {\n        \"receiverOrganisation\": {\n            \"id\": \"00000\"\n        }\n    },\n    \"report\": \"XML\"\n}\n\n
\n

Attachments

\n

The 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

Attachments are supported by both MIR and FSCA.

\n
    \n

  1. Send a request to submit a report and include the attachments payload

    \n
      \n
    1. Documented under 'Attachments Payload' within each collection
      2. \n
    \n
    2. \n

  2. Once accepted the endpoint will return an array of pre-signed URLs in the response

    \n
      \n
    1. Example below.
      2. \n
    \n
    3. \n

  3. The sender should upload the files to each pre-signed URL

    \n
      \n

    1. The HTTP method should be PUT

      \n
      2. \n

    2. Content-Type header of the request should match the file being uploaded

      \n
      3. \n
    \n
    4. \n
\n
\n

The pre-signed URL contains the expected content type as a query parameter as Content-Type.
For example the 'Example Response' below shows a pre-signed URL with the content type query value is Content-Type=image/jpeg

\n
\n

Uploading attachments

\n

On 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

Example response

\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

A 200response for a PUT request to the pre-signed URL should be considered as successful and the platform will have the attachment.

\n

Frequently asked questions (FAQs)

\n

You do not have permission to view this

\n
{\n    \"statusCode\": 403,\n    \"code\": \"RA-01-03\",\n    \"message\": \"You do not have permission to view this.\"\n}\n\n
\n

This 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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HeaderValue
authorizationAPI_KEY INSERT_KEY_HERE
X-App-IdINSERT_APP_ID_HERE
\n

For ease of use the Postman collection is setup with environment variables:

\n\n

See Postman documentation on environment variables.

\n
\n

Additional Security Considerations

\n

Incident 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

Incident API Requests

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Connecting to the API","slug":"connecting-to-the-api"},{"content":"Authentication","slug":"authentication"},{"content":"Getting access","slug":"getting-access"},{"content":"Attachments","slug":"attachments"},{"content":"Frequently asked questions (FAQs)","slug":"frequently-asked-questions-faqs"},{"content":"Incident API Requests","slug":"incident-api-requests"}],"owner":"1822051","collectionId":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","publishedId":"Uyxeo8DX","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-05-10T10:09:32.000Z"},"item":[{"name":"Medicines","item":[{"name":"R3","item":[{"name":"Submit a R3 report","item":[{"name":"Example","id":"8fe7577b-e30f-4e62-afc9-41191e075ce1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-App-Id","value":"{{APP_ID}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reportType\": \"R3\",\n \"report\": \"\\n\\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n Drug: PARIET, Reason: N/A\\nReaction: 11-beta-hydroxylase deficiency\\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n tt\\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n 11-beta-hydroxylase deficiency\\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n PARIET\\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n NW22PP\\n \\n \\n \\n \\n \\n \\n Haroon\\n \\n \\n Qadri\\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n Yellowcard\\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/{{VERSION}}/integration/incidents/submit/R3","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","name":"Incident API","type":"collection"}},"urlObject":{"path":["{{VERSION}}","integration","incidents","submit","R3"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"4ba3e6ac-8ddb-45d9-950b-d9f670e5c025","name":"[200] Success","originalRequest":{"method":"POST","header":[{"key":"X-App-Id","value":"{{APP_ID}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reportType\": \"R3\",\n \"report\": \"\\n\\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n Drug: PARIET, Reason: N/A\\nReaction: 11-beta-hydroxylase deficiency\\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n tt\\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n 11-beta-hydroxylase deficiency\\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n PARIET\\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n NW22PP\\n \\n \\n \\n \\n \\n \\n Haroon\\n \\n \\n Qadri\\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n Yellowcard\\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/{{VERSION}}/integration/incidents/submit/R3"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Cowboy"},{"key":"Report-To","value":"{\"group\":\"heroku-nel\",\"max_age\":3600,\"endpoints\":[{\"url\":\"https://nel.heroku.com/reports?ts=1722239930&sid=c4c9725f-1ab0-44d8-820f-430df2718e11&s=hjB4DLzsNkScP69GXgIopVnc9pnIQOtGaMzcgF7gI0g%3D\"}]}"},{"key":"Reporting-Endpoints","value":"heroku-nel=https://nel.heroku.com/reports?ts=1722239930&sid=c4c9725f-1ab0-44d8-820f-430df2718e11&s=hjB4DLzsNkScP69GXgIopVnc9pnIQOtGaMzcgF7gI0g%3D"},{"key":"Nel","value":"{\"report_to\":\"heroku-nel\",\"max_age\":3600,\"success_fraction\":0.005,\"failure_fraction\":0.05,\"response_headers\":[\"Via\"]}"},{"key":"Connection","value":"keep-alive"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Surrogate-Control","value":"no-store"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Language","value":"en"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"124"},{"key":"Etag","value":"W/\"7c-VNlvPPr02PUJup7UePyRsA\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"Date","value":"Mon, 29 Jul 2024 07:58:57 GMT"},{"key":"Via","value":"1.1 vegur"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"report\": {\n \"id\": \"56c3f66b-c425-4016-9b05-4216862026a7\",\n \"extReportId\": \"GB-MHRA-MED-202311291436030850-WZYBQ\"\n }\n}"}],"_postman_id":"8fe7577b-e30f-4e62-afc9-41191e075ce1"}],"id":"d8483ede-aae5-40b7-9e77-7b1604184a18","_postman_id":"d8483ede-aae5-40b7-9e77-7b1604184a18","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","name":"Incident API","type":"collection"}}},{"name":"Validate a R3 report","item":[{"name":"Example","id":"4b15c4af-558a-4969-bf1a-d34338f53720","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-App-Id","value":"{{APP_ID}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reportType\": \"R3\",\n \"report\": \"\\n\\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n Drug: PARIET, Reason: N/A\\nReaction: 11-beta-hydroxylase deficiency\\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n tt\\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n 11-beta-hydroxylase deficiency\\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n PARIET\\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n NW22PP\\n \\n \\n \\n \\n \\n \\n Haroon\\n \\n \\n Qadri\\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n Yellowcard\\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/{{VERSION}}/integration/incidents/submit/R3/validate","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","name":"Incident API","type":"collection"}},"urlObject":{"path":["{{VERSION}}","integration","incidents","submit","R3","validate"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"95473f8b-132d-4d66-9f46-7272a3e5215d","name":"[200] Success","originalRequest":{"method":"POST","header":[{"key":"X-App-Id","value":"{{APP_ID}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reportType\": \"R3\",\n \"report\": \"\\n\\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n Drug: PARIET, Reason: N/A\\nReaction: 11-beta-hydroxylase deficiency\\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n tt\\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n 11-beta-hydroxylase deficiency\\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n PARIET\\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n NW22PP\\n \\n \\n \\n \\n \\n \\n Haroon\\n \\n \\n Qadri\\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n Yellowcard\\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/{{VERSION}}/integration/incidents/submit/R3/validate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Cowboy"},{"key":"Report-To","value":"{\"group\":\"heroku-nel\",\"max_age\":3600,\"endpoints\":[{\"url\":\"https://nel.heroku.com/reports?ts=1722240322&sid=c4c9725f-1ab0-44d8-820f-430df2718e11&s=Os5PpvLepReL0ZI7yt3O%2F7M7NpJ879s9l%2FCL2FIodWE%3D\"}]}"},{"key":"Reporting-Endpoints","value":"heroku-nel=https://nel.heroku.com/reports?ts=1722240322&sid=c4c9725f-1ab0-44d8-820f-430df2718e11&s=Os5PpvLepReL0ZI7yt3O%2F7M7NpJ879s9l%2FCL2FIodWE%3D"},{"key":"Nel","value":"{\"report_to\":\"heroku-nel\",\"max_age\":3600,\"success_fraction\":0.005,\"failure_fraction\":0.05,\"response_headers\":[\"Via\"]}"},{"key":"Connection","value":"keep-alive"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Surrogate-Control","value":"no-store"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Language","value":"en"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"187"},{"key":"Etag","value":"W/\"bb-eIyVNisxNlwGNstK92gTSQ\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"Date","value":"Mon, 29 Jul 2024 08:05:22 GMT"},{"key":"Via","value":"1.1 vegur"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"TEST SUBMISSION. THE REPORT HAS NOT BEEN SUBMITTED.\",\n \"success\": true,\n \"report\": {\n \"id\": \"c1248768-48cc-4f9b-bd4d-251d6c6821e4\",\n \"extReportId\": \"API-EXAMPLE-202407290805225710-TEST\"\n }\n}"}],"_postman_id":"4b15c4af-558a-4969-bf1a-d34338f53720"}],"id":"437d1a4f-bc8a-4744-980f-b534413a9983","description":"

Adding /validate to the Submit API allows the developer to validate the request and if successful will not submit the report into the systems.

\n

This is useful for testing if the XML is well-formed.

\n

The following is an example of the response from the /validate endpoint. The only difference in the response between the /validate and normal endpont is the addtion of message attribute.

\n
{\n  \"message\": \"TEST SUBMISSION. THE REPORT HAS NOT BEEN SUBMITTED.\",\n  \"success\": true,\n  \"report\": {\n    \"id\": \"af6f4d3b-1c45-4cc2-87b9-c05deb0d1589\",\n    \"extReportId\": \"2022/010/010/MO1/080\"\n  }\n}\n\n
\n","_postman_id":"437d1a4f-bc8a-4744-980f-b534413a9983","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","name":"Incident API","type":"collection"}}}],"id":"f3515de8-e957-49e0-9b39-ace36c195d5e","_postman_id":"f3515de8-e957-49e0-9b39-ace36c195d5e","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","name":"Incident API","type":"collection"}}},{"name":"R2","item":[{"name":"Submit a R2 report","item":[{"name":"Example","id":"ad2a636a-2b0b-47c6-a1ef-1366cffd0775","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-App-Id","value":"{{APP_ID}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"report\":\"\\nICHICSR2.12.0GB-IdentifierTest-20210106080726MHRA-WEBRADRMHRAUKTEST204202101060809071GB-IdentifierTest-20210106080726GBGB10220210106122222221022021010610220210106GB-IdentifierTest-20210106080726212GB182Yellow CardGBtest@redant.com2NANAMrMickFoy3.M 151 Buckingham Palace RoadLondonSW1W 9SZGBredsParkinsons\\nPatient has not had symptoms associated with COVID-19\\nPatient is not enrolled in clinical trial\\n\\n23.010061536Parkinsons disease23.0100615361COVID-19 virus testNo - Negative COVID-19 test1(123I)-FP-CIT(123I)-FP-CIT\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/{{VERSION}}/integration/incidents/submit/R2","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","name":"Incident API","type":"collection"}},"urlObject":{"path":["{{VERSION}}","integration","incidents","submit","R2"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"b66d28bf-44c6-4660-a20e-f1e28fb73c46","name":"[200] Success","originalRequest":{"method":"POST","header":[{"key":"X-App-Id","value":"{{APP_ID}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reportType\": \"FSCA\",\n \"report\": \"\\n\\n \\n NCA<\\/ncaName>\\n Initial<\\/reportType>\\n 2022-03-25<\\/reportDate>\\n Manufacturer<\\/mfrInternalNo>\\n 2022/003/025/501/001<\\/ncaReportNo>\\n NCA Competent Authority<\\/ncaCoordinating>\\n <\\/summary>\\n \\n \\n Manufacturer<\\/statusReporter>\\n \\n James<\\/ncpName>\\n Doe<\\/ncpContactPerson>\\n 118 Street<\\/ncpAddress>\\n Liverpool<\\/ncpCity>\\n GB<\\/ncpCountry>\\n EXA 123<\\/ncpPostcode>\\n 0000000000<\\/ncpPhone>\\n <\\/ncpFax>\\n doe.docs@redant.cloud<\\/ncpEmail>\\n <\\/ncpDetails>\\n \\n Red Ant PPE<\\/mfrName>\\n API<\\/mfrContactName>\\n 123 Street<\\/mfrAddress>\\n London<\\/mfrCity>\\n GB<\\/mfrCountry>\\n API D0C5<\\/mfrPostcode>\\n 0000000000<\\/mfrPhone>\\n <\\/mfrFax>\\n api.docs@redant.cloud<\\/mfrEmailAddress>\\n <\\/mfrDetails>\\n \\n John<\\/ARContactPerson>\\n Authorised representative Organisation name<\\/ARName>\\n 321 Street<\\/ARAddress>\\n Manchester<\\/ARCity>\\n GB<\\/ARCountry>\\n DOC A91<\\/ARPostCode>\\n 0000000000<\\/ARPhone>\\n <\\/ARFax>\\n john.docs@redant.cloud<\\/AREmailAddress>\\n <\\/arDetails>\\n <\\/reporterMfr>\\n <\\/contact_info>\\n \\n AIMD Active implants<\\/deviceClass>\\n GMDN<\\/nomenclatureSystem>\\n <\\/nomenclatureCode>\\n 12345<\\/nomenclatureCodeDefinedInText>\\n Red Ant<\\/brandName>\\n 12345<\\/modelNum>\\n 99191819181<\\/serialNum>\\n 81<\\/batchNum>\\n 54321<\\/catalogNum>\\n Windows<\\/deviceSoftwareVer>\\n 2022-01-01<\\/devicemfrDate>\\n 2032-01-01<\\/deviceExpiryDate>\\n Additional details<\\/deviceAccessories>\\n 123<\\/nbIdNum>\\n <\\/deviceDetails>\\n \\n Background reason<\\/fscaBackground>\\n Justification reason<\\/fscaDescription>\\n Actions by user<\\/fscaAdvice>\\n Progress<\\/fscaProgress>\\n 2 months<\\/fscaTimeSchedule>\\n 1<\\/fscaAttachmentFSNEnglish>\\n 0<\\/fscaAttachmentFSNNational>\\n 0<\\/fscaAttachmentFSNOther>\\n <\\/fscaAttachmentOther>\\n Final<\\/fscaAttachmentStatus>\\n Some comments<\\/fscaComments>\\n <\\/fscaDesc>\\n \\n AT<\\/distributionEEA>\\n GB<\\/distributionEEA>\\n AE;AD;AF<\\/distributionOutsideEU>\\n <\\/fscaDistribution>\\n<\\/fsca>\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/{{VERSION}}/integration/incidents/submit/FSCA"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Surrogate-Control","value":"no-store"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Language","value":"en"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"108"},{"key":"ETag","value":"W/\"6c-ByJXmtWaIg3hKAPJw3UBsg\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"Date","value":"Fri, 13 May 2022 09:07:32 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"report\": {\n \"id\": \"26bdd144-80e6-49e4-b156-9b622a97c563\",\n \"extReportId\": \"2022/003/025/501/001\"\n }\n}"},{"id":"261a7676-830d-461a-b09c-65c5d509cebb","name":"[403] Missing X-App-Id header","originalRequest":{"method":"POST","header":[{"key":"X-App-Id","value":"{{APP_ID}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reportType\": \"FSCA\",\n \"report\": \"\\n\\n \\n NCA<\\/ncaName>\\n Initial<\\/reportType>\\n 2022-03-25<\\/reportDate>\\n Manufacturer<\\/mfrInternalNo>\\n 2022/003/025/501/001<\\/ncaReportNo>\\n NCA Competent Authority<\\/ncaCoordinating>\\n <\\/summary>\\n \\n \\n Manufacturer<\\/statusReporter>\\n \\n James<\\/ncpName>\\n Doe<\\/ncpContactPerson>\\n 118 Street<\\/ncpAddress>\\n Liverpool<\\/ncpCity>\\n GB<\\/ncpCountry>\\n EXA 123<\\/ncpPostcode>\\n 0000000000<\\/ncpPhone>\\n <\\/ncpFax>\\n doe.docs@redant.cloud<\\/ncpEmail>\\n <\\/ncpDetails>\\n \\n Example MfrName<\\/mfrName>\\n API<\\/mfrContactName>\\n 123 Street<\\/mfrAddress>\\n London<\\/mfrCity>\\n GB<\\/mfrCountry>\\n API D0C5<\\/mfrPostcode>\\n 0000000000<\\/mfrPhone>\\n <\\/mfrFax>\\n api.docs@redant.cloud<\\/mfrEmailAddress>\\n <\\/mfrDetails>\\n \\n John<\\/ARContactPerson>\\n Authorised representative Organisation name<\\/ARName>\\n 321 Street<\\/ARAddress>\\n Manchester<\\/ARCity>\\n GB<\\/ARCountry>\\n DOC A91<\\/ARPostCode>\\n 0000000000<\\/ARPhone>\\n <\\/ARFax>\\n john.docs@redant.cloud<\\/AREmailAddress>\\n <\\/arDetails>\\n <\\/reporterMfr>\\n <\\/contact_info>\\n \\n AIMD Active implants<\\/deviceClass>\\n GMDN<\\/nomenclatureSystem>\\n <\\/nomenclatureCode>\\n 12345<\\/nomenclatureCodeDefinedInText>\\n Red Ant<\\/brandName>\\n 12345<\\/modelNum>\\n 99191819181<\\/serialNum>\\n 81<\\/batchNum>\\n 54321<\\/catalogNum>\\n Windows<\\/deviceSoftwareVer>\\n 2022-01-01<\\/devicemfrDate>\\n 2032-01-01<\\/deviceExpiryDate>\\n Additional details<\\/deviceAccessories>\\n 123<\\/nbIdNum>\\n <\\/deviceDetails>\\n \\n Background reason<\\/fscaBackground>\\n Justification reason<\\/fscaDescription>\\n Actions by user<\\/fscaAdvice>\\n Progress<\\/fscaProgress>\\n 2 months<\\/fscaTimeSchedule>\\n 1<\\/fscaAttachmentFSNEnglish>\\n 0<\\/fscaAttachmentFSNNational>\\n 0<\\/fscaAttachmentFSNOther>\\n <\\/fscaAttachmentOther>\\n Final<\\/fscaAttachmentStatus>\\n Some comments<\\/fscaComments>\\n <\\/fscaDesc>\\n \\n AT<\\/distributionEEA>\\n GB<\\/distributionEEA>\\n AE;AD;AF<\\/distributionOutsideEU>\\n <\\/fscaDistribution>\\n<\\/fsca>\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/{{VERSION}}/integration/incidents/submit/FSCA"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Surrogate-Control","value":"no-store"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Language","value":"en"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"148"},{"key":"ETag","value":"W/\"94-gzDVyt82eEhp0O1Y6wsRmg\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"Date","value":"Fri, 13 May 2022 09:08:22 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 400,\n \"code\": \"RA-MHR-177-02\",\n \"message\": \"Manufacturer name does not exist.\",\n \"meta\": {\n \"properties\": {\n \"organisationName\": \"Example MfrName\"\n }\n }\n}"},{"id":"d0b87f9c-fedd-4488-92cd-927fca2130be","name":"[403] Missing X-App-Id header","originalRequest":{"method":"POST","header":[{"key":"X-App-Id","value":"{{APP_ID}}","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\n \"reportType\": \"FSCA\",\n \"report\": \"\\n\\n \\n NCA<\\/ncaName>\\n Initial<\\/reportType>\\n 2022-03-25<\\/reportDate>\\n Manufacturer<\\/mfrInternalNo>\\n 2022/003/025/501/001<\\/ncaReportNo>\\n NCA Competent Authority<\\/ncaCoordinating>\\n <\\/summary>\\n \\n \\n Manufacturer<\\/statusReporter>\\n \\n James<\\/ncpName>\\n Doe<\\/ncpContactPerson>\\n 118 Street<\\/ncpAddress>\\n Liverpool<\\/ncpCity>\\n GB<\\/ncpCountry>\\n EXA 123<\\/ncpPostcode>\\n 0000000000<\\/ncpPhone>\\n <\\/ncpFax>\\n doe.docs@redant.cloud<\\/ncpEmail>\\n <\\/ncpDetails>\\n \\n Example MfrName<\\/mfrName>\\n API<\\/mfrContactName>\\n 123 Street<\\/mfrAddress>\\n London<\\/mfrCity>\\n GB<\\/mfrCountry>\\n API D0C5<\\/mfrPostcode>\\n 0000000000<\\/mfrPhone>\\n <\\/mfrFax>\\n api.docs@redant.cloud<\\/mfrEmailAddress>\\n <\\/mfrDetails>\\n \\n John<\\/ARContactPerson>\\n Authorised representative Organisation name<\\/ARName>\\n 321 Street<\\/ARAddress>\\n Manchester<\\/ARCity>\\n GB<\\/ARCountry>\\n DOC A91<\\/ARPostCode>\\n 0000000000<\\/ARPhone>\\n <\\/ARFax>\\n john.docs@redant.cloud<\\/AREmailAddress>\\n <\\/arDetails>\\n <\\/reporterMfr>\\n <\\/contact_info>\\n \\n AIMD Active implants<\\/deviceClass>\\n GMDN<\\/nomenclatureSystem>\\n <\\/nomenclatureCode>\\n 12345<\\/nomenclatureCodeDefinedInText>\\n Red Ant<\\/brandName>\\n 12345<\\/modelNum>\\n 99191819181<\\/serialNum>\\n 81<\\/batchNum>\\n 54321<\\/catalogNum>\\n Windows<\\/deviceSoftwareVer>\\n 2022-01-01<\\/devicemfrDate>\\n 2032-01-01<\\/deviceExpiryDate>\\n Additional details<\\/deviceAccessories>\\n 123<\\/nbIdNum>\\n <\\/deviceDetails>\\n \\n Background reason<\\/fscaBackground>\\n Justification reason<\\/fscaDescription>\\n Actions by user<\\/fscaAdvice>\\n Progress<\\/fscaProgress>\\n 2 months<\\/fscaTimeSchedule>\\n 1<\\/fscaAttachmentFSNEnglish>\\n 0<\\/fscaAttachmentFSNNational>\\n 0<\\/fscaAttachmentFSNOther>\\n <\\/fscaAttachmentOther>\\n Final<\\/fscaAttachmentStatus>\\n Some comments<\\/fscaComments>\\n <\\/fscaDesc>\\n \\n AT<\\/distributionEEA>\\n GB<\\/distributionEEA>\\n AE;AD;AF<\\/distributionOutsideEU>\\n <\\/fscaDistribution>\\n<\\/fsca>\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/{{VERSION}}/integration/incidents/submit/FSCA"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Surrogate-Control","value":"no-store"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Language","value":"en"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"89"},{"key":"ETag","value":"W/\"59-oecqhPxcWoW6Ux/rFcI1Mg\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"Date","value":"Fri, 13 May 2022 09:09:02 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 403,\n \"code\": \"RA-01-02\",\n \"message\": \"You do not have permission to view this.\"\n}"}],"_postman_id":"ad2a636a-2b0b-47c6-a1ef-1366cffd0775"},{"name":"Example with attachments","id":"37129c9a-871d-45cd-b331-ccad5a6a90d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-App-Id","value":"{{APP_ID}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reportType\": \"FSCA\",\n \"envelope\": {\n \"receiverOrganisation\": {\n \"id\": \"00000\"\n }\n },\n \"report\": \"\\n\\n\\n \\n \\n ICHICSR\\n \\n \\n 2.1\\n \\n \\n 2.0\\n \\n \\n GB-ELECTRONICYC-202212040049040820-GKNSL\\n \\n \\n ELECTRONICYC\\n \\n \\n MHRAUKTEST\\n \\n \\n 204\\n \\n \\n 20221204004918\\n \\n \\n \\n \\n 1\\n \\n \\n GB-ELECTRONICYC-202212040049040820-GKNSL\\n \\n \\n GB\\n \\n \\n GB\\n \\n \\n 102\\n \\n \\n 20221205\\n \\n \\n 1\\n \\n \\n 1\\n \\n \\n 2\\n \\n \\n 1\\n \\n \\n 1\\n \\n \\n 1\\n \\n \\n 1\\n \\n \\n 2\\n \\n \\n 102\\n \\n \\n 20221205\\n \\n \\n 102\\n \\n \\n 20221205\\n \\n \\n \\n \\n true\\n \\n \\n GB-ELECTRONICYC-202212040049040820-GKNSL\\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n 2\\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n NW22PP\\n \\n \\n \\n \\n 18\\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n 6\\n \\n \\n Yellowcard\\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n GB\\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n 2\\n \\n \\n NA\\n \\n \\n NA\\n \\n \\n Mr\\n \\n \\n Mick\\n \\n \\n \\n Foy\\n \\n \\n 3.M 151 Buckingham Palace Road\\n \\n \\n London\\n \\n \\n \\n SW1W 9SZ\\n \\n \\n GB\\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n 11-beta-hydroxylase deficiency\\n \\n \\n 24.1\\n \\n \\n 10000002\\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n 1\\n \\n \\n \\n \\n 1\\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n\",\n \"attachments\": [\n {\n \"id\": \"8df1713a-5c53-4e58-b590-03eebf3a3bd9\",\n \"name\": \"photo.jpg\",\n \"title\": \"Doc Title 1\",\n \"comments\": \"This is a comment for an attachment\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/{{VERSION}}/integration/incidents/submit/R2","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","name":"Incident API","type":"collection"}},"urlObject":{"path":["{{VERSION}}","integration","incidents","submit","R2"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"37129c9a-871d-45cd-b331-ccad5a6a90d6"}],"id":"d40df7b5-0819-4b3d-b405-f2ced911a74e","_postman_id":"d40df7b5-0819-4b3d-b405-f2ced911a74e","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","name":"Incident API","type":"collection"}}},{"name":"Validate a R2 report","item":[{"name":"Example","id":"482e938c-9805-421f-a087-20b01dc8f1c6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-App-Id","value":"{{APP_ID}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reportType\": \"R2\",\n \"report\": \"\\n\\n\\n \\n \\n ICHICSR\\n \\n \\n 2.1\\n \\n \\n 2.0\\n \\n \\n GB-ELECTRONICYC-202212040049040820-GKNSL\\n \\n \\n ELECTRONICYC\\n \\n \\n MHRAUKTEST\\n \\n \\n 204\\n \\n \\n 20221204004918\\n \\n \\n \\n \\n 1\\n \\n \\n GB-ELECTRONICYC-202212040049040820-GKNSL\\n \\n \\n GB\\n \\n \\n GB\\n \\n \\n 102\\n \\n \\n 20221205\\n \\n \\n 1\\n \\n \\n 1\\n \\n \\n 2\\n \\n \\n 1\\n \\n \\n 1\\n \\n \\n 1\\n \\n \\n 1\\n \\n \\n 2\\n \\n \\n 102\\n \\n \\n 20221205\\n \\n \\n 102\\n \\n \\n 20221205\\n \\n \\n \\n \\n true\\n \\n \\n GB-ELECTRONICYC-202212040049040820-GKNSL\\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n 2\\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n NW22PP\\n \\n \\n \\n \\n 18\\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n 6\\n \\n \\n Yellowcard\\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n GB\\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n 2\\n \\n \\n NA\\n \\n \\n NA\\n \\n \\n Mr\\n \\n \\n Mick\\n \\n \\n \\n Foy\\n \\n \\n 3.M 151 Buckingham Palace Road\\n \\n \\n London\\n \\n \\n \\n SW1W 9SZ\\n \\n \\n GB\\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n 11-beta-hydroxylase deficiency\\n \\n \\n 24.1\\n \\n \\n 10000002\\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n 1\\n \\n \\n \\n \\n 1\\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/{{VERSION}}/integration/incidents/submit/R2/validate","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","name":"Incident API","type":"collection"}},"urlObject":{"path":["{{VERSION}}","integration","incidents","submit","R2","validate"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"6eabc650-716a-4f80-bd88-00280295e437","name":"[200] Success","originalRequest":{"method":"POST","header":[{"key":"X-App-Id","value":"{{APP_ID}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reportType\": \"FSCA\",\n \"report\": \"\\n\\n \\n NCA<\\/ncaName>\\n Initial<\\/reportType>\\n 2022-03-25<\\/reportDate>\\n Manufacturer<\\/mfrInternalNo>\\n 2022/003/025/501/001<\\/ncaReportNo>\\n NCA Competent Authority<\\/ncaCoordinating>\\n <\\/summary>\\n \\n \\n Manufacturer<\\/statusReporter>\\n \\n James<\\/ncpName>\\n Doe<\\/ncpContactPerson>\\n 118 Street<\\/ncpAddress>\\n Liverpool<\\/ncpCity>\\n GB<\\/ncpCountry>\\n EXA 123<\\/ncpPostcode>\\n 0000000000<\\/ncpPhone>\\n <\\/ncpFax>\\n doe.docs@redant.cloud<\\/ncpEmail>\\n <\\/ncpDetails>\\n \\n Red Ant PPE<\\/mfrName>\\n API<\\/mfrContactName>\\n 123 Street<\\/mfrAddress>\\n London<\\/mfrCity>\\n GB<\\/mfrCountry>\\n API D0C5<\\/mfrPostcode>\\n 0000000000<\\/mfrPhone>\\n <\\/mfrFax>\\n api.docs@redant.cloud<\\/mfrEmailAddress>\\n <\\/mfrDetails>\\n \\n John<\\/ARContactPerson>\\n Authorised representative Organisation name<\\/ARName>\\n 321 Street<\\/ARAddress>\\n Manchester<\\/ARCity>\\n GB<\\/ARCountry>\\n DOC A91<\\/ARPostCode>\\n 0000000000<\\/ARPhone>\\n <\\/ARFax>\\n john.docs@redant.cloud<\\/AREmailAddress>\\n <\\/arDetails>\\n <\\/reporterMfr>\\n <\\/contact_info>\\n \\n AIMD Active implants<\\/deviceClass>\\n GMDN<\\/nomenclatureSystem>\\n <\\/nomenclatureCode>\\n 12345<\\/nomenclatureCodeDefinedInText>\\n Red Ant<\\/brandName>\\n 12345<\\/modelNum>\\n 99191819181<\\/serialNum>\\n 81<\\/batchNum>\\n 54321<\\/catalogNum>\\n Windows<\\/deviceSoftwareVer>\\n 2022-01-01<\\/devicemfrDate>\\n 2032-01-01<\\/deviceExpiryDate>\\n Additional details<\\/deviceAccessories>\\n 123<\\/nbIdNum>\\n <\\/deviceDetails>\\n \\n Background reason<\\/fscaBackground>\\n Justification reason<\\/fscaDescription>\\n Actions by user<\\/fscaAdvice>\\n Progress<\\/fscaProgress>\\n 2 months<\\/fscaTimeSchedule>\\n 1<\\/fscaAttachmentFSNEnglish>\\n 0<\\/fscaAttachmentFSNNational>\\n 0<\\/fscaAttachmentFSNOther>\\n <\\/fscaAttachmentOther>\\n Final<\\/fscaAttachmentStatus>\\n Some comments<\\/fscaComments>\\n <\\/fscaDesc>\\n \\n AT<\\/distributionEEA>\\n GB<\\/distributionEEA>\\n AE;AD;AF<\\/distributionOutsideEU>\\n <\\/fscaDistribution>\\n<\\/fsca>\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/{{VERSION}}/integration/incidents/submit/FSCA/validate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Surrogate-Control","value":"no-store"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Language","value":"en"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"172"},{"key":"ETag","value":"W/\"ac-K8xSwNyok3T1t6+hq0faFw\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"Date","value":"Mon, 10 Oct 2022 15:00:18 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"TEST SUBMISSION. THE REPORT HAS NOT BEEN SUBMITTED.\",\n \"success\": true,\n \"report\": {\n \"id\": \"7f869815-f22a-4496-955b-9beaa8dca1dd\",\n \"extReportId\": \"2022/010/010/MO1/488\"\n }\n}"}],"_postman_id":"482e938c-9805-421f-a087-20b01dc8f1c6"}],"id":"886e7dc9-79c1-4195-944f-46c8fd413555","description":"

Adding /validate to the Submit API allows the developer to validate the request and if successful will not submit the report into the systems.

\n

This is useful for testing if the XML is well-formed.

\n

The following is an example of the response from the /validate endpoint. The only difference in the response between the /validate and normal endpont is the addtion of message attribute.

\n
{\n  \"message\": \"TEST SUBMISSION. THE REPORT HAS NOT BEEN SUBMITTED.\",\n  \"success\": true,\n  \"report\": {\n    \"id\": \"af6f4d3b-1c45-4cc2-87b9-c05deb0d1589\",\n    \"extReportId\": \"2022/010/010/MO1/080\"\n  }\n}\n\n
\n","_postman_id":"886e7dc9-79c1-4195-944f-46c8fd413555","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","name":"Incident API","type":"collection"}}}],"id":"910eda28-2e40-4ed7-8404-c92e03977b0e","_postman_id":"910eda28-2e40-4ed7-8404-c92e03977b0e","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","name":"Incident API","type":"collection"}}}],"id":"9691d6a4-b632-4e08-93bc-ac4e632d3986","_postman_id":"9691d6a4-b632-4e08-93bc-ac4e632d3986","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","name":"Incident API","type":"collection"}}},{"name":"Devices","item":[{"name":"MIR","item":[{"name":"Submit a MIR report","item":[{"name":"Example","id":"47eda1db-73ad-402e-9453-54819d227f01","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-App-Id","value":"{{APP_ID}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reportType\": \"MIR\",\n \"envelope\": {\n \"receiverOrganisation\": {\n \"id\": \"00000\"\n }\n },\n \"report\": \"\\n\\n \\n 2022/003/008/501/008<\\/ncaReportNo>\\n 2022-03-08<\\/reportDate>\\n 2021-12-10<\\/adverseEventDateFrom>\\n 2021-12-10<\\/adverseEventDateTo>\\n \\n \\n \\n GB<\\/reporterOrgCountry>\\n <\\/reporterDetails>\\n \\n Device Mfr example<\\/mfrName>\\n <\\/mfrDetails>\\n <\\/reporterOther>\\n <\\/contact_info>\\n \\n \\n \\n \\n \\n \\n <\\/admin_info>\\n \\n Manufacturer Name<\\/brandName>\\n \\n \\n <\\/distribution>\\n Lateral flow antigen test<\\/IVDDeviceDesc>\\n Laboratory (instrumentation/platform)<\\/productName>\\n <\\/device_info>\\n \\n \\n \\nTest \\n<\\/eventDescription>\\n Patient/user<\\/currentDeviceLocation>\\n <\\/clinical_event_info>\\n \\n \\n Patient<\\/initialReporterRole>\\n MAIDSTONE AND TUNBRIDGE WELLS NHS TRUST<\\/healthcareFacilityName>\\n API<\\/healthcareFacilityContactPersonFirstName>\\n Docs<\\/healthcareFacilityContactPersonSecondName>\\n api-docs@redant.cloud<\\/healthcareFacilityEmail>\\n <\\/initial_reporter_info>\\n <\\/incident_info>\\n \\n \\n \\n \\n \\n \\n <\\/similarIncidents>\\n <\\/mfr_invest>\\n \\n \\n \\n<\\/AdditionalComments>\\n <\\/other_reporting_info>\\n<\\/incident>\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/{{VERSION}}/integration/incidents/submit/MIR","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","name":"Incident API","type":"collection"}},"urlObject":{"path":["{{VERSION}}","integration","incidents","submit","MIR"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"a702a8f4-7e3c-4f34-97cc-8b8dee4d807a","name":"[200] Success","originalRequest":{"method":"POST","header":[{"key":"X-App-Id","value":"{{APP_ID}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reportType\": \"MIR\",\n \"report\": \"\\n\\n \\n 2022/003/008/501/008<\\/ncaReportNo>\\n 2022-03-08<\\/reportDate>\\n 2021-12-10<\\/adverseEventDateFrom>\\n 2021-12-10<\\/adverseEventDateTo>\\n \\n \\n \\n GB<\\/reporterOrgCountry>\\n <\\/reporterDetails>\\n \\n Red Ant PPE<\\/mfrName>\\n <\\/mfrDetails>\\n <\\/reporterOther>\\n <\\/contact_info>\\n \\n \\n \\n \\n \\n \\n <\\/admin_info>\\n \\n Manufacturer Name<\\/brandName>\\n \\n \\n <\\/distribution>\\n Lateral flow antigen test<\\/IVDDeviceDesc>\\n Laboratory (instrumentation/platform)<\\/productName>\\n <\\/device_info>\\n \\n \\n \\nTest \\n<\\/eventDescription>\\n Patient/user<\\/currentDeviceLocation>\\n <\\/clinical_event_info>\\n \\n \\n Patient<\\/initialReporterRole>\\n MAIDSTONE AND TUNBRIDGE WELLS NHS TRUST<\\/healthcareFacilityName>\\n API<\\/healthcareFacilityContactPersonFirstName>\\n Docs<\\/healthcareFacilityContactPersonSecondName>\\n api-docs@redant.cloud<\\/healthcareFacilityEmail>\\n <\\/initial_reporter_info>\\n <\\/incident_info>\\n \\n \\n \\n \\n \\n \\n <\\/similarIncidents>\\n <\\/mfr_invest>\\n \\n \\n \\n<\\/AdditionalComments>\\n <\\/other_reporting_info>\\n<\\/incident>\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/{{VERSION}}/integration/incidents/submit/MIR"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Cowboy"},{"key":"Connection","value":"keep-alive"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Surrogate-Control","value":"no-store"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Language","value":"en"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"108"},{"key":"Etag","value":"W/\"6c-8eyTn5VIj5hwIs4LhM9rXQ\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"Date","value":"Wed, 11 May 2022 08:23:19 GMT"},{"key":"Via","value":"1.1 vegur"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"report\": {\n \"id\": \"20fb9b36-42f0-4804-b07d-61aeea71f529\",\n \"extReportId\": \"2022/003/008/501/008\"\n }\n}"},{"id":"4db34035-b410-4887-8a2f-a64021aa6f90","name":"[400] mfrName name does not belong to submitting credentials","originalRequest":{"method":"POST","header":[{"key":"X-App-Id","value":"{{APP_ID}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reportType\": \"MIR\",\n \"report\": \"\\n\\n \\n 2022/003/008/501/008<\\/ncaReportNo>\\n 2022-03-08<\\/reportDate>\\n 2021-12-10<\\/adverseEventDateFrom>\\n 2021-12-10<\\/adverseEventDateTo>\\n \\n \\n \\n GB<\\/reporterOrgCountry>\\n <\\/reporterDetails>\\n \\n Device Mfr example<\\/mfrName>\\n <\\/mfrDetails>\\n <\\/reporterOther>\\n <\\/contact_info>\\n \\n \\n \\n \\n \\n \\n <\\/admin_info>\\n \\n Manufacturer Name<\\/brandName>\\n \\n \\n <\\/distribution>\\n Lateral flow antigen test<\\/IVDDeviceDesc>\\n Laboratory (instrumentation/platform)<\\/productName>\\n <\\/device_info>\\n \\n \\n \\nTest \\n<\\/eventDescription>\\n Patient/user<\\/currentDeviceLocation>\\n <\\/clinical_event_info>\\n \\n \\n Patient<\\/initialReporterRole>\\n MAIDSTONE AND TUNBRIDGE WELLS NHS TRUST<\\/healthcareFacilityName>\\n API<\\/healthcareFacilityContactPersonFirstName>\\n Docs<\\/healthcareFacilityContactPersonSecondName>\\n api-docs@redant.cloud<\\/healthcareFacilityEmail>\\n <\\/initial_reporter_info>\\n <\\/incident_info>\\n \\n \\n \\n \\n \\n \\n <\\/similarIncidents>\\n <\\/mfr_invest>\\n \\n \\n \\n<\\/AdditionalComments>\\n <\\/other_reporting_info>\\n<\\/incident>\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/{{VERSION}}/integration/incidents/submit/MIR"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Surrogate-Control","value":"no-store"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Language","value":"en"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"151"},{"key":"ETag","value":"W/\"97-x96dfS1DFioZ5ccmrMH54Q\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"Date","value":"Fri, 13 May 2022 09:02:14 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 400,\n \"code\": \"RA-MHR-177-02\",\n \"message\": \"Manufacturer name does not exist.\",\n \"meta\": {\n \"properties\": {\n \"organisationName\": \"Device Mfr example\"\n }\n }\n}"},{"id":"307f4d8c-6915-4c0b-a908-9bc84f7ea590","name":"[403] Missing X-App-Id header","originalRequest":{"method":"POST","header":[{"key":"X-App-Id","value":"{{APP_ID}}","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\n \"reportType\": \"MIR\",\n \"report\": \"\\n\\n \\n 2022/003/008/501/008<\\/ncaReportNo>\\n 2022-03-08<\\/reportDate>\\n 2021-12-10<\\/adverseEventDateFrom>\\n 2021-12-10<\\/adverseEventDateTo>\\n \\n \\n \\n GB<\\/reporterOrgCountry>\\n <\\/reporterDetails>\\n \\n Device Mfr example<\\/mfrName>\\n <\\/mfrDetails>\\n <\\/reporterOther>\\n <\\/contact_info>\\n \\n \\n \\n \\n \\n \\n <\\/admin_info>\\n \\n Manufacturer Name<\\/brandName>\\n \\n \\n <\\/distribution>\\n Lateral flow antigen test<\\/IVDDeviceDesc>\\n Laboratory (instrumentation/platform)<\\/productName>\\n <\\/device_info>\\n \\n \\n \\nTest \\n<\\/eventDescription>\\n Patient/user<\\/currentDeviceLocation>\\n <\\/clinical_event_info>\\n \\n \\n Patient<\\/initialReporterRole>\\n MAIDSTONE AND TUNBRIDGE WELLS NHS TRUST<\\/healthcareFacilityName>\\n API<\\/healthcareFacilityContactPersonFirstName>\\n Docs<\\/healthcareFacilityContactPersonSecondName>\\n api-docs@redant.cloud<\\/healthcareFacilityEmail>\\n <\\/initial_reporter_info>\\n <\\/incident_info>\\n \\n \\n \\n \\n \\n \\n <\\/similarIncidents>\\n <\\/mfr_invest>\\n \\n \\n \\n<\\/AdditionalComments>\\n <\\/other_reporting_info>\\n<\\/incident>\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/{{VERSION}}/integration/incidents/submit/MIR"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Surrogate-Control","value":"no-store"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Language","value":"en"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"89"},{"key":"ETag","value":"W/\"59-oecqhPxcWoW6Ux/rFcI1Mg\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"Date","value":"Fri, 13 May 2022 09:05:39 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 403,\n \"code\": \"RA-01-02\",\n \"message\": \"You do not have permission to view this.\"\n}"}],"_postman_id":"47eda1db-73ad-402e-9453-54819d227f01"},{"name":"Example with attachments","id":"9b7dc934-72de-4559-a328-3456e76648c0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-App-Id","value":"{{APP_ID}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reportType\": \"MIR\",\n \"envelope\": {\n \"receiverOrganisation\": {\n \"id\": \"00000\"\n }\n },\n \"report\": \"\\n\\n \\n 2022/003/008/501/008<\\/ncaReportNo>\\n 2022-03-08<\\/reportDate>\\n 2021-12-10<\\/adverseEventDateFrom>\\n 2021-12-10<\\/adverseEventDateTo>\\n \\n \\n \\n GB<\\/reporterOrgCountry>\\n <\\/reporterDetails>\\n \\n Red Ant PPE<\\/mfrName>\\n <\\/mfrDetails>\\n <\\/reporterOther>\\n <\\/contact_info>\\n \\n \\n \\n \\n \\n \\n <\\/admin_info>\\n \\n Device Mfr example<\\/brandName>\\n \\n \\n <\\/distribution>\\n Lateral flow antigen test<\\/IVDDeviceDesc>\\n Laboratory (instrumentation/platform)<\\/productName>\\n <\\/device_info>\\n \\n \\n \\nTest \\n<\\/eventDescription>\\n Patient/user<\\/currentDeviceLocation>\\n <\\/clinical_event_info>\\n \\n \\n Patient<\\/initialReporterRole>\\n MAIDSTONE AND TUNBRIDGE WELLS NHS TRUST<\\/healthcareFacilityName>\\n API<\\/healthcareFacilityContactPersonFirstName>\\n Docs<\\/healthcareFacilityContactPersonSecondName>\\n api-docs@redant.cloud<\\/healthcareFacilityEmail>\\n <\\/initial_reporter_info>\\n <\\/incident_info>\\n \\n \\n \\n \\n \\n \\n <\\/similarIncidents>\\n <\\/mfr_invest>\\n \\n \\n \\n<\\/AdditionalComments>\\n <\\/other_reporting_info>\\n<\\/incident>\",\n \"attachments\": [\n {\n \"id\": \"8df1713a-5c53-4e58-b590-03eebf3a3bd9\",\n \"name\": \"photo.jpg\",\n \"title\": \"Doc Title 1\",\n \"comments\": \"This is a comment for an attachment\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/{{VERSION}}/integration/incidents/submit/MIR","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","name":"Incident API","type":"collection"}},"urlObject":{"path":["{{VERSION}}","integration","incidents","submit","MIR"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9b7dc934-72de-4559-a328-3456e76648c0"}],"id":"8f5d059f-d060-4466-968f-1e7b5452d9e5","description":"

Payload

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropertyTypeDescription
reportstringXML as a string
envelopeobjectData regarding where the report should be directed to, i.e. receiverOrganisation id.
reportTypestringMIR
attachmentsarray[objects]optional - One-to-many attachments associated to the report
\n

Attachments Payload

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropertyTypeDescription
idstring (uuid/v4)An external reference to the file.
namestringFile name.
titlestringFriendly name of the document.
commentsstringoptional - Additional information about the attachment.
\n

Example Payload

\n
{\n    \"reportType\": \"MIR\",\n     \"envelope\": {\n        \"receiverOrganisation\": {\n            \"id\": \"00000\"\n        }\n    },\n    \"report\": \"XML\",\n    \"attachments\": [\n        {\n            \"id\": \"8df1713a-5c53-4e58-b590-03eebf3a3bd9\",\n            \"name\": \"photo.jpg\",\n            \"title\": \"Doc Title 1\",\n            \"comments\": \"This is a comment for an attachment\"\n        }\n    ]\n}\n\n
\n","_postman_id":"8f5d059f-d060-4466-968f-1e7b5452d9e5","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","name":"Incident API","type":"collection"}}},{"name":"Validate a MIR report","item":[{"name":"Example","id":"014b5e4a-caf4-4954-a692-3e5addad3be2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-App-Id","value":"{{APP_ID}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reportType\": \"MIR\",\n \"report\": \"\\n\\n \\n 2022/003/008/501/008<\\/ncaReportNo>\\n 2022-03-08<\\/reportDate>\\n 2021-12-10<\\/adverseEventDateFrom>\\n 2021-12-10<\\/adverseEventDateTo>\\n \\n \\n \\n GB<\\/reporterOrgCountry>\\n <\\/reporterDetails>\\n \\n Device Mfr example<\\/mfrName>\\n <\\/mfrDetails>\\n <\\/reporterOther>\\n <\\/contact_info>\\n \\n \\n \\n \\n \\n \\n <\\/admin_info>\\n \\n Manufacturer Name<\\/brandName>\\n \\n \\n <\\/distribution>\\n Lateral flow antigen test<\\/IVDDeviceDesc>\\n Laboratory (instrumentation/platform)<\\/productName>\\n <\\/device_info>\\n \\n \\n \\nTest \\n<\\/eventDescription>\\n Patient/user<\\/currentDeviceLocation>\\n <\\/clinical_event_info>\\n \\n \\n Patient<\\/initialReporterRole>\\n MAIDSTONE AND TUNBRIDGE WELLS NHS TRUST<\\/healthcareFacilityName>\\n API<\\/healthcareFacilityContactPersonFirstName>\\n Docs<\\/healthcareFacilityContactPersonSecondName>\\n api-docs@redant.cloud<\\/healthcareFacilityEmail>\\n <\\/initial_reporter_info>\\n <\\/incident_info>\\n \\n \\n \\n \\n \\n \\n <\\/similarIncidents>\\n <\\/mfr_invest>\\n \\n \\n \\n<\\/AdditionalComments>\\n <\\/other_reporting_info>\\n<\\/incident>\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/{{VERSION}}/integration/incidents/submit/MIR/validate","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","name":"Incident API","type":"collection"}},"urlObject":{"path":["{{VERSION}}","integration","incidents","submit","MIR","validate"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"5d5b0bb9-08f3-4ad5-a39c-c08da7ec6887","name":"[200] Success","originalRequest":{"method":"POST","header":[{"key":"X-App-Id","value":"{{APP_ID}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reportType\": \"MIR\",\n \"report\": \"\\n\\n \\n 2022/003/008/501/008<\\/ncaReportNo>\\n 2022-03-08<\\/reportDate>\\n 2021-12-10<\\/adverseEventDateFrom>\\n 2021-12-10<\\/adverseEventDateTo>\\n \\n \\n \\n GB<\\/reporterOrgCountry>\\n <\\/reporterDetails>\\n \\n Test<\\/mfrName>\\n <\\/mfrDetails>\\n <\\/reporterOther>\\n <\\/contact_info>\\n \\n \\n \\n \\n \\n \\n <\\/admin_info>\\n \\n Manufacturer Name<\\/brandName>\\n \\n \\n <\\/distribution>\\n Lateral flow antigen test<\\/IVDDeviceDesc>\\n Laboratory (instrumentation/platform)<\\/productName>\\n <\\/device_info>\\n \\n \\n \\nTest \\n<\\/eventDescription>\\n Patient/user<\\/currentDeviceLocation>\\n <\\/clinical_event_info>\\n \\n \\n Patient<\\/initialReporterRole>\\n MAIDSTONE AND TUNBRIDGE WELLS NHS TRUST<\\/healthcareFacilityName>\\n API<\\/healthcareFacilityContactPersonFirstName>\\n Docs<\\/healthcareFacilityContactPersonSecondName>\\n api-docs@redant.cloud<\\/healthcareFacilityEmail>\\n <\\/initial_reporter_info>\\n <\\/incident_info>\\n \\n \\n \\n \\n \\n \\n <\\/similarIncidents>\\n <\\/mfr_invest>\\n \\n \\n \\n<\\/AdditionalComments>\\n <\\/other_reporting_info>\\n<\\/incident>\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/{{VERSION}}/integration/incidents/submit/MIR/validate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Surrogate-Control","value":"no-store"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Language","value":"en"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"172"},{"key":"ETag","value":"W/\"ac-QA3oETpaA7O2lzoq4DAVPg\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"Date","value":"Mon, 10 Oct 2022 14:57:04 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"TEST SUBMISSION. THE REPORT HAS NOT BEEN SUBMITTED.\",\n \"success\": true,\n \"report\": {\n \"id\": \"af6f4d3b-1c45-4cc2-87b9-c05deb0d1589\",\n \"extReportId\": \"2022/010/010/MO1/080\"\n }\n}"}],"_postman_id":"014b5e4a-caf4-4954-a692-3e5addad3be2"}],"id":"ecb6ce00-a493-4b2d-aac5-56cbc71f7709","description":"

Adding /validate to the Submit API allows the developer to validate the request and if successful will not submit the report into the systems.

\n

This is useful for testing if the XML is well-formed.

\n

The following is an example of the response from the /validate endpoint. The only difference in the response between the /validate and normal endpont is the addtion of message attribute.

\n
{\n  \"message\": \"TEST SUBMISSION. THE REPORT HAS NOT BEEN SUBMITTED.\",\n  \"success\": true,\n  \"report\": {\n    \"id\": \"af6f4d3b-1c45-4cc2-87b9-c05deb0d1589\",\n    \"extReportId\": \"2022/010/010/MO1/080\"\n  }\n}\n\n
\n","_postman_id":"ecb6ce00-a493-4b2d-aac5-56cbc71f7709","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","name":"Incident API","type":"collection"}}}],"id":"9d210203-cdbe-4ca3-92b0-15bcbeca7100","_postman_id":"9d210203-cdbe-4ca3-92b0-15bcbeca7100","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","name":"Incident API","type":"collection"}}},{"name":"FSCA","item":[{"name":"Submit a FSCA report","item":[{"name":"Example","id":"0d7dd771-3a66-4ae2-85b2-0474ee1a5ca8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-App-Id","value":"{{APP_ID}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reportType\": \"FSCA\",\n \"envelope\": {\n \"receiverOrganisation\": {\n \"id\": \"00000\"\n }\n },\n \"report\": \"\\n\\n \\n NCA<\\/ncaName>\\n Initial<\\/reportType>\\n 2022-03-25<\\/reportDate>\\n Manufacturer<\\/mfrInternalNo>\\n 2022/003/025/501/001<\\/ncaReportNo>\\n NCA Competent Authority<\\/ncaCoordinating>\\n <\\/summary>\\n \\n \\n Manufacturer<\\/statusReporter>\\n \\n James<\\/ncpName>\\n Doe<\\/ncpContactPerson>\\n 118 Street<\\/ncpAddress>\\n Liverpool<\\/ncpCity>\\n GB<\\/ncpCountry>\\n EXA 123<\\/ncpPostcode>\\n 0000000000<\\/ncpPhone>\\n <\\/ncpFax>\\n doe.docs@redant.cloud<\\/ncpEmail>\\n <\\/ncpDetails>\\n \\n Example MfrName<\\/mfrName>\\n API<\\/mfrContactName>\\n 123 Street<\\/mfrAddress>\\n London<\\/mfrCity>\\n GB<\\/mfrCountry>\\n API D0C5<\\/mfrPostcode>\\n 0000000000<\\/mfrPhone>\\n <\\/mfrFax>\\n api.docs@redant.cloud<\\/mfrEmailAddress>\\n <\\/mfrDetails>\\n \\n John<\\/ARContactPerson>\\n Authorised representative Organisation name<\\/ARName>\\n 321 Street<\\/ARAddress>\\n Manchester<\\/ARCity>\\n GB<\\/ARCountry>\\n DOC A91<\\/ARPostCode>\\n 0000000000<\\/ARPhone>\\n <\\/ARFax>\\n john.docs@redant.cloud<\\/AREmailAddress>\\n <\\/arDetails>\\n <\\/reporterMfr>\\n <\\/contact_info>\\n \\n AIMD Active implants<\\/deviceClass>\\n GMDN<\\/nomenclatureSystem>\\n <\\/nomenclatureCode>\\n 12345<\\/nomenclatureCodeDefinedInText>\\n Red Ant<\\/brandName>\\n 12345<\\/modelNum>\\n 99191819181<\\/serialNum>\\n 81<\\/batchNum>\\n 54321<\\/catalogNum>\\n Windows<\\/deviceSoftwareVer>\\n 2022-01-01<\\/devicemfrDate>\\n 2032-01-01<\\/deviceExpiryDate>\\n Additional details<\\/deviceAccessories>\\n 123<\\/nbIdNum>\\n <\\/deviceDetails>\\n \\n Background reason<\\/fscaBackground>\\n Justification reason<\\/fscaDescription>\\n Actions by user<\\/fscaAdvice>\\n Progress<\\/fscaProgress>\\n 2 months<\\/fscaTimeSchedule>\\n 1<\\/fscaAttachmentFSNEnglish>\\n 0<\\/fscaAttachmentFSNNational>\\n 0<\\/fscaAttachmentFSNOther>\\n <\\/fscaAttachmentOther>\\n Final<\\/fscaAttachmentStatus>\\n Some comments<\\/fscaComments>\\n <\\/fscaDesc>\\n \\n AT<\\/distributionEEA>\\n GB<\\/distributionEEA>\\n AE;AD;AF<\\/distributionOutsideEU>\\n <\\/fscaDistribution>\\n<\\/fsca>\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/{{VERSION}}/integration/incidents/submit/FSCA","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","name":"Incident API","type":"collection"}},"urlObject":{"path":["{{VERSION}}","integration","incidents","submit","FSCA"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"1caeae6a-02f0-4714-bdae-26062f5557fa","name":"[200] Success","originalRequest":{"method":"POST","header":[{"key":"X-App-Id","value":"{{APP_ID}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reportType\": \"FSCA\",\n \"report\": \"\\n\\n \\n NCA<\\/ncaName>\\n Initial<\\/reportType>\\n 2022-03-25<\\/reportDate>\\n Manufacturer<\\/mfrInternalNo>\\n 2022/003/025/501/001<\\/ncaReportNo>\\n NCA Competent Authority<\\/ncaCoordinating>\\n <\\/summary>\\n \\n \\n Manufacturer<\\/statusReporter>\\n \\n James<\\/ncpName>\\n Doe<\\/ncpContactPerson>\\n 118 Street<\\/ncpAddress>\\n Liverpool<\\/ncpCity>\\n GB<\\/ncpCountry>\\n EXA 123<\\/ncpPostcode>\\n 0000000000<\\/ncpPhone>\\n <\\/ncpFax>\\n doe.docs@redant.cloud<\\/ncpEmail>\\n <\\/ncpDetails>\\n \\n Red Ant PPE<\\/mfrName>\\n API<\\/mfrContactName>\\n 123 Street<\\/mfrAddress>\\n London<\\/mfrCity>\\n GB<\\/mfrCountry>\\n API D0C5<\\/mfrPostcode>\\n 0000000000<\\/mfrPhone>\\n <\\/mfrFax>\\n api.docs@redant.cloud<\\/mfrEmailAddress>\\n <\\/mfrDetails>\\n \\n John<\\/ARContactPerson>\\n Authorised representative Organisation name<\\/ARName>\\n 321 Street<\\/ARAddress>\\n Manchester<\\/ARCity>\\n GB<\\/ARCountry>\\n DOC A91<\\/ARPostCode>\\n 0000000000<\\/ARPhone>\\n <\\/ARFax>\\n john.docs@redant.cloud<\\/AREmailAddress>\\n <\\/arDetails>\\n <\\/reporterMfr>\\n <\\/contact_info>\\n \\n AIMD Active implants<\\/deviceClass>\\n GMDN<\\/nomenclatureSystem>\\n <\\/nomenclatureCode>\\n 12345<\\/nomenclatureCodeDefinedInText>\\n Red Ant<\\/brandName>\\n 12345<\\/modelNum>\\n 99191819181<\\/serialNum>\\n 81<\\/batchNum>\\n 54321<\\/catalogNum>\\n Windows<\\/deviceSoftwareVer>\\n 2022-01-01<\\/devicemfrDate>\\n 2032-01-01<\\/deviceExpiryDate>\\n Additional details<\\/deviceAccessories>\\n 123<\\/nbIdNum>\\n <\\/deviceDetails>\\n \\n Background reason<\\/fscaBackground>\\n Justification reason<\\/fscaDescription>\\n Actions by user<\\/fscaAdvice>\\n Progress<\\/fscaProgress>\\n 2 months<\\/fscaTimeSchedule>\\n 1<\\/fscaAttachmentFSNEnglish>\\n 0<\\/fscaAttachmentFSNNational>\\n 0<\\/fscaAttachmentFSNOther>\\n <\\/fscaAttachmentOther>\\n Final<\\/fscaAttachmentStatus>\\n Some comments<\\/fscaComments>\\n <\\/fscaDesc>\\n \\n AT<\\/distributionEEA>\\n GB<\\/distributionEEA>\\n AE;AD;AF<\\/distributionOutsideEU>\\n <\\/fscaDistribution>\\n<\\/fsca>\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/{{VERSION}}/integration/incidents/submit/FSCA"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Surrogate-Control","value":"no-store"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Language","value":"en"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"108"},{"key":"ETag","value":"W/\"6c-ByJXmtWaIg3hKAPJw3UBsg\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"Date","value":"Fri, 13 May 2022 09:07:32 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"report\": {\n \"id\": \"26bdd144-80e6-49e4-b156-9b622a97c563\",\n \"extReportId\": \"2022/003/025/501/001\"\n }\n}"},{"id":"5b8c7ee7-7673-46ea-b15f-0ae2487da416","name":"[403] Missing X-App-Id header","originalRequest":{"method":"POST","header":[{"key":"X-App-Id","value":"{{APP_ID}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reportType\": \"FSCA\",\n \"report\": \"\\n\\n \\n NCA<\\/ncaName>\\n Initial<\\/reportType>\\n 2022-03-25<\\/reportDate>\\n Manufacturer<\\/mfrInternalNo>\\n 2022/003/025/501/001<\\/ncaReportNo>\\n NCA Competent Authority<\\/ncaCoordinating>\\n <\\/summary>\\n \\n \\n Manufacturer<\\/statusReporter>\\n \\n James<\\/ncpName>\\n Doe<\\/ncpContactPerson>\\n 118 Street<\\/ncpAddress>\\n Liverpool<\\/ncpCity>\\n GB<\\/ncpCountry>\\n EXA 123<\\/ncpPostcode>\\n 0000000000<\\/ncpPhone>\\n <\\/ncpFax>\\n doe.docs@redant.cloud<\\/ncpEmail>\\n <\\/ncpDetails>\\n \\n Example MfrName<\\/mfrName>\\n API<\\/mfrContactName>\\n 123 Street<\\/mfrAddress>\\n London<\\/mfrCity>\\n GB<\\/mfrCountry>\\n API D0C5<\\/mfrPostcode>\\n 0000000000<\\/mfrPhone>\\n <\\/mfrFax>\\n api.docs@redant.cloud<\\/mfrEmailAddress>\\n <\\/mfrDetails>\\n \\n John<\\/ARContactPerson>\\n Authorised representative Organisation name<\\/ARName>\\n 321 Street<\\/ARAddress>\\n Manchester<\\/ARCity>\\n GB<\\/ARCountry>\\n DOC A91<\\/ARPostCode>\\n 0000000000<\\/ARPhone>\\n <\\/ARFax>\\n john.docs@redant.cloud<\\/AREmailAddress>\\n <\\/arDetails>\\n <\\/reporterMfr>\\n <\\/contact_info>\\n \\n AIMD Active implants<\\/deviceClass>\\n GMDN<\\/nomenclatureSystem>\\n <\\/nomenclatureCode>\\n 12345<\\/nomenclatureCodeDefinedInText>\\n Red Ant<\\/brandName>\\n 12345<\\/modelNum>\\n 99191819181<\\/serialNum>\\n 81<\\/batchNum>\\n 54321<\\/catalogNum>\\n Windows<\\/deviceSoftwareVer>\\n 2022-01-01<\\/devicemfrDate>\\n 2032-01-01<\\/deviceExpiryDate>\\n Additional details<\\/deviceAccessories>\\n 123<\\/nbIdNum>\\n <\\/deviceDetails>\\n \\n Background reason<\\/fscaBackground>\\n Justification reason<\\/fscaDescription>\\n Actions by user<\\/fscaAdvice>\\n Progress<\\/fscaProgress>\\n 2 months<\\/fscaTimeSchedule>\\n 1<\\/fscaAttachmentFSNEnglish>\\n 0<\\/fscaAttachmentFSNNational>\\n 0<\\/fscaAttachmentFSNOther>\\n <\\/fscaAttachmentOther>\\n Final<\\/fscaAttachmentStatus>\\n Some comments<\\/fscaComments>\\n <\\/fscaDesc>\\n \\n AT<\\/distributionEEA>\\n GB<\\/distributionEEA>\\n AE;AD;AF<\\/distributionOutsideEU>\\n <\\/fscaDistribution>\\n<\\/fsca>\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/{{VERSION}}/integration/incidents/submit/FSCA"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Surrogate-Control","value":"no-store"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Language","value":"en"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"148"},{"key":"ETag","value":"W/\"94-gzDVyt82eEhp0O1Y6wsRmg\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"Date","value":"Fri, 13 May 2022 09:08:22 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 400,\n \"code\": \"RA-MHR-177-02\",\n \"message\": \"Manufacturer name does not exist.\",\n \"meta\": {\n \"properties\": {\n \"organisationName\": \"Example MfrName\"\n }\n }\n}"},{"id":"4597f89b-4415-4282-a301-759cf301129e","name":"[403] Missing X-App-Id header","originalRequest":{"method":"POST","header":[{"key":"X-App-Id","value":"{{APP_ID}}","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\n \"reportType\": \"FSCA\",\n \"report\": \"\\n\\n \\n NCA<\\/ncaName>\\n Initial<\\/reportType>\\n 2022-03-25<\\/reportDate>\\n Manufacturer<\\/mfrInternalNo>\\n 2022/003/025/501/001<\\/ncaReportNo>\\n NCA Competent Authority<\\/ncaCoordinating>\\n <\\/summary>\\n \\n \\n Manufacturer<\\/statusReporter>\\n \\n James<\\/ncpName>\\n Doe<\\/ncpContactPerson>\\n 118 Street<\\/ncpAddress>\\n Liverpool<\\/ncpCity>\\n GB<\\/ncpCountry>\\n EXA 123<\\/ncpPostcode>\\n 0000000000<\\/ncpPhone>\\n <\\/ncpFax>\\n doe.docs@redant.cloud<\\/ncpEmail>\\n <\\/ncpDetails>\\n \\n Example MfrName<\\/mfrName>\\n API<\\/mfrContactName>\\n 123 Street<\\/mfrAddress>\\n London<\\/mfrCity>\\n GB<\\/mfrCountry>\\n API D0C5<\\/mfrPostcode>\\n 0000000000<\\/mfrPhone>\\n <\\/mfrFax>\\n api.docs@redant.cloud<\\/mfrEmailAddress>\\n <\\/mfrDetails>\\n \\n John<\\/ARContactPerson>\\n Authorised representative Organisation name<\\/ARName>\\n 321 Street<\\/ARAddress>\\n Manchester<\\/ARCity>\\n GB<\\/ARCountry>\\n DOC A91<\\/ARPostCode>\\n 0000000000<\\/ARPhone>\\n <\\/ARFax>\\n john.docs@redant.cloud<\\/AREmailAddress>\\n <\\/arDetails>\\n <\\/reporterMfr>\\n <\\/contact_info>\\n \\n AIMD Active implants<\\/deviceClass>\\n GMDN<\\/nomenclatureSystem>\\n <\\/nomenclatureCode>\\n 12345<\\/nomenclatureCodeDefinedInText>\\n Red Ant<\\/brandName>\\n 12345<\\/modelNum>\\n 99191819181<\\/serialNum>\\n 81<\\/batchNum>\\n 54321<\\/catalogNum>\\n Windows<\\/deviceSoftwareVer>\\n 2022-01-01<\\/devicemfrDate>\\n 2032-01-01<\\/deviceExpiryDate>\\n Additional details<\\/deviceAccessories>\\n 123<\\/nbIdNum>\\n <\\/deviceDetails>\\n \\n Background reason<\\/fscaBackground>\\n Justification reason<\\/fscaDescription>\\n Actions by user<\\/fscaAdvice>\\n Progress<\\/fscaProgress>\\n 2 months<\\/fscaTimeSchedule>\\n 1<\\/fscaAttachmentFSNEnglish>\\n 0<\\/fscaAttachmentFSNNational>\\n 0<\\/fscaAttachmentFSNOther>\\n <\\/fscaAttachmentOther>\\n Final<\\/fscaAttachmentStatus>\\n Some comments<\\/fscaComments>\\n <\\/fscaDesc>\\n \\n AT<\\/distributionEEA>\\n GB<\\/distributionEEA>\\n AE;AD;AF<\\/distributionOutsideEU>\\n <\\/fscaDistribution>\\n<\\/fsca>\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/{{VERSION}}/integration/incidents/submit/FSCA"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Surrogate-Control","value":"no-store"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Language","value":"en"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"89"},{"key":"ETag","value":"W/\"59-oecqhPxcWoW6Ux/rFcI1Mg\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"Date","value":"Fri, 13 May 2022 09:09:02 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 403,\n \"code\": \"RA-01-02\",\n \"message\": \"You do not have permission to view this.\"\n}"}],"_postman_id":"0d7dd771-3a66-4ae2-85b2-0474ee1a5ca8"},{"name":"Example with attachments","id":"8c128138-cabf-41b6-bfac-86acc79217d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-App-Id","value":"{{APP_ID}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reportType\": \"FSCA\",\n \"envelope\": {\n \"receiverOrganisation\": {\n \"id\": \"00000\"\n }\n },\n \"report\": \"\\n\\n \\n NCA<\\/ncaName>\\n Initial<\\/reportType>\\n 2022-03-25<\\/reportDate>\\n Manufacturer<\\/mfrInternalNo>\\n 2022/003/025/501/001<\\/ncaReportNo>\\n NCA Competent Authority<\\/ncaCoordinating>\\n <\\/summary>\\n \\n \\n Manufacturer<\\/statusReporter>\\n \\n James<\\/ncpName>\\n Doe<\\/ncpContactPerson>\\n 118 Street<\\/ncpAddress>\\n Liverpool<\\/ncpCity>\\n GB<\\/ncpCountry>\\n EXA 123<\\/ncpPostcode>\\n 0000000000<\\/ncpPhone>\\n <\\/ncpFax>\\n doe.docs@redant.cloud<\\/ncpEmail>\\n <\\/ncpDetails>\\n \\n Device Mfr example<\\/mfrName>\\n API<\\/mfrContactName>\\n 123 Street<\\/mfrAddress>\\n London<\\/mfrCity>\\n GB<\\/mfrCountry>\\n API D0C5<\\/mfrPostcode>\\n 0000000000<\\/mfrPhone>\\n <\\/mfrFax>\\n api.docs@redant.cloud<\\/mfrEmailAddress>\\n <\\/mfrDetails>\\n \\n John<\\/ARContactPerson>\\n Authorised representative Organisation name<\\/ARName>\\n 321 Street<\\/ARAddress>\\n Manchester<\\/ARCity>\\n GB<\\/ARCountry>\\n DOC A91<\\/ARPostCode>\\n 0000000000<\\/ARPhone>\\n <\\/ARFax>\\n john.docs@redant.cloud<\\/AREmailAddress>\\n <\\/arDetails>\\n <\\/reporterMfr>\\n <\\/contact_info>\\n \\n AIMD Active implants<\\/deviceClass>\\n GMDN<\\/nomenclatureSystem>\\n <\\/nomenclatureCode>\\n 12345<\\/nomenclatureCodeDefinedInText>\\n Red Ant<\\/brandName>\\n 12345<\\/modelNum>\\n 99191819181<\\/serialNum>\\n 81<\\/batchNum>\\n 54321<\\/catalogNum>\\n Windows<\\/deviceSoftwareVer>\\n 2022-01-01<\\/devicemfrDate>\\n 2032-01-01<\\/deviceExpiryDate>\\n Additional details<\\/deviceAccessories>\\n 123<\\/nbIdNum>\\n <\\/deviceDetails>\\n \\n Background reason<\\/fscaBackground>\\n Justification reason<\\/fscaDescription>\\n Actions by user<\\/fscaAdvice>\\n Progress<\\/fscaProgress>\\n 2 months<\\/fscaTimeSchedule>\\n 1<\\/fscaAttachmentFSNEnglish>\\n 0<\\/fscaAttachmentFSNNational>\\n 0<\\/fscaAttachmentFSNOther>\\n <\\/fscaAttachmentOther>\\n Final<\\/fscaAttachmentStatus>\\n Some comments<\\/fscaComments>\\n <\\/fscaDesc>\\n \\n AT<\\/distributionEEA>\\n GB<\\/distributionEEA>\\n AE;AD;AF<\\/distributionOutsideEU>\\n <\\/fscaDistribution>\\n<\\/fsca>\",\n \"attachments\": [\n {\n \"id\": \"8df1713a-5c53-4e58-b590-03eebf3a3bd9\",\n \"name\": \"photo.jpg\",\n \"title\": \"Doc Title 1\",\n \"comments\": \"This is a comment for an attachment\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/{{VERSION}}/integration/incidents/submit/FSCA","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","name":"Incident API","type":"collection"}},"urlObject":{"path":["{{VERSION}}","integration","incidents","submit","FSCA"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8c128138-cabf-41b6-bfac-86acc79217d6"}],"id":"f64a82ff-1638-4574-9984-e6b4832026ea","description":"

Payload

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropertyTypeDescription
reportstringXML as a string
envelopeobjectData regarding where the report should be directed to, i.e. receiverOrganisation id.
reportTypestringFSCA
attachmentsarray[objects]optional - One-to-many attachments associated to the report
\n

Attachments Payload

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropertyTypeDescription
idstring (uuid/v4)An external reference to the file.
namestringFile name.
titlestringFriendly name of the document.
commentsstringoptional - Additional information about the attachment.
\n

Example Payload

\n
{\n    \"reportType\": \"FSCA\",\n    \"report\": \"XML\",\n    \"envelope\": {\n        \"receiverOrganisation\": {\n            \"id\": \"00000\"\n        }\n    },\n    \"attachments\": [\n        {\n            \"id\": \"8df1713a-5c53-4e58-b590-03eebf3a3bd9\",\n            \"name\": \"photo.jpg\",\n            \"title\": \"Doc Title 1\",\n            \"comments\": \"This is a comment for an attachment\"\n        }\n    ]\n}\n\n
\n","_postman_id":"f64a82ff-1638-4574-9984-e6b4832026ea","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","name":"Incident API","type":"collection"}}},{"name":"Validate a FSCA report","item":[{"name":"Example","id":"0fd527d6-8b8a-4381-abd8-472c95c4ba46","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-App-Id","value":"{{APP_ID}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reportType\": \"FSCA\",\n \"report\": \"\\n\\n \\n NCA<\\/ncaName>\\n Initial<\\/reportType>\\n 2022-03-25<\\/reportDate>\\n Manufacturer<\\/mfrInternalNo>\\n 2022/003/025/501/001<\\/ncaReportNo>\\n NCA Competent Authority<\\/ncaCoordinating>\\n <\\/summary>\\n \\n \\n Manufacturer<\\/statusReporter>\\n \\n James<\\/ncpName>\\n Doe<\\/ncpContactPerson>\\n 118 Street<\\/ncpAddress>\\n Liverpool<\\/ncpCity>\\n GB<\\/ncpCountry>\\n EXA 123<\\/ncpPostcode>\\n 0000000000<\\/ncpPhone>\\n <\\/ncpFax>\\n doe.docs@redant.cloud<\\/ncpEmail>\\n <\\/ncpDetails>\\n \\n Example MfrName<\\/mfrName>\\n API<\\/mfrContactName>\\n 123 Street<\\/mfrAddress>\\n London<\\/mfrCity>\\n GB<\\/mfrCountry>\\n API D0C5<\\/mfrPostcode>\\n 0000000000<\\/mfrPhone>\\n <\\/mfrFax>\\n api.docs@redant.cloud<\\/mfrEmailAddress>\\n <\\/mfrDetails>\\n \\n John<\\/ARContactPerson>\\n Authorised representative Organisation name<\\/ARName>\\n 321 Street<\\/ARAddress>\\n Manchester<\\/ARCity>\\n GB<\\/ARCountry>\\n DOC A91<\\/ARPostCode>\\n 0000000000<\\/ARPhone>\\n <\\/ARFax>\\n john.docs@redant.cloud<\\/AREmailAddress>\\n <\\/arDetails>\\n <\\/reporterMfr>\\n <\\/contact_info>\\n \\n AIMD Active implants<\\/deviceClass>\\n GMDN<\\/nomenclatureSystem>\\n <\\/nomenclatureCode>\\n 12345<\\/nomenclatureCodeDefinedInText>\\n Red Ant<\\/brandName>\\n 12345<\\/modelNum>\\n 99191819181<\\/serialNum>\\n 81<\\/batchNum>\\n 54321<\\/catalogNum>\\n Windows<\\/deviceSoftwareVer>\\n 2022-01-01<\\/devicemfrDate>\\n 2032-01-01<\\/deviceExpiryDate>\\n Additional details<\\/deviceAccessories>\\n 123<\\/nbIdNum>\\n <\\/deviceDetails>\\n \\n Background reason<\\/fscaBackground>\\n Justification reason<\\/fscaDescription>\\n Actions by user<\\/fscaAdvice>\\n Progress<\\/fscaProgress>\\n 2 months<\\/fscaTimeSchedule>\\n 1<\\/fscaAttachmentFSNEnglish>\\n 0<\\/fscaAttachmentFSNNational>\\n 0<\\/fscaAttachmentFSNOther>\\n <\\/fscaAttachmentOther>\\n Final<\\/fscaAttachmentStatus>\\n Some comments<\\/fscaComments>\\n <\\/fscaDesc>\\n \\n AT<\\/distributionEEA>\\n GB<\\/distributionEEA>\\n AE;AD;AF<\\/distributionOutsideEU>\\n <\\/fscaDistribution>\\n<\\/fsca>\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/{{VERSION}}/integration/incidents/submit/FSCA/validate","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","name":"Incident API","type":"collection"}},"urlObject":{"path":["{{VERSION}}","integration","incidents","submit","FSCA","validate"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"84967efb-2794-45fd-b358-ad7b46203359","name":"[200] Success","originalRequest":{"method":"POST","header":[{"key":"X-App-Id","value":"{{APP_ID}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reportType\": \"FSCA\",\n \"report\": \"\\n\\n \\n NCA<\\/ncaName>\\n Initial<\\/reportType>\\n 2022-03-25<\\/reportDate>\\n Manufacturer<\\/mfrInternalNo>\\n 2022/003/025/501/001<\\/ncaReportNo>\\n NCA Competent Authority<\\/ncaCoordinating>\\n <\\/summary>\\n \\n \\n Manufacturer<\\/statusReporter>\\n \\n James<\\/ncpName>\\n Doe<\\/ncpContactPerson>\\n 118 Street<\\/ncpAddress>\\n Liverpool<\\/ncpCity>\\n GB<\\/ncpCountry>\\n EXA 123<\\/ncpPostcode>\\n 0000000000<\\/ncpPhone>\\n <\\/ncpFax>\\n doe.docs@redant.cloud<\\/ncpEmail>\\n <\\/ncpDetails>\\n \\n Red Ant PPE<\\/mfrName>\\n API<\\/mfrContactName>\\n 123 Street<\\/mfrAddress>\\n London<\\/mfrCity>\\n GB<\\/mfrCountry>\\n API D0C5<\\/mfrPostcode>\\n 0000000000<\\/mfrPhone>\\n <\\/mfrFax>\\n api.docs@redant.cloud<\\/mfrEmailAddress>\\n <\\/mfrDetails>\\n \\n John<\\/ARContactPerson>\\n Authorised representative Organisation name<\\/ARName>\\n 321 Street<\\/ARAddress>\\n Manchester<\\/ARCity>\\n GB<\\/ARCountry>\\n DOC A91<\\/ARPostCode>\\n 0000000000<\\/ARPhone>\\n <\\/ARFax>\\n john.docs@redant.cloud<\\/AREmailAddress>\\n <\\/arDetails>\\n <\\/reporterMfr>\\n <\\/contact_info>\\n \\n AIMD Active implants<\\/deviceClass>\\n GMDN<\\/nomenclatureSystem>\\n <\\/nomenclatureCode>\\n 12345<\\/nomenclatureCodeDefinedInText>\\n Red Ant<\\/brandName>\\n 12345<\\/modelNum>\\n 99191819181<\\/serialNum>\\n 81<\\/batchNum>\\n 54321<\\/catalogNum>\\n Windows<\\/deviceSoftwareVer>\\n 2022-01-01<\\/devicemfrDate>\\n 2032-01-01<\\/deviceExpiryDate>\\n Additional details<\\/deviceAccessories>\\n 123<\\/nbIdNum>\\n <\\/deviceDetails>\\n \\n Background reason<\\/fscaBackground>\\n Justification reason<\\/fscaDescription>\\n Actions by user<\\/fscaAdvice>\\n Progress<\\/fscaProgress>\\n 2 months<\\/fscaTimeSchedule>\\n 1<\\/fscaAttachmentFSNEnglish>\\n 0<\\/fscaAttachmentFSNNational>\\n 0<\\/fscaAttachmentFSNOther>\\n <\\/fscaAttachmentOther>\\n Final<\\/fscaAttachmentStatus>\\n Some comments<\\/fscaComments>\\n <\\/fscaDesc>\\n \\n AT<\\/distributionEEA>\\n GB<\\/distributionEEA>\\n AE;AD;AF<\\/distributionOutsideEU>\\n <\\/fscaDistribution>\\n<\\/fsca>\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/{{VERSION}}/integration/incidents/submit/FSCA/validate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Surrogate-Control","value":"no-store"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Language","value":"en"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"172"},{"key":"ETag","value":"W/\"ac-K8xSwNyok3T1t6+hq0faFw\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"Date","value":"Mon, 10 Oct 2022 15:00:18 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"TEST SUBMISSION. THE REPORT HAS NOT BEEN SUBMITTED.\",\n \"success\": true,\n \"report\": {\n \"id\": \"7f869815-f22a-4496-955b-9beaa8dca1dd\",\n \"extReportId\": \"2022/010/010/MO1/488\"\n }\n}"}],"_postman_id":"0fd527d6-8b8a-4381-abd8-472c95c4ba46"}],"id":"ae198b78-652d-4662-97d2-9af78dc4e039","description":"

Adding /validate to the Submit API allows the developer to validate the request and if successful will not submit the report into the systems.

\n

This is useful for testing if the XML is well-formed.

\n

The following is an example of the response from the /validate endpoint. The only difference in the response between the /validate and normal endpont is the addtion of message attribute.

\n
{\n  \"message\": \"TEST SUBMISSION. THE REPORT HAS NOT BEEN SUBMITTED.\",\n  \"success\": true,\n  \"report\": {\n    \"id\": \"af6f4d3b-1c45-4cc2-87b9-c05deb0d1589\",\n    \"extReportId\": \"2022/010/010/MO1/080\"\n  }\n}\n\n
\n","_postman_id":"ae198b78-652d-4662-97d2-9af78dc4e039","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","name":"Incident API","type":"collection"}}}],"id":"71c129bd-ec13-484b-bc18-f161532dd7fd","_postman_id":"71c129bd-ec13-484b-bc18-f161532dd7fd","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","name":"Incident API","type":"collection"}}}],"id":"0f983e35-d4ad-4d54-95f2-978558faa3f7","_postman_id":"0f983e35-d4ad-4d54-95f2-978558faa3f7","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","name":"Incident API","type":"collection"}}},{"name":"Bloods","item":[{"name":"SAE","item":[{"name":"Submit a SABRE SAE","item":[{"name":"Example","id":"e115514a-2143-466c-93bc-8974f900918f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-App-Id","value":"{{APP_ID}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reportType\": \"FSCA\",\n \"envelope\": {\n \"receiverOrganisation\": {\n \"id\": \"00000\"\n }\n },\n \"report\": \"\\n\\n \\n NCA<\\/ncaName>\\n Initial<\\/reportType>\\n 2022-03-25<\\/reportDate>\\n Manufacturer<\\/mfrInternalNo>\\n 2022/003/025/501/001<\\/ncaReportNo>\\n NCA Competent Authority<\\/ncaCoordinating>\\n <\\/summary>\\n \\n \\n Manufacturer<\\/statusReporter>\\n \\n James<\\/ncpName>\\n Doe<\\/ncpContactPerson>\\n 118 Street<\\/ncpAddress>\\n Liverpool<\\/ncpCity>\\n GB<\\/ncpCountry>\\n EXA 123<\\/ncpPostcode>\\n 0000000000<\\/ncpPhone>\\n <\\/ncpFax>\\n doe.docs@redant.cloud<\\/ncpEmail>\\n <\\/ncpDetails>\\n \\n Example MfrName<\\/mfrName>\\n API<\\/mfrContactName>\\n 123 Street<\\/mfrAddress>\\n London<\\/mfrCity>\\n GB<\\/mfrCountry>\\n API D0C5<\\/mfrPostcode>\\n 0000000000<\\/mfrPhone>\\n <\\/mfrFax>\\n api.docs@redant.cloud<\\/mfrEmailAddress>\\n <\\/mfrDetails>\\n \\n John<\\/ARContactPerson>\\n Authorised representative Organisation name<\\/ARName>\\n 321 Street<\\/ARAddress>\\n Manchester<\\/ARCity>\\n GB<\\/ARCountry>\\n DOC A91<\\/ARPostCode>\\n 0000000000<\\/ARPhone>\\n <\\/ARFax>\\n john.docs@redant.cloud<\\/AREmailAddress>\\n <\\/arDetails>\\n <\\/reporterMfr>\\n <\\/contact_info>\\n \\n AIMD Active implants<\\/deviceClass>\\n GMDN<\\/nomenclatureSystem>\\n <\\/nomenclatureCode>\\n 12345<\\/nomenclatureCodeDefinedInText>\\n Red Ant<\\/brandName>\\n 12345<\\/modelNum>\\n 99191819181<\\/serialNum>\\n 81<\\/batchNum>\\n 54321<\\/catalogNum>\\n Windows<\\/deviceSoftwareVer>\\n 2022-01-01<\\/devicemfrDate>\\n 2032-01-01<\\/deviceExpiryDate>\\n Additional details<\\/deviceAccessories>\\n 123<\\/nbIdNum>\\n <\\/deviceDetails>\\n \\n Background reason<\\/fscaBackground>\\n Justification reason<\\/fscaDescription>\\n Actions by user<\\/fscaAdvice>\\n Progress<\\/fscaProgress>\\n 2 months<\\/fscaTimeSchedule>\\n 1<\\/fscaAttachmentFSNEnglish>\\n 0<\\/fscaAttachmentFSNNational>\\n 0<\\/fscaAttachmentFSNOther>\\n <\\/fscaAttachmentOther>\\n Final<\\/fscaAttachmentStatus>\\n Some comments<\\/fscaComments>\\n <\\/fscaDesc>\\n \\n AT<\\/distributionEEA>\\n GB<\\/distributionEEA>\\n AE;AD;AF<\\/distributionOutsideEU>\\n <\\/fscaDistribution>\\n<\\/fsca>\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/{{VERSION}}/integration/incidents/submit/FSCA","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","name":"Incident API","type":"collection"}},"urlObject":{"path":["{{VERSION}}","integration","incidents","submit","FSCA"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"76f31173-e720-4433-a6b7-4c95277f37c4","name":"[200] Success","originalRequest":{"method":"POST","header":[{"key":"X-App-Id","value":"{{APP_ID}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reportType\": \"FSCA\",\n \"report\": \"\\n\\n \\n NCA<\\/ncaName>\\n Initial<\\/reportType>\\n 2022-03-25<\\/reportDate>\\n Manufacturer<\\/mfrInternalNo>\\n 2022/003/025/501/001<\\/ncaReportNo>\\n NCA Competent Authority<\\/ncaCoordinating>\\n <\\/summary>\\n \\n \\n Manufacturer<\\/statusReporter>\\n \\n James<\\/ncpName>\\n Doe<\\/ncpContactPerson>\\n 118 Street<\\/ncpAddress>\\n Liverpool<\\/ncpCity>\\n GB<\\/ncpCountry>\\n EXA 123<\\/ncpPostcode>\\n 0000000000<\\/ncpPhone>\\n <\\/ncpFax>\\n doe.docs@redant.cloud<\\/ncpEmail>\\n <\\/ncpDetails>\\n \\n Red Ant PPE<\\/mfrName>\\n API<\\/mfrContactName>\\n 123 Street<\\/mfrAddress>\\n London<\\/mfrCity>\\n GB<\\/mfrCountry>\\n API D0C5<\\/mfrPostcode>\\n 0000000000<\\/mfrPhone>\\n <\\/mfrFax>\\n api.docs@redant.cloud<\\/mfrEmailAddress>\\n <\\/mfrDetails>\\n \\n John<\\/ARContactPerson>\\n Authorised representative Organisation name<\\/ARName>\\n 321 Street<\\/ARAddress>\\n Manchester<\\/ARCity>\\n GB<\\/ARCountry>\\n DOC A91<\\/ARPostCode>\\n 0000000000<\\/ARPhone>\\n <\\/ARFax>\\n john.docs@redant.cloud<\\/AREmailAddress>\\n <\\/arDetails>\\n <\\/reporterMfr>\\n <\\/contact_info>\\n \\n AIMD Active implants<\\/deviceClass>\\n GMDN<\\/nomenclatureSystem>\\n <\\/nomenclatureCode>\\n 12345<\\/nomenclatureCodeDefinedInText>\\n Red Ant<\\/brandName>\\n 12345<\\/modelNum>\\n 99191819181<\\/serialNum>\\n 81<\\/batchNum>\\n 54321<\\/catalogNum>\\n Windows<\\/deviceSoftwareVer>\\n 2022-01-01<\\/devicemfrDate>\\n 2032-01-01<\\/deviceExpiryDate>\\n Additional details<\\/deviceAccessories>\\n 123<\\/nbIdNum>\\n <\\/deviceDetails>\\n \\n Background reason<\\/fscaBackground>\\n Justification reason<\\/fscaDescription>\\n Actions by user<\\/fscaAdvice>\\n Progress<\\/fscaProgress>\\n 2 months<\\/fscaTimeSchedule>\\n 1<\\/fscaAttachmentFSNEnglish>\\n 0<\\/fscaAttachmentFSNNational>\\n 0<\\/fscaAttachmentFSNOther>\\n <\\/fscaAttachmentOther>\\n Final<\\/fscaAttachmentStatus>\\n Some comments<\\/fscaComments>\\n <\\/fscaDesc>\\n \\n AT<\\/distributionEEA>\\n GB<\\/distributionEEA>\\n AE;AD;AF<\\/distributionOutsideEU>\\n <\\/fscaDistribution>\\n<\\/fsca>\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/{{VERSION}}/integration/incidents/submit/FSCA"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Surrogate-Control","value":"no-store"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Language","value":"en"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"108"},{"key":"ETag","value":"W/\"6c-ByJXmtWaIg3hKAPJw3UBsg\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"Date","value":"Fri, 13 May 2022 09:07:32 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"report\": {\n \"id\": \"26bdd144-80e6-49e4-b156-9b622a97c563\",\n \"extReportId\": \"2022/003/025/501/001\"\n }\n}"},{"id":"af1b9827-c9db-4824-9a84-00c78e75adff","name":"[403] Missing X-App-Id header","originalRequest":{"method":"POST","header":[{"key":"X-App-Id","value":"{{APP_ID}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reportType\": \"FSCA\",\n \"report\": \"\\n\\n \\n NCA<\\/ncaName>\\n Initial<\\/reportType>\\n 2022-03-25<\\/reportDate>\\n Manufacturer<\\/mfrInternalNo>\\n 2022/003/025/501/001<\\/ncaReportNo>\\n NCA Competent Authority<\\/ncaCoordinating>\\n <\\/summary>\\n \\n \\n Manufacturer<\\/statusReporter>\\n \\n James<\\/ncpName>\\n Doe<\\/ncpContactPerson>\\n 118 Street<\\/ncpAddress>\\n Liverpool<\\/ncpCity>\\n GB<\\/ncpCountry>\\n EXA 123<\\/ncpPostcode>\\n 0000000000<\\/ncpPhone>\\n <\\/ncpFax>\\n doe.docs@redant.cloud<\\/ncpEmail>\\n <\\/ncpDetails>\\n \\n Example MfrName<\\/mfrName>\\n API<\\/mfrContactName>\\n 123 Street<\\/mfrAddress>\\n London<\\/mfrCity>\\n GB<\\/mfrCountry>\\n API D0C5<\\/mfrPostcode>\\n 0000000000<\\/mfrPhone>\\n <\\/mfrFax>\\n api.docs@redant.cloud<\\/mfrEmailAddress>\\n <\\/mfrDetails>\\n \\n John<\\/ARContactPerson>\\n Authorised representative Organisation name<\\/ARName>\\n 321 Street<\\/ARAddress>\\n Manchester<\\/ARCity>\\n GB<\\/ARCountry>\\n DOC A91<\\/ARPostCode>\\n 0000000000<\\/ARPhone>\\n <\\/ARFax>\\n john.docs@redant.cloud<\\/AREmailAddress>\\n <\\/arDetails>\\n <\\/reporterMfr>\\n <\\/contact_info>\\n \\n AIMD Active implants<\\/deviceClass>\\n GMDN<\\/nomenclatureSystem>\\n <\\/nomenclatureCode>\\n 12345<\\/nomenclatureCodeDefinedInText>\\n Red Ant<\\/brandName>\\n 12345<\\/modelNum>\\n 99191819181<\\/serialNum>\\n 81<\\/batchNum>\\n 54321<\\/catalogNum>\\n Windows<\\/deviceSoftwareVer>\\n 2022-01-01<\\/devicemfrDate>\\n 2032-01-01<\\/deviceExpiryDate>\\n Additional details<\\/deviceAccessories>\\n 123<\\/nbIdNum>\\n <\\/deviceDetails>\\n \\n Background reason<\\/fscaBackground>\\n Justification reason<\\/fscaDescription>\\n Actions by user<\\/fscaAdvice>\\n Progress<\\/fscaProgress>\\n 2 months<\\/fscaTimeSchedule>\\n 1<\\/fscaAttachmentFSNEnglish>\\n 0<\\/fscaAttachmentFSNNational>\\n 0<\\/fscaAttachmentFSNOther>\\n <\\/fscaAttachmentOther>\\n Final<\\/fscaAttachmentStatus>\\n Some comments<\\/fscaComments>\\n <\\/fscaDesc>\\n \\n AT<\\/distributionEEA>\\n GB<\\/distributionEEA>\\n AE;AD;AF<\\/distributionOutsideEU>\\n <\\/fscaDistribution>\\n<\\/fsca>\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/{{VERSION}}/integration/incidents/submit/FSCA"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Surrogate-Control","value":"no-store"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Language","value":"en"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"148"},{"key":"ETag","value":"W/\"94-gzDVyt82eEhp0O1Y6wsRmg\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"Date","value":"Fri, 13 May 2022 09:08:22 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 400,\n \"code\": \"RA-MHR-177-02\",\n \"message\": \"Manufacturer name does not exist.\",\n \"meta\": {\n \"properties\": {\n \"organisationName\": \"Example MfrName\"\n }\n }\n}"},{"id":"5a8082b5-ca08-4142-a40f-090a9812400d","name":"[403] Missing X-App-Id header","originalRequest":{"method":"POST","header":[{"key":"X-App-Id","value":"{{APP_ID}}","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\n \"reportType\": \"FSCA\",\n \"report\": \"\\n\\n \\n NCA<\\/ncaName>\\n Initial<\\/reportType>\\n 2022-03-25<\\/reportDate>\\n Manufacturer<\\/mfrInternalNo>\\n 2022/003/025/501/001<\\/ncaReportNo>\\n NCA Competent Authority<\\/ncaCoordinating>\\n <\\/summary>\\n \\n \\n Manufacturer<\\/statusReporter>\\n \\n James<\\/ncpName>\\n Doe<\\/ncpContactPerson>\\n 118 Street<\\/ncpAddress>\\n Liverpool<\\/ncpCity>\\n GB<\\/ncpCountry>\\n EXA 123<\\/ncpPostcode>\\n 0000000000<\\/ncpPhone>\\n <\\/ncpFax>\\n doe.docs@redant.cloud<\\/ncpEmail>\\n <\\/ncpDetails>\\n \\n Example MfrName<\\/mfrName>\\n API<\\/mfrContactName>\\n 123 Street<\\/mfrAddress>\\n London<\\/mfrCity>\\n GB<\\/mfrCountry>\\n API D0C5<\\/mfrPostcode>\\n 0000000000<\\/mfrPhone>\\n <\\/mfrFax>\\n api.docs@redant.cloud<\\/mfrEmailAddress>\\n <\\/mfrDetails>\\n \\n John<\\/ARContactPerson>\\n Authorised representative Organisation name<\\/ARName>\\n 321 Street<\\/ARAddress>\\n Manchester<\\/ARCity>\\n GB<\\/ARCountry>\\n DOC A91<\\/ARPostCode>\\n 0000000000<\\/ARPhone>\\n <\\/ARFax>\\n john.docs@redant.cloud<\\/AREmailAddress>\\n <\\/arDetails>\\n <\\/reporterMfr>\\n <\\/contact_info>\\n \\n AIMD Active implants<\\/deviceClass>\\n GMDN<\\/nomenclatureSystem>\\n <\\/nomenclatureCode>\\n 12345<\\/nomenclatureCodeDefinedInText>\\n Red Ant<\\/brandName>\\n 12345<\\/modelNum>\\n 99191819181<\\/serialNum>\\n 81<\\/batchNum>\\n 54321<\\/catalogNum>\\n Windows<\\/deviceSoftwareVer>\\n 2022-01-01<\\/devicemfrDate>\\n 2032-01-01<\\/deviceExpiryDate>\\n Additional details<\\/deviceAccessories>\\n 123<\\/nbIdNum>\\n <\\/deviceDetails>\\n \\n Background reason<\\/fscaBackground>\\n Justification reason<\\/fscaDescription>\\n Actions by user<\\/fscaAdvice>\\n Progress<\\/fscaProgress>\\n 2 months<\\/fscaTimeSchedule>\\n 1<\\/fscaAttachmentFSNEnglish>\\n 0<\\/fscaAttachmentFSNNational>\\n 0<\\/fscaAttachmentFSNOther>\\n <\\/fscaAttachmentOther>\\n Final<\\/fscaAttachmentStatus>\\n Some comments<\\/fscaComments>\\n <\\/fscaDesc>\\n \\n AT<\\/distributionEEA>\\n GB<\\/distributionEEA>\\n AE;AD;AF<\\/distributionOutsideEU>\\n <\\/fscaDistribution>\\n<\\/fsca>\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/{{VERSION}}/integration/incidents/submit/FSCA"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Surrogate-Control","value":"no-store"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Language","value":"en"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"89"},{"key":"ETag","value":"W/\"59-oecqhPxcWoW6Ux/rFcI1Mg\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"Date","value":"Fri, 13 May 2022 09:09:02 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 403,\n \"code\": \"RA-01-02\",\n \"message\": \"You do not have permission to view this.\"\n}"}],"_postman_id":"e115514a-2143-466c-93bc-8974f900918f"},{"name":"Example with attachments","id":"9b8ae10c-8ac0-4c42-a0ba-6938bb46093d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-App-Id","value":"{{APP_ID}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reportType\": \"sabre-sae\",\n \"envelope\": {\n \"receiverOrganisation\": {\n \"id\": \"0169\"\n }\n },\n \"report\": {\n \"hvrId\": \"2024/001/018/HV1/009\",\n \"beName\": \"ggg\",\n \"orgCode\": \"0169\",\n \"orgName\": \"Aberdeen And North East Scotland Btc\",\n \"component\": [\n \"2\"\n ],\n \"deviation\": \"3\",\n \"footnotes\": [\n {\n \"id\": \"b07c1c99-05c9-4a8c-a05f-8f4bc08f27b7\",\n \"attachmenturl\": {\n \"url\": \"https://s3.eu-west-1.amazonaws.com/digital-store-private-mhr-dev.redant.cloud/uploads/b07c1c99-05c9-4a8c-a05f-8f4bc08f27b7-3zxpl2.png\",\n \"file\": {\n },\n \"name\": \"b07c1c99-05c9-4a8c-a05f-8f4bc08f27b7-3zxpl2.png\",\n \"type\": \"image/png\",\n \"folderName\": \"uploads\"\n },\n \"attachmentfile\": \"ggg\"\n }\n ],\n \"attachment\": [\n {\n \"id\": \"16c2125e-2be8-457e-9408-3b8da2745e6e\",\n \"attachmenturl\": {\n \"url\": \"https://s3-eu-west-1.amazonaws.com/digital-store-attachments-mhr-dev.redant.cloud/495879b4-6e8d-4cb3-9d03-a49657a97914/b07c1c99-05c9-4a8c-a05f-8f4bc08f27b7/81205830-b2a1-48d9-94c6-6c12854c2d5c-xls.xls\",\n \"file\": {\n },\n \"name\": \"81205830-b2a1-48d9-94c6-6c12854c2d5c-xls.xls\",\n \"type\": \"application/vnd.ms-excel\",\n \"folderName\": \"495879b4-6e8d-4cb3-9d03-a49657a97914/b07c1c99-05c9-4a8c-a05f-8f4bc08f27b7\",\n \"attachmentId\": \"16c2125e-2be8-457e-9408-3b8da2745e6e\"\n },\n \"attachmentfile\": \"xlsx\"\n }\n ],\n \"beReported\": \"1\",\n \"orgAddress\": \"Aberdeen and North East Scotland Blood Transfusion Centre Foresterhill Road Aberdeen\",\n \"eventDateNtf\": \"20050220\",\n \"incidentType\": \"1\",\n \"reportStatus\": \"1\",\n \"submittedNtf\": \"20240118\",\n \"specification\": \"1\",\n \"furtherDetails\": \"hhh\",\n \"reportedLocally\": \"2\",\n \"reporterNameCnf\": \"Mr jac darby\",\n \"reporterNameNtf\": \"Mr jac darby\",\n \"incidentLocation\": \"26\",\n \"originalReporter\": \"0\",\n \"reporterEmailCnf\": \"jac.darby@redant.com\",\n \"reporterEmailNtf\": \"jac.darby@redant.com\",\n \"reporterPhoneCnf\": \"07512089135\",\n \"reporterPhoneNtf\": \"07512089135\",\n \"hospitalConsultant\": \"ggg\",\n \"componentTransfused\": \"2\",\n \"linkedEstablishment\": \"Leanchoil Hospital; Forres\",\n \"reporterPositionCnf\": \"Raconteur \",\n \"reporterPositionNtf\": \"Raconteur \",\n \"localReferenceNumber\": \"ggg\"\n},\n \"attachments\": [\n {\n \"attachmentType\": \"footnotes\",\n \"id\": \"e071471d-b332-45fb-a6ed-f4b802cad4eb\",\n \"description\": \"A footnote without attachment\",\n \"comments\": \"At vero eos et accusamus et iusto odio dignissimos ducimus\",\n \"userFirstName\": \"Tester\",\n \"userLastName\": \"Tester\",\n \"userEmailAddress\": \"test@test.email.com\",\n \"createdAt\": \"2023-12-08T20:13:11.337Z\",\n // When hasFile is false,\n // there is no need to request attachment file via presigned url\n // `true` is assumed if no property is given\n \"hasFile\": false\n },\n {\n \"id\": \"16c2125e-2be8-457e-9408-3b8da2745e6e\",\n \"name\": \"photo.jpg\",\n \"title\": \"Doc Title 1\",\n \"comments\": \"This is a comment for an attachment\"\n },\n {\n \"id\": \"60777456-eab7-4faf-a694-da6547301b1c\",\n \"name\": \"waffles\",\n \"title\": \"Doc Title 1\",\n \"comments\": \"This is a comment for an attachment\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/{{VERSION}}/integration/incidents/submit/sabre-sae","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","name":"Incident API","type":"collection"}},"urlObject":{"path":["{{VERSION}}","integration","incidents","submit","sabre-sae"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9b8ae10c-8ac0-4c42-a0ba-6938bb46093d"}],"id":"4f8e1ffd-7579-4ae2-8451-dec03106e7c1","description":"

Payload

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropertyTypeDescription
reportstringXML as a string
envelopeobjectData regarding where the report should be directed to, i.e. receiverOrganisation id.
reportTypestringFSCA
attachmentsarray[objects]optional - One-to-many attachments associated to the report
\n

Attachments Payload

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropertyTypeDescription
idstring (uuid/v4)An external reference to the file.
namestringFile name.
titlestringFriendly name of the document.
commentsstringoptional - Additional information about the attachment.
\n

Example Payload

\n
{\n    \"reportType\": \"FSCA\",\n    \"report\": \"XML\",\n    \"envelope\": {\n        \"receiverOrganisation\": {\n            \"id\": \"00000\"\n        }\n    },\n    \"attachments\": [\n        {\n            \"id\": \"8df1713a-5c53-4e58-b590-03eebf3a3bd9\",\n            \"name\": \"photo.jpg\",\n            \"title\": \"Doc Title 1\",\n            \"comments\": \"This is a comment for an attachment\"\n        }\n    ]\n}\n\n
\n","_postman_id":"4f8e1ffd-7579-4ae2-8451-dec03106e7c1","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","name":"Incident API","type":"collection"}}}],"id":"39053c5f-fa69-4175-a6c4-7b546be5701b","_postman_id":"39053c5f-fa69-4175-a6c4-7b546be5701b","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","name":"Incident API","type":"collection"}}}],"id":"1422e16a-09eb-4214-9036-4daf4312609c","_postman_id":"1422e16a-09eb-4214-9036-4daf4312609c","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","id":"8762e877-66ab-4f0c-8fff-1cf946ca6d31","name":"Incident API","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"1d8b8947-3a3a-450d-94e7-5043c68bb45a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"95a51693-efcd-43ba-94a4-ffb3d577481e","type":"text/javascript","exec":[""]}}]}