Skip to content

US82995 - [PI2] Enabler - Review and document current state #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 10, 2023
Merged

US82995 - [PI2] Enabler - Review and document current state #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions docs/errors.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
When things go wrong, the API would respond with an error code and a human readable description to describe the incorrect submission. Currently the error code is given in the form of Operation Outcome and can have different options as given below. If you need more information, please reach out to [[email protected]](mailto:[email protected]).

## Response

??? Error "Error Payload Example"
```json
{
"resourceType": "OperationOutcome",
"issue": [
{
"severity": "error",
"code": "value",
"details": {
"text": "Unable to find sponsor with partner id"
}
}
]
}

```

### Error Codes

| Error Code | Issue Type | Description |
| ----------- | ------- | ---------------------------------- |
| 403 - Access to sponsor denied | Security | The partner ID does not have access to the Sponsor id provided. |
| 403 - Access to protocol denied. | Security | The partner ID doesn't have access to the Research Study/Protocol provided. |
| 403 - Access to sponsor and protocol denied | Security | The partner Id does not have access to the Sponsor and Protocol/Research Study given. |
| 401 - Incorrect Partnerid name. | Error | The header should contain `x-partnerid` with provided Partner Id parameter. |
| 401 - Api Key was not provided. | Error | Missing Partner Id parameter value in the request header. |
| 400 - Missing required query parameter. | Error | The required parameter Research Study or Sponsor Id is not provided. |
| 404 - Unable to find sponsor with partner id | Error | The sponsor is not associated with the given Partner Id. |
| 404 - Internal Error. | Exception | Internal Error occured while executing the request. |
| 404 - No records found. | Information | No records were found for the given request |
1 change: 1 addition & 0 deletions docs/release-notes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
- Release of new resources
- Diagnostic Report (Response data)
- Observation (Response Imaging - lesion measurements)
- Group

## Version 2.0.0
August 2022
Expand Down
Loading