Customer Medical Notes API Documentation

• Overview
• Fields
• Operations
  • List
  • Read
  • Create
  • Replace
  • Update

Overview

This sub-collection contains a customer account's medical notes.

Fields

Name	Type	Restrictions	Required?	Description
id	integer	Automatic	Automatic	The unique identifier of the medical note. This is placed in the URL when making API calls for the medical note.
url	string	Automatic	Automatic	The unique API URL of the medical note.
medical_notes	string	Must not be blank.	Yes	The content of the medical note.
created_at	string (ISO-8601 datetime)	Automatic	Automatic	When the medical note was added to the Capitan database.
updated_at	string (ISO-8601 datetime)	Automatic	Automatic	When the medical note's record in the Capitan database was last updated.

Operations

List

Request
GET /api/customers/35/medical-notes/

Response
200 OK
{
    "count": 2,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 421,
            "url": "https://api.hellocapitan.com/api/customers/35/medical-notes/421/",
            "medical_notes": "I have asthma.",
            ...
        },
        ...
    ]
}

Read

Request
GET /api/customers/35/medical-notes/421/

Response
200 OK
{
    "id": 35,
    "url": "https://api.hellocapitan.com/api/customers/35/medical-notes/421/",
    "medical_notes": "I have asthma.",
    ...
}

Create

Request
POST /api/customers/35/medical-notes/
{
    "medical_notes": "I have asthma and carry an inhaler."
}

Response
201 Created
{
    "id": 713,
    "url": "https://api.hellocapitan.com/api/customers/35/medical-notes/713/",
    "medical_notes": "I have asthma and carry an inhaler.",
    ...
}

Replace

Request
PUT /api/customers/35/medical-notes/713/
{
    "medical_notes": "I have asthma and sometimes carry an inhaler."
}

Response
200 OK
{
    "id": 713,
    "url": "https://api.hellocapitan.com/api/customers/35/medical-notes/713/",
    "medical_notes": "I have asthma and sometimes carry an inhaler.",
    ...
}

Update

Request
PATCH /api/customers/35/medical-notes/713/
{
    "medical_notes": "I have no relevant medical conditions."
}

Response
200 OK
{
    "id": 713,
    "url": "https://api.hellocapitan.com/api/customers/35/medical-notes/713/",
    "medical_notes": "I have no relevant medical conditions.",
    ...
}