To see ChoiceField choices, click on Choices
In choices you'll see 2 things: "value" and "meaning".
"Meaning" is human-understandable description of value. It's used only for choice field rendering, but doesn't take any part in logic/data processing.
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| name | Name |
| custom_report_name | Custom Report Name |
| title | Title |
| description | Description |
| status | Status |
| rows_count | Rows Count |
| exported_rows_count | Exported Rows Count |
| args | Args |
| type | Type |
| start_time | Start Time |
| end_time | End Time |
| user | User |
| errors | Errors |
| is_custom | Is Custom |
| start_date | Start Date |
| end_date | End Date |
| list_size | List Size |
| Value | Meaning |
|---|---|
| Q | Queued |
| E | Exporting... |
| P | Preparing Download... |
| F | Failed |
| D | Click To Download |
| Value | Meaning |
|---|---|
| C | CSV |
| P |
| Value | Meaning |
|---|---|
| 5 | 5 |
| 10 | 10 |
| 20 | 20 |
| 50 | 50 |
| 100 | 100 |
| 300 | 300 |
| 500 | 500 |
| 800 | 800 |
| 1000 | 1000 |
| 10000 | 10000 |
{
"profile":{response fields below},
"token":{..}
}
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| AllowOnlyPostRequests | Custom permission to allow only GET requests. |
| Param name | Description |
|---|---|
| password | Password |
| last_login | Last Login |
| is_superuser | Is Superuser |
| groups | Groups |
| user_permissions | User Permissions |
| username | Username |
| first_name | First Name |
| last_name | Last Name |
| is_staff | Is Staff |
| is_active | Is Active |
| date_joined | Date Joined |
| last_activity | Last Activity |
| role | Role |
| phone | Phone |
| google_profile_image | Google Profile Image |
| confirm_code | Confirm Code |
| reset_code | Reset Code |
| old_password | Old Password |
| changed_password | Changed Password |
| verified | Verified |
| dummy | Dummy |
| available | Available |
| dob | Dob |
| gender | Gender |
| allow_messages_import | Allow Messages Import |
| filter_args | Filter Args |
| novu_added | Novu Added |
| is_a_vet | Is A Vet |
| min_subscription_days_remaining | Min Subscription Days Remaining |
| max_subscription_days_remaining | Max Subscription Days Remaining |
| Value | Meaning |
|---|---|
| N | Normal |
| A | Admin |
| C | Customer Care |
| T | Technician |
| Value | Meaning |
|---|---|
| M | Male |
| F | Female |
| RNS | Rather Not Say |
| Value | Meaning |
|---|---|
| N | Normal |
| A | Admin |
| C | Customer Care |
| T | Technician |
| Value | Meaning |
|---|---|
| M | Male |
| F | Female |
| RNS | Rather Not Say |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Value | Meaning |
|---|---|
| N | Normal |
| A | Admin |
| C | Customer Care |
| T | Technician |
| Value | Meaning |
|---|---|
| M | Male |
| F | Female |
| RNS | Rather Not Say |
| Value | Meaning |
|---|---|
| N | Normal |
| A | Admin |
| C | Customer Care |
| T | Technician |
| Value | Meaning |
|---|---|
| M | Male |
| F | Female |
| RNS | Rather Not Say |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| IsSafariNjemaCustomerCareOrAdmin | A base class from which all permission classes should inherit. |
| Value | Meaning |
|---|---|
| N | Normal |
| A | Admin |
| C | Customer Care |
| T | Technician |
| Value | Meaning |
|---|---|
| M | Male |
| F | Female |
| RNS | Rather Not Say |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Value | Meaning |
|---|---|
| N | Normal |
| A | Admin |
| C | Customer Care |
| T | Technician |
| Value | Meaning |
|---|---|
| M | Male |
| F | Female |
| RNS | Rather Not Say |
| Value | Meaning |
|---|---|
| N | Normal |
| A | Admin |
| C | Customer Care |
| T | Technician |
| Value | Meaning |
|---|---|
| M | Male |
| F | Female |
| RNS | Rather Not Say |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
Group My User statistics by:type = id, month_joined, month, year, day, day_of_week, iso_day_of_week, time_of_day
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsSuperUser | A base class from which all permission classes should inherit. |
| Param name | Description |
|---|---|
| password | Password |
| last_login | Last Login |
| is_superuser | Is Superuser |
| groups | Groups |
| user_permissions | User Permissions |
| username | Username |
| first_name | First Name |
| last_name | Last Name |
| is_staff | Is Staff |
| is_active | Is Active |
| date_joined | Date Joined |
| last_activity | Last Activity |
| role | Role |
| phone | Phone |
| google_profile_image | Google Profile Image |
| confirm_code | Confirm Code |
| reset_code | Reset Code |
| old_password | Old Password |
| changed_password | Changed Password |
| verified | Verified |
| dummy | Dummy |
| available | Available |
| dob | Dob |
| gender | Gender |
| allow_messages_import | Allow Messages Import |
| filter_args | Filter Args |
| novu_added | Novu Added |
| is_a_vet | Is A Vet |
| min_subscription_days_remaining | Min Subscription Days Remaining |
| max_subscription_days_remaining | Max Subscription Days Remaining |
| Value | Meaning |
|---|---|
| N | Normal |
| A | Admin |
| C | Customer Care |
| T | Technician |
| Value | Meaning |
|---|---|
| M | Male |
| F | Female |
| RNS | Rather Not Say |
| Value | Meaning |
|---|---|
| N | Normal |
| A | Admin |
| C | Customer Care |
| T | Technician |
| Value | Meaning |
|---|---|
| M | Male |
| F | Female |
| RNS | Rather Not Say |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsSuperUser | A base class from which all permission classes should inherit. |
| Param name | Description |
|---|---|
| password | Password |
| last_login | Last Login |
| is_superuser | Is Superuser |
| groups | Groups |
| user_permissions | User Permissions |
| username | Username |
| first_name | First Name |
| last_name | Last Name |
| is_staff | Is Staff |
| is_active | Is Active |
| date_joined | Date Joined |
| last_activity | Last Activity |
| role | Role |
| phone | Phone |
| google_profile_image | Google Profile Image |
| confirm_code | Confirm Code |
| reset_code | Reset Code |
| old_password | Old Password |
| changed_password | Changed Password |
| verified | Verified |
| dummy | Dummy |
| available | Available |
| dob | Dob |
| gender | Gender |
| allow_messages_import | Allow Messages Import |
| filter_args | Filter Args |
| novu_added | Novu Added |
| is_a_vet | Is A Vet |
| min_subscription_days_remaining | Min Subscription Days Remaining |
| max_subscription_days_remaining | Max Subscription Days Remaining |
| Value | Meaning |
|---|---|
| N | Normal |
| A | Admin |
| C | Customer Care |
| T | Technician |
| Value | Meaning |
|---|---|
| M | Male |
| F | Female |
| RNS | Rather Not Say |
| Value | Meaning |
|---|---|
| N | Normal |
| A | Admin |
| C | Customer Care |
| T | Technician |
| Value | Meaning |
|---|---|
| M | Male |
| F | Female |
| RNS | Rather Not Say |
API endpoint to recreate the Pro Trial topic in Novu.
This endpoint will:
1. Delete the existing topic (specified by topic_key query param)
2. Find all Pro Trial users
3. Add them to the recreated topic
Query Parameters:
- topic_key (required): The topic key to recreate (e.g., 'trial', 'pro-trial-users')
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| IsSuperUser | A base class from which all permission classes should inherit. |
API endpoint to create a Novu topic based on date, name, and app version.
This endpoint will:
1. Generate a unique topic key from date, name, and app version
2. Delete the existing topic if it exists
3. Create a new topic in Novu
4. Find all users that joined on or before the specified date
5. Add them to the new topic
Request Body:
- date (optional): The date to filter users (format: YYYY-MM-DD, defaults to today)
- app_version (required): The app version for the topic
- name (optional): The name for the topic (defaults to 'feature-release')
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| IsSuperUser | A base class from which all permission classes should inherit. |
API endpoint to trigger a Novu workflow for users or customers.
This endpoint will:
1. Validate the request data
2. Schedule a background task to trigger the workflow (immediately or at specified time)
3. Return immediate confirmation
The background task will:
- If target_ids provided: trigger workflow for each specified target
- If target_ids not provided: filter targets by date and trigger workflow for each
- Wait 10 seconds between each target workflow trigger
Request Body:
- workflow_key (required): The workflow identifier to trigger
- target_type (required): 'users' or 'customers'
- target_ids (optional): List of target IDs to trigger workflow for
- user_ids (optional): List of user IDs (deprecated, use target_ids with target_type='users')
- date (optional): Date filter for targets created before this date (format: YYYY-MM-DD) eg the day the app was published
- payload (optional): Additional payload data for the workflow
- scheduled_at (optional): Schedule the workflow to run at a specific datetime (with timezone info). Defaults to immediate execution.
Customer Notes:
- Customers must belong to the requesting user's account
- Customer IDs are used as integers in the API, but prefixed with "CT" for Novu
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| IsSuperUser | A base class from which all permission classes should inherit. |
| Value | Meaning |
|---|---|
| users | Users |
| customers | Customers |
| Value | Meaning |
|---|---|
| users | Users |
| customers | Customers |
Manage test account for wavvypaydev@gmail.com
- POST: Delete the account if it exists
- GET: Return the current reset code for the account (does not generate a new one)
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| name | Name |
| owner | Owner |
| local_uuid | Local Uuid |
| phone | Phone |
| contact_name | Contact Name |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| farm | Farm |
| breed | Breed |
| sire | Sire |
| dam | Dam |
| tag_number | Tag Number |
| name | Name |
| gender | Gender |
| date_of_birth | Date Of Birth |
| date_of_entry | Date Of Entry |
| acquisition_type | Acquisition Type |
| acquisition_details | Acquisition Details |
| is_active | Is Active |
| stage | Stage |
| current_status | Current Status |
| status_since_date | Status Since Date |
| weight_kg | Weight Kg |
| notes | Notes |
| local_uuid | Local Uuid |
| created_at | Created At |
| updated_at | Updated At |
| lifecycle_initialized | Lifecycle Initialized |
| initialized_at | Initialized At |
| Value | Meaning |
|---|---|
| male | Male |
| female | Female |
| Value | Meaning |
|---|---|
| born | Born on Farm |
| purchased | Purchased |
| other | Other |
| Value | Meaning |
|---|---|
| calf | Calf |
| weaner | Weaner |
| yearling | Yearling |
| steer | Steer |
| breeding | Breeding |
| adult | Adult |
| Value | Meaning |
|---|---|
| healthy | Healthy |
| pregnant | Pregnant |
| lactating | Lactating |
| dry | Dry |
| sick | Sick |
| sold | Sold |
| dead | Dead |
| Value | Meaning |
|---|---|
| male | Male |
| female | Female |
| Value | Meaning |
|---|---|
| born | Born on Farm |
| purchased | Purchased |
| other | Other |
| Value | Meaning |
|---|---|
| calf | Calf |
| weaner | Weaner |
| yearling | Yearling |
| steer | Steer |
| breeding | Breeding |
| adult | Adult |
| Value | Meaning |
|---|---|
| healthy | Healthy |
| pregnant | Pregnant |
| lactating | Lactating |
| dry | Dry |
| sick | Sick |
| sold | Sold |
| dead | Dead |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Value | Meaning |
|---|---|
| Dairy | Dairy |
| Beef | Beef |
| Dual-purpose | Dual-purpose |
| Value | Meaning |
|---|---|
| Dairy | Dairy |
| Beef | Beef |
| Dual-purpose | Dual-purpose |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| name | Name |
| breed_type | Breed Type |
| description | Description |
| origin_country | Origin Country |
| average_milk_yield | Average Milk Yield |
| average_weight | Average Weight |
| is_active | Is Active |
| local_uuid | Local Uuid |
| Value | Meaning |
|---|---|
| Dairy | Dairy |
| Beef | Beef |
| Dual-purpose | Dual-purpose |
| Value | Meaning |
|---|---|
| Dairy | Dairy |
| Beef | Beef |
| Dual-purpose | Dual-purpose |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| farm | Farm |
| breed | Breed |
| sire | Sire |
| dam | Dam |
| tag_number | Tag Number |
| name | Name |
| gender | Gender |
| date_of_birth | Date Of Birth |
| date_of_entry | Date Of Entry |
| acquisition_type | Acquisition Type |
| acquisition_details | Acquisition Details |
| is_active | Is Active |
| stage | Stage |
| current_status | Current Status |
| status_since_date | Status Since Date |
| weight_kg | Weight Kg |
| notes | Notes |
| local_uuid | Local Uuid |
| created_at | Created At |
| updated_at | Updated At |
| lifecycle_initialized | Lifecycle Initialized |
| initialized_at | Initialized At |
| Value | Meaning |
|---|---|
| male | Male |
| female | Female |
| Value | Meaning |
|---|---|
| born | Born on Farm |
| purchased | Purchased |
| other | Other |
| Value | Meaning |
|---|---|
| calf | Calf |
| weaner | Weaner |
| yearling | Yearling |
| steer | Steer |
| breeding | Breeding |
| adult | Adult |
| Value | Meaning |
|---|---|
| healthy | Healthy |
| pregnant | Pregnant |
| lactating | Lactating |
| dry | Dry |
| sick | Sick |
| sold | Sold |
| dead | Dead |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Value | Meaning |
|---|---|
| male | Male |
| female | Female |
| Value | Meaning |
|---|---|
| born | Born on Farm |
| purchased | Purchased |
| other | Other |
| Value | Meaning |
|---|---|
| calf | Calf |
| weaner | Weaner |
| yearling | Yearling |
| steer | Steer |
| breeding | Breeding |
| adult | Adult |
| Value | Meaning |
|---|---|
| healthy | Healthy |
| pregnant | Pregnant |
| lactating | Lactating |
| dry | Dry |
| sick | Sick |
| sold | Sold |
| dead | Dead |
| Value | Meaning |
|---|---|
| male | Male |
| female | Female |
| Value | Meaning |
|---|---|
| born | Born on Farm |
| purchased | Purchased |
| other | Other |
| Value | Meaning |
|---|---|
| calf | Calf |
| weaner | Weaner |
| yearling | Yearling |
| steer | Steer |
| breeding | Breeding |
| adult | Adult |
| Value | Meaning |
|---|---|
| healthy | Healthy |
| pregnant | Pregnant |
| lactating | Lactating |
| dry | Dry |
| sick | Sick |
| sold | Sold |
| dead | Dead |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Value | Meaning |
|---|---|
| breeding | Breeding |
| health | Health |
| management | Management |
| production | Production |
| other | Other |
| Value | Meaning |
|---|---|
| breeding | Breeding |
| health | Health |
| management | Management |
| production | Production |
| other | Other |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| name | Name |
| display_name | Display Name |
| description | Description |
| category | Category |
| slug | Slug |
| icon | Icon |
| color | Color |
| requires_outcome | Requires Outcome |
| is_system | Is System |
| is_active | Is Active |
| farm | Farm |
| Value | Meaning |
|---|---|
| breeding | Breeding |
| health | Health |
| management | Management |
| production | Production |
| other | Other |
| Value | Meaning |
|---|---|
| breeding | Breeding |
| health | Health |
| management | Management |
| production | Production |
| other | Other |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Value | Meaning |
|---|---|
| outcome_code | Use Outcome Code |
| outcome_value | Use Event Outcome Value |
| event_date | Use Event Date |
| increment | Increment Current Value |
| Value | Meaning |
|---|---|
| text | Text |
| number | Number |
| date | Date |
| Value | Meaning |
|---|---|
| outcome_code | Use Outcome Code |
| outcome_value | Use Event Outcome Value |
| event_date | Use Event Date |
| increment | Increment Current Value |
| Value | Meaning |
|---|---|
| text | Text |
| number | Number |
| date | Date |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| event_type | Event Type |
| code | Code |
| display_name | Display Name |
| description | Description |
| is_success | Is Success |
| color | Color |
| order | Order |
| is_active | Is Active |
| updates_field | Updates Field |
| update_source | Update Source |
| default_value | Default Value |
| allow_custom_outcome | Allow Custom Outcome |
| input_type | Input Type |
| input_label | Input Label |
| validation_min | Validation Min |
| validation_max | Validation Max |
| is_required | Is Required |
| Value | Meaning |
|---|---|
| outcome_code | Use Outcome Code |
| outcome_value | Use Event Outcome Value |
| event_date | Use Event Date |
| increment | Increment Current Value |
| Value | Meaning |
|---|---|
| text | Text |
| number | Number |
| date | Date |
| Value | Meaning |
|---|---|
| outcome_code | Use Outcome Code |
| outcome_value | Use Event Outcome Value |
| event_date | Use Event Date |
| increment | Increment Current Value |
| Value | Meaning |
|---|---|
| text | Text |
| number | Number |
| date | Date |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Value | Meaning |
|---|---|
| pending | Pending |
| completed | Completed |
| cancelled | Cancelled |
| overdue | Overdue |
| Value | Meaning |
|---|---|
| pending | Pending |
| completed | Completed |
| cancelled | Cancelled |
| overdue | Overdue |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| livestock | Livestock |
| event_type | Event Type |
| parent_event | Parent Event |
| template | Template |
| scheduled_date | Scheduled Date |
| event_date | Event Date |
| completed_at | Completed At |
| status | Status |
| outcome | Outcome |
| initialized | Initialized |
| notes | Notes |
| is_recurring | Is Recurring |
| recurrence_count | Recurrence Count |
| recurrence_parent | Recurrence Parent |
| outcome_value | Outcome Value |
| farm | Farm |
| scheduled_date_from | Scheduled Date From |
| scheduled_date_to | Scheduled Date To |
| Value | Meaning |
|---|---|
| pending | Pending |
| completed | Completed |
| cancelled | Cancelled |
| overdue | Overdue |
| Value | Meaning |
|---|---|
| pending | Pending |
| completed | Completed |
| cancelled | Cancelled |
| overdue | Overdue |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Value | Meaning |
|---|---|
| A | Grade A - Premium |
| B | Grade B - Standard |
| C | Grade C - Lower |
| Value | Meaning |
|---|---|
| A | Grade A - Premium |
| B | Grade B - Standard |
| C | Grade C - Lower |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| farm | Farm |
| date | Date |
| livestock | Livestock |
| animal_count | Animal Count |
| morning_amount | Morning Amount |
| mid_day_amount | Mid Day Amount |
| evening_amount | Evening Amount |
| night_amount | Night Amount |
| whole_day_amount | Whole Day Amount |
| quality_grade | Quality Grade |
| notes | Notes |
| local_uuid | Local Uuid |
| Value | Meaning |
|---|---|
| A | Grade A - Premium |
| B | Grade B - Standard |
| C | Grade C - Lower |
| Value | Meaning |
|---|---|
| A | Grade A - Premium |
| B | Grade B - Standard |
| C | Grade C - Lower |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Value | Meaning |
|---|---|
| WHOLESALE | Wholesale Sale |
| RETAIL | Retail Sale |
| DIRECT | Direct Consumer Sale |
| CALVES | Fed to Calves |
| INTERNAL | Internal Use |
| SPOILED | Spoiled/Expired |
| SPILLED | Spilled/Accident |
| CHEESE | Cheese Making |
| BUTTER | Butter Making |
| YOGURT | Yogurt Making |
| Value | Meaning |
|---|---|
| CASH | Cash |
| MOBILE_MONEY | Mobile Money |
| BANK_TRANSFER | Bank Transfer |
| CHECK | Check |
| CREDIT | Credit/Later |
| Value | Meaning |
|---|---|
| PAID | Fully Paid |
| PARTIAL | Partially Paid |
| UNPAID | Unpaid |
| N/A | Not Applicable |
| Value | Meaning |
|---|---|
| WHOLESALE | Wholesale Sale |
| RETAIL | Retail Sale |
| DIRECT | Direct Consumer Sale |
| CALVES | Fed to Calves |
| INTERNAL | Internal Use |
| SPOILED | Spoiled/Expired |
| SPILLED | Spilled/Accident |
| CHEESE | Cheese Making |
| BUTTER | Butter Making |
| YOGURT | Yogurt Making |
| Value | Meaning |
|---|---|
| CASH | Cash |
| MOBILE_MONEY | Mobile Money |
| BANK_TRANSFER | Bank Transfer |
| CHECK | Check |
| CREDIT | Credit/Later |
| Value | Meaning |
|---|---|
| PAID | Fully Paid |
| PARTIAL | Partially Paid |
| UNPAID | Unpaid |
| N/A | Not Applicable |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| farm | Farm |
| date | Date |
| usage_type | Usage Type |
| amount | Amount |
| price_per_liter | Price Per Liter |
| buyer | Buyer |
| payment_method | Payment Method |
| payment_status | Payment Status |
| amount_paid | Amount Paid |
| notes | Notes |
| local_uuid | Local Uuid |
| Value | Meaning |
|---|---|
| WHOLESALE | Wholesale Sale |
| RETAIL | Retail Sale |
| DIRECT | Direct Consumer Sale |
| CALVES | Fed to Calves |
| INTERNAL | Internal Use |
| SPOILED | Spoiled/Expired |
| SPILLED | Spilled/Accident |
| CHEESE | Cheese Making |
| BUTTER | Butter Making |
| YOGURT | Yogurt Making |
| Value | Meaning |
|---|---|
| CASH | Cash |
| MOBILE_MONEY | Mobile Money |
| BANK_TRANSFER | Bank Transfer |
| CHECK | Check |
| CREDIT | Credit/Later |
| Value | Meaning |
|---|---|
| PAID | Fully Paid |
| PARTIAL | Partially Paid |
| UNPAID | Unpaid |
| N/A | Not Applicable |
| Value | Meaning |
|---|---|
| WHOLESALE | Wholesale Sale |
| RETAIL | Retail Sale |
| DIRECT | Direct Consumer Sale |
| CALVES | Fed to Calves |
| INTERNAL | Internal Use |
| SPOILED | Spoiled/Expired |
| SPILLED | Spilled/Accident |
| CHEESE | Cheese Making |
| BUTTER | Butter Making |
| YOGURT | Yogurt Making |
| Value | Meaning |
|---|---|
| CASH | Cash |
| MOBILE_MONEY | Mobile Money |
| BANK_TRANSFER | Bank Transfer |
| CHECK | Check |
| CREDIT | Credit/Later |
| Value | Meaning |
|---|---|
| PAID | Fully Paid |
| PARTIAL | Partially Paid |
| UNPAID | Unpaid |
| N/A | Not Applicable |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Value | Meaning |
|---|---|
| WHOLESALE | Wholesale Buyer |
| RETAIL | Retail Buyer |
| DIRECT | Direct Consumer |
| PROCESSOR | Processor |
| Value | Meaning |
|---|---|
| CASH | Cash on Delivery |
| WEEKLY | Weekly Payment |
| BIWEEKLY | Bi-weekly Payment |
| MONTHLY | Monthly Payment |
| QUARTERLY | Quarterly Payment |
| CUSTOM | Custom Terms |
| Value | Meaning |
|---|---|
| WHOLESALE | Wholesale Buyer |
| RETAIL | Retail Buyer |
| DIRECT | Direct Consumer |
| PROCESSOR | Processor |
| Value | Meaning |
|---|---|
| CASH | Cash on Delivery |
| WEEKLY | Weekly Payment |
| BIWEEKLY | Bi-weekly Payment |
| MONTHLY | Monthly Payment |
| QUARTERLY | Quarterly Payment |
| CUSTOM | Custom Terms |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| farm | Farm |
| name | Name |
| contact_info | Contact Info |
| buyer_type | Buyer Type |
| credit_limit | Credit Limit |
| is_active | Is Active |
| notes | Notes |
| local_uuid | Local Uuid |
| default_price_per_litre | Default Price Per Litre |
| payment_terms_days | Payment Terms Days |
| payment_terms | Payment Terms |
| Value | Meaning |
|---|---|
| WHOLESALE | Wholesale Buyer |
| RETAIL | Retail Buyer |
| DIRECT | Direct Consumer |
| PROCESSOR | Processor |
| Value | Meaning |
|---|---|
| CASH | Cash on Delivery |
| WEEKLY | Weekly Payment |
| BIWEEKLY | Bi-weekly Payment |
| MONTHLY | Monthly Payment |
| QUARTERLY | Quarterly Payment |
| CUSTOM | Custom Terms |
| Value | Meaning |
|---|---|
| WHOLESALE | Wholesale Buyer |
| RETAIL | Retail Buyer |
| DIRECT | Direct Consumer |
| PROCESSOR | Processor |
| Value | Meaning |
|---|---|
| CASH | Cash on Delivery |
| WEEKLY | Weekly Payment |
| BIWEEKLY | Bi-weekly Payment |
| MONTHLY | Monthly Payment |
| QUARTERLY | Quarterly Payment |
| CUSTOM | Custom Terms |
GET: List all farms associated with the logged-in veterinarian.
POST: Create a new farm and automatically link the veterinarian to it.
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsVeterinarian | Custom permission to allow only veterinarians. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| name | Name |
| owner | Owner |
| local_uuid | Local Uuid |
| phone | Phone |
| contact_name | Contact Name |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| user | User |
| name | Name |
| contact_info | Contact Info |
| license_number | License Number |
| specialization | Specialization |
| is_active | Is Active |
| notes | Notes |
| local_uuid | Local Uuid |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Value | Meaning |
|---|---|
| immunization | Immunization |
| deworming | Deworming |
| treatment | Treatment |
| injury | Injury |
| checkup | Check-up |
| disease | Disease |
| other | Any Other |
| Value | Meaning |
|---|---|
| immunization | Immunization |
| deworming | Deworming |
| treatment | Treatment |
| injury | Injury |
| checkup | Check-up |
| disease | Disease |
| other | Any Other |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| farm | Farm |
| livestock | Livestock |
| veterinarian | Veterinarian |
| record_type | Record Type |
| date | Date |
| signs | Signs |
| diagnosis | Diagnosis |
| treatment | Treatment |
| recommendations | Recommendations |
| other_aspects | Other Aspects |
| amount | Amount |
| notes | Notes |
| local_uuid | Local Uuid |
| Value | Meaning |
|---|---|
| immunization | Immunization |
| deworming | Deworming |
| treatment | Treatment |
| injury | Injury |
| checkup | Check-up |
| disease | Disease |
| other | Any Other |
| Value | Meaning |
|---|---|
| immunization | Immunization |
| deworming | Deworming |
| treatment | Treatment |
| injury | Injury |
| checkup | Check-up |
| disease | Disease |
| other | Any Other |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| farm | Farm |
| veterinarian | Veterinarian |
| is_active | Is Active |
| local_uuid | Local Uuid |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Value | Meaning |
|---|---|
| income | Income |
| expense | Expense |
| Value | Meaning |
|---|---|
| milk_sales | Milk Sales |
| animal_sales | Animal Sales |
| manure_sales | Manure Sales |
| feed | Feed |
| equipment | Equipment |
| wages | Wages |
| medication | Medication |
| transport | Transport |
| veterinary | Veterinary Services |
| consultation | Consultation/Examination |
| surgery | Surgery |
| vaccination | Vaccination Service |
| deworming_service | Deworming Service |
| laboratory | Laboratory Tests |
| diagnostic | Diagnostic Services |
| emergency | Emergency Services |
| castration | Castration/Neutering |
| dental | Dental Care |
| ai_service | AI/Breeding Service |
| hoof_trimming | Hoof Trimming |
| health_certificate | Health Certificate |
| other | Other |
| Value | Meaning |
|---|---|
| PAID | Fully Paid |
| UNPAID | Unpaid |
| PENDING | Pending |
| N/A | Not Applicable |
| Value | Meaning |
|---|---|
| income | Income |
| expense | Expense |
| Value | Meaning |
|---|---|
| milk_sales | Milk Sales |
| animal_sales | Animal Sales |
| manure_sales | Manure Sales |
| feed | Feed |
| equipment | Equipment |
| wages | Wages |
| medication | Medication |
| transport | Transport |
| veterinary | Veterinary Services |
| consultation | Consultation/Examination |
| surgery | Surgery |
| vaccination | Vaccination Service |
| deworming_service | Deworming Service |
| laboratory | Laboratory Tests |
| diagnostic | Diagnostic Services |
| emergency | Emergency Services |
| castration | Castration/Neutering |
| dental | Dental Care |
| ai_service | AI/Breeding Service |
| hoof_trimming | Hoof Trimming |
| health_certificate | Health Certificate |
| other | Other |
| Value | Meaning |
|---|---|
| PAID | Fully Paid |
| UNPAID | Unpaid |
| PENDING | Pending |
| N/A | Not Applicable |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| farm | Farm |
| veterinarian | Veterinarian |
| livestock | Livestock |
| transaction_type | Transaction Type |
| category | Category |
| amount | Amount |
| date | Date |
| description | Description |
| reference | Reference |
| recorded_by | Recorded By |
| payment_status | Payment Status |
| payment_date | Payment Date |
| local_uuid | Local Uuid |
| Value | Meaning |
|---|---|
| income | Income |
| expense | Expense |
| Value | Meaning |
|---|---|
| milk_sales | Milk Sales |
| animal_sales | Animal Sales |
| manure_sales | Manure Sales |
| feed | Feed |
| equipment | Equipment |
| wages | Wages |
| medication | Medication |
| transport | Transport |
| veterinary | Veterinary Services |
| consultation | Consultation/Examination |
| surgery | Surgery |
| vaccination | Vaccination Service |
| deworming_service | Deworming Service |
| laboratory | Laboratory Tests |
| diagnostic | Diagnostic Services |
| emergency | Emergency Services |
| castration | Castration/Neutering |
| dental | Dental Care |
| ai_service | AI/Breeding Service |
| hoof_trimming | Hoof Trimming |
| health_certificate | Health Certificate |
| other | Other |
| Value | Meaning |
|---|---|
| PAID | Fully Paid |
| UNPAID | Unpaid |
| PENDING | Pending |
| N/A | Not Applicable |
| Value | Meaning |
|---|---|
| income | Income |
| expense | Expense |
| Value | Meaning |
|---|---|
| milk_sales | Milk Sales |
| animal_sales | Animal Sales |
| manure_sales | Manure Sales |
| feed | Feed |
| equipment | Equipment |
| wages | Wages |
| medication | Medication |
| transport | Transport |
| veterinary | Veterinary Services |
| consultation | Consultation/Examination |
| surgery | Surgery |
| vaccination | Vaccination Service |
| deworming_service | Deworming Service |
| laboratory | Laboratory Tests |
| diagnostic | Diagnostic Services |
| emergency | Emergency Services |
| castration | Castration/Neutering |
| dental | Dental Care |
| ai_service | AI/Breeding Service |
| hoof_trimming | Hoof Trimming |
| health_certificate | Health Certificate |
| other | Other |
| Value | Meaning |
|---|---|
| PAID | Fully Paid |
| UNPAID | Unpaid |
| PENDING | Pending |
| N/A | Not Applicable |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| name | Name |
| country_code | Country Code |
| language_code | Language Code |
| version | Version |
| active | Active |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| DjangoModelPermissionsOrAnonReadOnly | Similar to DjangoModelPermissions, except that anonymous users are |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| name | Name |
| country_code | Country Code |
| language_code | Language Code |
| version | Version |
| active | Active |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| title | Title |
| description | Description |
| active | Active |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| locale | Locale |
| text | Text |
| translated_text | Translated Text |
| not_translated | Not Translated |
| original | Original |
Group statistics by:
`type` = {stat_types}
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| locale | Locale |
| text | Text |
| translated_text | Translated Text |
| not_translated | Not Translated |
| original | Original |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
Implements an endpoint to provide access tokens
The endpoint is used in the following flows:
* Authorization code
* Password
* Client credentials
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| AllowAny | Allow any access. |
Implements an endpoint to convert a provider token to an access token
The endpoint is used in the following flows:
* Authorization code
* Client credentials
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| AllowAny | Allow any access. |
Implements an endpoint to revoke access or refresh tokens
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| AllowAny | Allow any access. |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
An endpoint for disconnect social auth backend providers such as Facebook.
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |