Skip to content

Updated to mention custom error response. #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

Draft
mtaylorfsmb wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Updated to mention custom error response. #8

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
14 changes: 14 additions & 0 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,20 @@ The FCVS API can be used by state medical boards (SMBs) to retrieve information

To learn more about FSMB APIs, refer to the [Getting Started](https://github.com/fsmb/api-docs) guide. To learn more about this API and to begin using it in your code, please contact [FSMB](mailto:fcvs@fsmb.org).

This API currently uses a custom error response instead of the standard [FSMB error response](https://github.com/fsmb/api-docs/docs/errors.md). The format of an error response is given here.

```json
{
"code": "Error code",
"message": "Descriptive message",
"target": "Optional target of the error",
"logId": "The ID of the log entry associated with the error, if any",
"innerError": { },
"data": { }
}
```

If the error was caused by a lower level error, then `innerError` contains the error detail of the child error. Some errors may return additional data in the `data` property. The `code` field identifies the underlying error that occurred while the `message` field provides a developer friendly message.

- URL
- Demo: https://services-fcvs-demo.fsmb.org
Expand Down