# Organisations

The Organisations API allows authenticated users to manage organisation records. Users can list, create, retrieve, update, and delete organisation entries. Each organisation entry is uniquely identified by a unique_id and contains comprehensive information, including contact details, address, location, and organisation type.

# Get Organisation List

Retrieve a list of all organisations.

URL: resources/organisations/
Method: GET

Response Example:

[
  {
    "unique_id": "12345",
    "organisation_name": "Health Foundation",
    "organisation_registration_number": "HF56789",
    "organisation_type": "NPO",
    "organisation_contact_name": "Jane Doe",
    "organisation_contact_number": "123-456-7890",
    "organisation_contact_email": "contact@healthfoundation.org",
    "organisation_physical_address": "456 Wellness Avenue, Care City",
    "organisation_postal_address": "P.O. Box 7890",
    "organisation_town": "Care City",
    "organisation_region": "North",
    "organisation_province": "Province B",
    "organisation_country": "Country Y",
    "organisation_postal_code": "2002",
    "organisation_phone_number": "123-456-7890",
    "organisation_phone_number_alt": "123-456-7891",
    "organisation_description": "A non-profit organization focused on health and wellness.",
    "organisation_longitude": "-26.20410",
    "organisation_latitude": "28.04730",
    "date_created": "2023-01-01T12:00:00Z",
    "last_updated": "2023-01-05T08:30:00Z"
  },
  ...
]

# Create an Organisation

Create a new organisation entry.

URL: resources/organisations/
Method: POST

Request Example:

{
  "organisation_name": "Health Foundation",
  "organisation_registration_number": "HF56789",
  "organisation_type": "NPO",
  "organisation_contact_name": "Jane Doe",
  "organisation_contact_number": "123-456-7890",
  "organisation_contact_email": "contact@healthfoundation.org",
  "organisation_physical_address": "456 Wellness Avenue, Care City",
  "organisation_postal_address": "P.O. Box 7890",
  "organisation_town": "Care City",
  "organisation_region": "North",
  "organisation_province": "Province B",
  "organisation_country": "Country Y",
  "organisation_postal_code": "2002",
  "organisation_phone_number": "123-456-7890",
  "organisation_phone_number_alt": "123-456-7891",
  "organisation_description": "A non-profit organization focused on health and wellness.",
  "organisation_longitude": "-26.20410",
  "organisation_latitude": "28.04730"
}

Response Example:

{
  "unique_id": "12345",
  "organisation_name": "Health Foundation",
  "organisation_registration_number": "HF56789",
  "organisation_type": "NPO",
  "organisation_contact_name": "Jane Doe",
  "organisation_contact_number": "123-456-7890",
  "organisation_contact_email": "contact@healthfoundation.org",
  "organisation_physical_address": "456 Wellness Avenue, Care City",
  "organisation_postal_address": "P.O. Box 7890",
  "organisation_town": "Care City",
  "organisation_region": "North",
  "organisation_province": "Province B",
  "organisation_country": "Country Y",
  "organisation_postal_code": "2002",
  "organisation_phone_number": "123-456-7890",
  "organisation_phone_number_alt": "123-456-7891",
  "organisation_description": "A non-profit organization focused on health and wellness.",
  "organisation_longitude": "-26.20410",
  "organisation_latitude": "28.04730",
  "date_created": "2023-01-01T12:00:00Z",
  "last_updated": "2023-01-05T08:30:00Z"
}

# Get an Organisation

Retrieve details of a specific organisation by unique ID.

URL: resources/organisations/<str:unique_id>/
Method: GET

Response Example:

{
  "unique_id": "12345",
  "organisation_name": "Health Foundation",
  "organisation_registration_number": "HF56789",
  "organisation_type": "NPO",
  "organisation_contact_name": "Jane Doe",
  "organisation_contact_number": "123-456-7890",
  "organisation_contact_email": "contact@healthfoundation.org",
  "organisation_physical_address": "456 Wellness Avenue, Care City",
  "organisation_postal_address": "P.O. Box 7890",
  "organisation_town": "Care City",
  "organisation_region": "North",
  "organisation_province": "Province B",
  "organisation_country": "Country Y",
  "organisation_postal_code": "2002",
  "organisation_phone_number": "123-456-7890",
  "organisation_phone_number_alt": "123-456-7891",
  "organisation_description": "A non-profit organization focused on health and wellness.",
  "organisation_longitude": "-26.20410",
  "organisation_latitude": "28.04730",
  "date_created": "2023-01-01T12:00:00Z",
  "last_updated": "2023-01-05T08:30:00Z"
}

# Update an Organisation

Update an existing organisation by unique ID.

URL: resources/organisations/<str:unique_id>/
Method: PUT

Request Example:

{
  "organisation_name": "Updated Health Foundation",
  "organisation_description": "Updated description for the organisation."
}

Response Example:

{
  "unique_id": "12345",
  "organisation_name": "Updated Health Foundation",
  "organisation_registration_number": "HF56789",
  "organisation_type": "NPO",
  "organisation_contact_name": "Jane Doe",
  "organisation_contact_number": "123-456-7890",
  "organisation_contact_email": "contact@healthfoundation.org",
  "organisation_physical_address": "456 Wellness Avenue, Care City",
  "organisation_postal_address": "P.O. Box 7890",
  "organisation_town": "Care City",
  "organisation_region": "North",
  "organisation_province": "Province B",
  "organisation_country": "Country Y",
  "organisation_postal_code": "2002",
  "organisation_phone_number": "123-456-7890",
  "organisation_phone_number_alt": "123-456-7891",
  "organisation_description": "Updated description for the organisation.",
  "organisation_longitude": "-26.20410",
  "organisation_latitude": "28.04730",
  "date_created": "2023-01-01T12:00:00Z",
  "last_updated": "2023-01-06T08:30:00Z"
}

# Delete an Organisation

Delete an organisation by unique ID.

URL: resources/organisations/<str:unique_id>/
Method: DELETE
Response: 204 No Content

← Facility