docnetwork / api Goto Github PK

Registrations will be modifiable via PUT request. The only property that can be changed is groupID.

Group can be changed to any parent or child of the original group, provided that it doesn't conflict with another registration (only when reassigning to a parent). We'll expose this original group through originalGroupID.

We'll be adding a route to get all profiles within an organization:

GET /api/organizations/<orgID>/profiles

We have corresponding functionality internally that accepts different parameters that allow filtering, inclusion of related data (medications, allergies, etc), and formatting (CSV, JSON, PDF). While this route will eventually have these features (and will have the capabilities of the list and report builder in the UI), we're starting now with a basic list. We'll incrementally be adding the other features as needed.

Currently, registrations can be created and reviewed. We need to add a route to allow a registration to be deactivated:

DELETE /api/organizations/<orgID>/profiles/<profileID>/registrations/<registrationID>

Sometimes you need a new API key. Maybe you shouted it into a speech-to-text program in a coffee shop. Maybe you want to recycle them on a regular basis. I'm thinking something simple like:

POST /api/refresh-key

It'd respond with a new key in the body. Shouldn't be tied to an org in the URL since the keys are user-specific.

The individual pages are very helpful to understand requests/responses for specific entities.

It would be great to have a few sentences at https://github.com/docnetwork/api/blob/master/v2/README.md that explain at a high-level how the entities interact and generally what sort of information they contain.

@nronnei explained some of the detail to me earlier (thanks!) - as I get more familiar with the API I can contribute a draft of this intro.

I cannot retrievephone or location fields in the GET call for users:

GET /v2/organizations/{orgID}/profiles/{profileID}/users

The docs mention these fields, but I'm not clear on how to retrieve them since the GET response does not include them. I've confirmed via the web UI that there are many users in my organization with phone numbers and locations set, but I do not see it in the API responses.

The contributing guide asks for a X-Request-Identifier header examples in bug requests, but I do not see that response header. I do see a CF-RAY value, which might still serve the same purpose for you? Here's an example:

CF-RAY: 6df99b0aef138c48-EWR

Thank you!

Internally, we cache a measure of "completeness" for each profile's health form. This is an integer from 0 to 100 (or NULL when there's no health form, as with providers).

We can include this property on Profile.

Do you currently have a list of the possible error codes that might be returned via the API? We have recently implemented the API for WinShape Camps and their admin team has asked for this, since we are capturing your error code & text when we encounter an error. Any assistance would be greatly appreciated!