CommunityCare API Documentation

Endpoints:

Authentication and Authorization:

Authentication is required for certain endpoints. Use the following endpoints to obtain and refresh JWT tokens:

• POST /api/token/ - Obtain JWT token
• POST /api/token/refresh/ - Refresh JWT token

Searching:

• ?search=value

Ordering:

• ?ordering=value

Pagination:

• ?page_size=value&page=value

• page_size = resources per page
• page = page number (offset)

Resources:

Location:

• GET /api/locations - List all locations
• POST /api/locations - Create a new location
• GET /api/locations/{id} - Retrieve a single location
• PUT /api/locations/{id} - Update a location
• PATCH /api/locations/{id} - Partially update a location
• DELETE /api/locations/{id} - Delete a location

Family:

• GET /api/families - List all families
• POST /api/families - Create a new family
• GET /api/families/{id} - Retrieve a single family
• PUT /api/families/{id} - Update a family
• PATCH /api/families/{id} - Partially update a family
• DELETE /api/families/{id} - Delete a family

Citizenship:

• GET /api/citizenships - List all citizenships
• POST /api/citizenships - Create a new citizenship
• GET /api/citizenships/{id} - Retrieve a single citizenship
• PUT /api/citizenships/{id} - Update a citizenship
• PATCH /api/citizenships/{id} - Partially update a citizenship
• DELETE /api/citizenships/{id} - Delete a citizenship

Education Attainment:

• GET /api/educational-attainments - List all educational attainments
• POST /api/educational-attainments - Create a new educational attainment
• GET /api/educational-attainments/{id} - Retrieve a single educational attainment
• PUT /api/educational-attainments/{id} - Update an educational attainment
• PATCH /api/educational-attainments/{id} - Partially update an educational attainment
• DELETE /api/educational-attainments/{id} - Delete an educational attainment

Employement Status:

• GET /api/employment-statuses - List all employment statuses
• POST /api/employment-statuses - Create a new employment status
• GET /api/employment-statuses/{id} - Retrieve a single employment status
• PUT /api/employment-statuses/{id} - Update an employment status
• PATCH /api/employment-statuses/{id} - Partially update an employment status
• DELETE /api/employment-statuses/{id} - Delete an employment status

Marital Status:

• GET /api/marital-statuses - List all marital statuses
• POST /api/marital-statuses - Create a new marital status
• GET /api/marital-statuses/{id} - Retrieve a single marital status
• PUT /api/marital-statuses/{id} - Update a marital status
• PATCH /api/marital-statuses/{id} - Partially update a marital status
• DELETE /api/marital-statuses/{id} - Delete a marital status

Member:

• GET /api/members - List all members
• POST /api/members - Create a new member
• GET /api/members/{id} - Retrieve a single member
• PUT /api/members/{id} - Update a member
• PATCH /api/members/{id} - Partially update a member
• DELETE /api/members/{id} - Delete a member