Marsad Baladia API
This is the REST API for Marsad Baladia.
budget
budget-category > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
is_expense | |
parent | |
search | A search term. |
ordering | Which field to use when ordering the results. |
budget-category > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name_fr | |
name_ar | |
is_expense | |
parent required |
budget-category > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Budget Category. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
is_expense | |
parent | |
search | A search term. |
ordering | Which field to use when ordering the results. |
budget-category > update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Budget Category. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
is_expense | |
parent | |
search | A search term. |
ordering | Which field to use when ordering the results. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name_fr | |
name_ar | |
is_expense | |
parent required |
budget-category > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Budget Category. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
is_expense | |
parent | |
search | A search term. |
ordering | Which field to use when ordering the results. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name_fr | |
name_ar | |
is_expense | |
parent |
budget-category > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Budget Category. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
is_expense | |
parent | |
search | A search term. |
ordering | Which field to use when ordering the results. |
budget-transaction > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
locality | |
budget_category | |
budget_year | |
search | A search term. |
ordering | Which field to use when ordering the results. |
budget-transaction > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
locality required | |
budget_category required | |
name_fr required | |
budget_year required | |
amount required |
budget-transaction > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Budget Transaction. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
locality | |
budget_category | |
budget_year | |
search | A search term. |
ordering | Which field to use when ordering the results. |
budget-transaction > update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Budget Transaction. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
locality | |
budget_category | |
budget_year | |
search | A search term. |
ordering | Which field to use when ordering the results. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
locality required | |
budget_category required | |
name_fr required | |
budget_year required | |
amount required |
budget-transaction > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Budget Transaction. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
locality | |
budget_category | |
budget_year | |
search | A search term. |
ordering | Which field to use when ordering the results. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
locality | |
budget_category | |
name_fr | |
budget_year | |
amount |
budget-transaction > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Budget Transaction. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
locality | |
budget_category | |
budget_year | |
search | A search term. |
ordering | Which field to use when ordering the results. |
municipality
attendance > list
This viewset returns a list of all Attendances and includes full CRUD functionality for specific Attendance objects indexed by id.
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
event | |
person | |
attended | |
justified_absence | |
date | |
date__lte | |
date__gte | |
search | A search term. |
ordering | Which field to use when ordering the results. |
attendance > create
This viewset returns a list of all Attendances and includes full CRUD functionality for specific Attendance objects indexed by id.
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
event required | |
date required | |
person required | |
attended required | |
justified_absence required |
attendance > read
This viewset returns a list of all Attendances and includes full CRUD functionality for specific Attendance objects indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Attendance. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
event | |
person | |
attended | |
justified_absence | |
date | |
date__lte | |
date__gte | |
search | A search term. |
ordering | Which field to use when ordering the results. |
attendance > update
This viewset returns a list of all Attendances and includes full CRUD functionality for specific Attendance objects indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Attendance. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
event | |
person | |
attended | |
justified_absence | |
date | |
date__lte | |
date__gte | |
search | A search term. |
ordering | Which field to use when ordering the results. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
event required | |
date required | |
person required | |
attended required | |
justified_absence required |
attendance > partial_update
This viewset returns a list of all Attendances and includes full CRUD functionality for specific Attendance objects indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Attendance. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
event | |
person | |
attended | |
justified_absence | |
date | |
date__lte | |
date__gte | |
search | A search term. |
ordering | Which field to use when ordering the results. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
event | |
date | |
person | |
attended | |
justified_absence |
attendance > delete
This viewset returns a list of all Attendances and includes full CRUD functionality for specific Attendance objects indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Attendance. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
event | |
person | |
attended | |
justified_absence | |
date | |
date__lte | |
date__gte | |
search | A search term. |
ordering | Which field to use when ordering the results. |
attendees_group > list
This viewset returns a list of all Attendees_Group objects and includes full CRUD functionality for specific Attendees_Group objects indexed by id.
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
attendees_group > create
This viewset returns a list of all Attendees_Group objects and includes full CRUD functionality for specific Attendees_Group objects indexed by id.
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
event required | |
date required | |
attendees_group required | |
n_attendees required |
attendees_group > read
This viewset returns a list of all Attendees_Group objects and includes full CRUD functionality for specific Attendees_Group objects indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Attendees Group. |
attendees_group > update
This viewset returns a list of all Attendees_Group objects and includes full CRUD functionality for specific Attendees_Group objects indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Attendees Group. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
event required | |
date required | |
attendees_group required | |
n_attendees required |
attendees_group > partial_update
This viewset returns a list of all Attendees_Group objects and includes full CRUD functionality for specific Attendees_Group objects indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Attendees Group. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
event | |
date | |
attendees_group | |
n_attendees |
attendees_group > delete
This viewset returns a list of all Attendees_Group objects and includes full CRUD functionality for specific Attendees_Group objects indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Attendees Group. |
attendees_group_type > list
This viewset returns a list of all Attendees_Group_Type objects and includes full CRUD functionality for specific Attendees_Group objects indexed by id.
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
attendees_group_type > create
This viewset returns a list of all Attendees_Group_Type objects and includes full CRUD functionality for specific Attendees_Group objects indexed by id.
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name_fr | |
name_ar |
attendees_group_type > read
This viewset returns a list of all Attendees_Group_Type objects and includes full CRUD functionality for specific Attendees_Group objects indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Attendees Group Types. |
attendees_group_type > update
This viewset returns a list of all Attendees_Group_Type objects and includes full CRUD functionality for specific Attendees_Group objects indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Attendees Group Types. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name_fr | |
name_ar |
attendees_group_type > partial_update
This viewset returns a list of all Attendees_Group_Type objects and includes full CRUD functionality for specific Attendees_Group objects indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Attendees Group Types. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name_fr | |
name_ar |
attendees_group_type > delete
This viewset returns a list of all Attendees_Group_Type objects and includes full CRUD functionality for specific Attendees_Group objects indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Attendees Group Types. |
committee > list
This viewset returns a list of all Committee objects and includes full CRUD functionality for specific Committee objects indexed by id.
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
search | A search term. |
ordering | Which field to use when ordering the results. |
committee > create
This viewset returns a list of all Committee objects and includes full CRUD functionality for specific Committee objects indexed by id.
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name_ar | |
name_fr |
committee > read
This viewset returns a list of all Committee objects and includes full CRUD functionality for specific Committee objects indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Committee. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
ordering | Which field to use when ordering the results. |
committee > update
This viewset returns a list of all Committee objects and includes full CRUD functionality for specific Committee objects indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Committee. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
ordering | Which field to use when ordering the results. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name_ar | |
name_fr |
committee > partial_update
This viewset returns a list of all Committee objects and includes full CRUD functionality for specific Committee objects indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Committee. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
ordering | Which field to use when ordering the results. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name_ar | |
name_fr |
committee > delete
This viewset returns a list of all Committee objects and includes full CRUD functionality for specific Committee objects indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Committee. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
ordering | Which field to use when ordering the results. |
committee-log > list
This viewset returns a list of all Committee objects and includes full CRUD functionality for specific Committee objects indexed by id.
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
locality | |
committee | |
committee_log | |
start_date | |
start_date__lte | |
start_date__gte | |
end_date | |
end_date__lte | |
end_date__gte | |
search | A search term. |
ordering | Which field to use when ordering the results. |
committee-log > create
This viewset returns a list of all Committee objects and includes full CRUD functionality for specific Committee objects indexed by id.
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
locality required | |
start_date required | |
end_date | |
committee required | |
committee_log required |
committee-log > read
This viewset returns a list of all Committee objects and includes full CRUD functionality for specific Committee objects indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Committee Log. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
locality | |
committee | |
committee_log | |
start_date | |
start_date__lte | |
start_date__gte | |
end_date | |
end_date__lte | |
end_date__gte | |
search | A search term. |
ordering | Which field to use when ordering the results. |
committee-log > update
This viewset returns a list of all Committee objects and includes full CRUD functionality for specific Committee objects indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Committee Log. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
locality | |
committee | |
committee_log | |
start_date | |
start_date__lte | |
start_date__gte | |
end_date | |
end_date__lte | |
end_date__gte | |
search | A search term. |
ordering | Which field to use when ordering the results. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
locality required | |
start_date required | |
end_date | |
committee required | |
committee_log required |
committee-log > partial_update
This viewset returns a list of all Committee objects and includes full CRUD functionality for specific Committee objects indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Committee Log. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
locality | |
committee | |
committee_log | |
start_date | |
start_date__lte | |
start_date__gte | |
end_date | |
end_date__lte | |
end_date__gte | |
search | A search term. |
ordering | Which field to use when ordering the results. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
locality | |
start_date | |
end_date | |
committee | |
committee_log |
committee-log > delete
This viewset returns a list of all Committee objects and includes full CRUD functionality for specific Committee objects indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Committee Log. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
locality | |
committee | |
committee_log | |
start_date | |
start_date__lte | |
start_date__gte | |
end_date | |
end_date__lte | |
end_date__gte | |
search | A search term. |
ordering | Which field to use when ordering the results. |
council-member > list
This viewset returns a list of all Council members and includes full CRUD functionality for specific Council_Member objects indexed by id.
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
gender | |
party | |
search | A search term. |
ordering | Which field to use when ordering the results. |
council-member > create
This viewset returns a list of all Council members and includes full CRUD functionality for specific Council_Member objects indexed by id.
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
full_name required | |
avatar | |
gender | |
party required | |
email | |
fax | |
facebook | |
cv |
council-member > read
This viewset returns a list of all Council members and includes full CRUD functionality for specific Council_Member objects indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Council Member. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
gender | |
party | |
search | A search term. |
ordering | Which field to use when ordering the results. |
council-member > update
This viewset returns a list of all Council members and includes full CRUD functionality for specific Council_Member objects indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Council Member. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
gender | |
party | |
search | A search term. |
ordering | Which field to use when ordering the results. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
full_name required | |
avatar | |
gender | |
party required | |
email | |
fax | |
facebook | |
cv |
council-member > partial_update
This viewset returns a list of all Council members and includes full CRUD functionality for specific Council_Member objects indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Council Member. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
gender | |
party | |
search | A search term. |
ordering | Which field to use when ordering the results. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
full_name | |
avatar | |
gender | |
party | |
email | |
fax | |
facebook | |
cv |
council-member > delete
This viewset returns a list of all Council members and includes full CRUD functionality for specific Council_Member objects indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Council Member. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
gender | |
party | |
search | A search term. |
ordering | Which field to use when ordering the results. |
council-member-position > list
This viewset returns a list of all Council member positions and includes full CRUD functionality for specific Council member position objects indexed by id.
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
locality | |
person | |
person__gender | |
council | |
committee_log | |
position | |
search | A search term. |
ordering | Which field to use when ordering the results. |
council-member-position > create
This viewset returns a list of all Council member positions and includes full CRUD functionality for specific Council member position objects indexed by id.
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
locality required | |
person required | |
council required | |
start_date required | |
end_date required | |
committee_log required | |
position required |
council-member-position > read
This viewset returns a list of all Council member positions and includes full CRUD functionality for specific Council member position objects indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Council Member Position. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
locality | |
person | |
person__gender | |
council | |
committee_log | |
position | |
search | A search term. |
ordering | Which field to use when ordering the results. |
council-member-position > update
This viewset returns a list of all Council member positions and includes full CRUD functionality for specific Council member position objects indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Council Member Position. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
locality | |
person | |
person__gender | |
council | |
committee_log | |
position | |
search | A search term. |
ordering | Which field to use when ordering the results. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
locality required | |
person required | |
council required | |
start_date required | |
end_date required | |
committee_log required | |
position required |
council-member-position > partial_update
This viewset returns a list of all Council member positions and includes full CRUD functionality for specific Council member position objects indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Council Member Position. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
locality | |
person | |
person__gender | |
council | |
committee_log | |
position | |
search | A search term. |
ordering | Which field to use when ordering the results. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
locality | |
person | |
council | |
start_date | |
end_date | |
committee_log | |
position |
council-member-position > delete
This viewset returns a list of all Council member positions and includes full CRUD functionality for specific Council member position objects indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Council Member Position. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
locality | |
person | |
person__gender | |
council | |
committee_log | |
position | |
search | A search term. |
ordering | Which field to use when ordering the results. |
electoral-list > list
This viewset returns a list of all Electoral lists and includes full CRUD functionality for specific Electoral list objects indexed by id.
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
locality | |
search | A search term. |
ordering | Which field to use when ordering the results. |
electoral-list > create
This viewset returns a list of all Electoral lists and includes full CRUD functionality for specific Electoral list objects indexed by id.
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
locality required | |
electoral_list_nature required | |
electoral_list required |
electoral-list > read
This viewset returns a list of all Electoral lists and includes full CRUD functionality for specific Electoral list objects indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Electoral List. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
locality | |
search | A search term. |
ordering | Which field to use when ordering the results. |
electoral-list > update
This viewset returns a list of all Electoral lists and includes full CRUD functionality for specific Electoral list objects indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Electoral List. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
locality | |
search | A search term. |
ordering | Which field to use when ordering the results. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
locality required | |
electoral_list_nature required | |
electoral_list required |
electoral-list > partial_update
This viewset returns a list of all Electoral lists and includes full CRUD functionality for specific Electoral list objects indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Electoral List. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
locality | |
search | A search term. |
ordering | Which field to use when ordering the results. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
locality | |
electoral_list_nature | |
electoral_list |
electoral-list > delete
This viewset returns a list of all Electoral lists and includes full CRUD functionality for specific Electoral list objects indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Electoral List. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
locality | |
search | A search term. |
ordering | Which field to use when ordering the results. |
event > list
This viewset returns a list of all Event objects and includes full CRUD functionality for specific Event objects indexed by id.
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
locality | |
event_type | |
legally_required | |
scheduled_date | |
scheduled_date__lte | |
scheduled_date__gte | |
start_date | |
start_date__lte | |
start_date__gte | |
end_date | |
end_date__lte | |
end_date__gte | |
search | A search term. |
ordering | Which field to use when ordering the results. |
event > create
This viewset returns a list of all Event objects and includes full CRUD functionality for specific Event objects indexed by id.
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
locality required | |
event_type required | |
scheduled_date required | |
start_date required | |
end_date required | |
place required | |
method_announce required | |
legally_required required |
event > read
This viewset returns a list of all Event objects and includes full CRUD functionality for specific Event objects indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Event. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
locality | |
event_type | |
legally_required | |
scheduled_date | |
scheduled_date__lte | |
scheduled_date__gte | |
start_date | |
start_date__lte | |
start_date__gte | |
end_date | |
end_date__lte | |
end_date__gte | |
search | A search term. |
ordering | Which field to use when ordering the results. |
event > update
This viewset returns a list of all Event objects and includes full CRUD functionality for specific Event objects indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Event. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
locality | |
event_type | |
legally_required | |
scheduled_date | |
scheduled_date__lte | |
scheduled_date__gte | |
start_date | |
start_date__lte | |
start_date__gte | |
end_date | |
end_date__lte | |
end_date__gte | |
search | A search term. |
ordering | Which field to use when ordering the results. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
locality required | |
event_type required | |
scheduled_date required | |
start_date required | |
end_date required | |
place required | |
method_announce required | |
legally_required required |
event > partial_update
This viewset returns a list of all Event objects and includes full CRUD functionality for specific Event objects indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Event. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
locality | |
event_type | |
legally_required | |
scheduled_date | |
scheduled_date__lte | |
scheduled_date__gte | |
start_date | |
start_date__lte | |
start_date__gte | |
end_date | |
end_date__lte | |
end_date__gte | |
search | A search term. |
ordering | Which field to use when ordering the results. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
locality | |
event_type | |
scheduled_date | |
start_date | |
end_date | |
place | |
method_announce | |
legally_required |
event > delete
This viewset returns a list of all Event objects and includes full CRUD functionality for specific Event objects indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Event. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
locality | |
event_type | |
legally_required | |
scheduled_date | |
scheduled_date__lte | |
scheduled_date__gte | |
start_date | |
start_date__lte | |
start_date__gte | |
end_date | |
end_date__lte | |
end_date__gte | |
search | A search term. |
ordering | Which field to use when ordering the results. |
event-type > list
This viewset returns a list of all Event_Type objects and includes full CRUD functionality for specific Event_Types objects indexed by id.
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
search | A search term. |
ordering | Which field to use when ordering the results. |
event-type > create
This viewset returns a list of all Event_Type objects and includes full CRUD functionality for specific Event_Types objects indexed by id.
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required |
event-type > read
This viewset returns a list of all Event_Type objects and includes full CRUD functionality for specific Event_Types objects indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Event Name. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
ordering | Which field to use when ordering the results. |
event-type > update
This viewset returns a list of all Event_Type objects and includes full CRUD functionality for specific Event_Types objects indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Event Name. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
ordering | Which field to use when ordering the results. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required |
event-type > partial_update
This viewset returns a list of all Event_Type objects and includes full CRUD functionality for specific Event_Types objects indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Event Name. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
ordering | Which field to use when ordering the results. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name |
event-type > delete
This viewset returns a list of all Event_Type objects and includes full CRUD functionality for specific Event_Types objects indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Event Name. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
ordering | Which field to use when ordering the results. |
locality > list
This viewset returns a list of all Attendees_Group objects and includes full CRUD functionality for specific Attendees_Group objects indexed by id.
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
locality > create
This viewset returns a list of all Attendees_Group objects and includes full CRUD functionality for specific Attendees_Group objects indexed by id.
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name_ar | |
name_fr |
locality > read
This viewset returns a list of all Attendees_Group objects and includes full CRUD functionality for specific Attendees_Group objects indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Locality. |
locality > update
This viewset returns a list of all Attendees_Group objects and includes full CRUD functionality for specific Attendees_Group objects indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Locality. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name_ar | |
name_fr |
locality > partial_update
This viewset returns a list of all Attendees_Group objects and includes full CRUD functionality for specific Attendees_Group objects indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Locality. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name_ar | |
name_fr |
locality > delete
This viewset returns a list of all Attendees_Group objects and includes full CRUD functionality for specific Attendees_Group objects indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Locality. |
observer > list
This viewset returns a list of all Observers and includes full CRUD functionality for specific Observers indexed by id.
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
observer > create
This viewset returns a list of all Observers and includes full CRUD functionality for specific Observers indexed by id.
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
locality required |
observer > read
This viewset returns a list of all Observers and includes full CRUD functionality for specific Observers indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Observer. |
observer > update
This viewset returns a list of all Observers and includes full CRUD functionality for specific Observers indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Observer. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
locality required |
observer > partial_update
This viewset returns a list of all Observers and includes full CRUD functionality for specific Observers indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Observer. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
locality |
observer > delete
This viewset returns a list of all Observers and includes full CRUD functionality for specific Observers indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Observer. |
party > list
This viewset returns a list of all Party objects and includes full CRUD functionality for specific Party objects indexed by id.
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
search | A search term. |
ordering | Which field to use when ordering the results. |
party > create
This viewset returns a list of all Party objects and includes full CRUD functionality for specific Party objects indexed by id.
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name_ar | |
name_fr | |
avatar | |
color required |
party > read
This viewset returns a list of all Party objects and includes full CRUD functionality for specific Party objects indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Party. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
ordering | Which field to use when ordering the results. |
party > update
This viewset returns a list of all Party objects and includes full CRUD functionality for specific Party objects indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Party. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
ordering | Which field to use when ordering the results. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name_ar | |
name_fr | |
avatar | |
color required |
party > partial_update
This viewset returns a list of all Party objects and includes full CRUD functionality for specific Party objects indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Party. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
ordering | Which field to use when ordering the results. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name_ar | |
name_fr | |
avatar | |
color |
party > delete
This viewset returns a list of all Party objects and includes full CRUD functionality for specific Party objects indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Party. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
ordering | Which field to use when ordering the results. |
position > list
This viewset returns a list of all Position objects and includes full CRUD functionality for specific Position objects indexed by id.
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
search | A search term. |
ordering | Which field to use when ordering the results. |
position > create
This viewset returns a list of all Position objects and includes full CRUD functionality for specific Position objects indexed by id.
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name_ar | |
name_fr |
position > read
This viewset returns a list of all Position objects and includes full CRUD functionality for specific Position objects indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Position. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
ordering | Which field to use when ordering the results. |
position > update
This viewset returns a list of all Position objects and includes full CRUD functionality for specific Position objects indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Position. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
ordering | Which field to use when ordering the results. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name_ar | |
name_fr |
position > partial_update
This viewset returns a list of all Position objects and includes full CRUD functionality for specific Position objects indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Position. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
ordering | Which field to use when ordering the results. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name_ar | |
name_fr |
position > delete
This viewset returns a list of all Position objects and includes full CRUD functionality for specific Position objects indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Position. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
ordering | Which field to use when ordering the results. |
project > list
This viewset returns a list of all Project objects and includes full CRUD functionality for specific Project objects indexed by id.
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
locality | |
start_date | |
start_date__lte | |
start_date__gte | |
end_date | |
end_date__lte | |
end_date__gte | |
search | A search term. |
ordering | Which field to use when ordering the results. |
project > create
This viewset returns a list of all Project objects and includes full CRUD functionality for specific Project objects indexed by id.
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
locality required | |
start_date required | |
end_date required | |
name_ar | |
name_fr | |
type required | |
cost required | |
description required | |
finance_plan |
project > read
This viewset returns a list of all Project objects and includes full CRUD functionality for specific Project objects indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Project. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
locality | |
start_date | |
start_date__lte | |
start_date__gte | |
end_date | |
end_date__lte | |
end_date__gte | |
search | A search term. |
ordering | Which field to use when ordering the results. |
project > update
This viewset returns a list of all Project objects and includes full CRUD functionality for specific Project objects indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Project. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
locality | |
start_date | |
start_date__lte | |
start_date__gte | |
end_date | |
end_date__lte | |
end_date__gte | |
search | A search term. |
ordering | Which field to use when ordering the results. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
locality required | |
start_date required | |
end_date required | |
name_ar | |
name_fr | |
type required | |
cost required | |
description required | |
finance_plan |
project > partial_update
This viewset returns a list of all Project objects and includes full CRUD functionality for specific Project objects indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Project. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
locality | |
start_date | |
start_date__lte | |
start_date__gte | |
end_date | |
end_date__lte | |
end_date__gte | |
search | A search term. |
ordering | Which field to use when ordering the results. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
locality | |
start_date | |
end_date | |
name_ar | |
name_fr | |
type | |
cost | |
description | |
finance_plan |
project > delete
This viewset returns a list of all Project objects and includes full CRUD functionality for specific Project objects indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Project. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
locality | |
start_date | |
start_date__lte | |
start_date__gte | |
end_date | |
end_date__lte | |
end_date__gte | |
search | A search term. |
ordering | Which field to use when ordering the results. |
royalty > list
This viewset returns a list of all Royalties and includes full CRUD functionality for specific Royalties indexed by id.
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
locality | |
royalty_type | |
year | |
ordering | Which field to use when ordering the results. |
royalty > create
This viewset returns a list of all Royalties and includes full CRUD functionality for specific Royalties indexed by id.
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
locality required | |
year required | |
royalty_type required | |
payments required | |
payments_due required |
royalty > read
This viewset returns a list of all Royalties and includes full CRUD functionality for specific Royalties indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Royalty. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
locality | |
royalty_type | |
year | |
ordering | Which field to use when ordering the results. |
royalty > update
This viewset returns a list of all Royalties and includes full CRUD functionality for specific Royalties indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Royalty. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
locality | |
royalty_type | |
year | |
ordering | Which field to use when ordering the results. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
locality required | |
year required | |
royalty_type required | |
payments required | |
payments_due required |
royalty > partial_update
This viewset returns a list of all Royalties and includes full CRUD functionality for specific Royalties indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Royalty. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
locality | |
royalty_type | |
year | |
ordering | Which field to use when ordering the results. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
locality | |
year | |
royalty_type | |
payments | |
payments_due |
royalty > delete
This viewset returns a list of all Royalties and includes full CRUD functionality for specific Royalties indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Royalty. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
locality | |
royalty_type | |
year | |
ordering | Which field to use when ordering the results. |
royalty-type > list
This viewset returns a list of all Royalty Types and includes full CRUD functionality for specific Royalty Types indexed by id.
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
search | A search term. |
ordering | Which field to use when ordering the results. |
royalty-type > create
This viewset returns a list of all Royalty Types and includes full CRUD functionality for specific Royalty Types indexed by id.
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name_fr | |
name_ar | |
wiki_description required |
royalty-type > read
This viewset returns a list of all Royalty Types and includes full CRUD functionality for specific Royalty Types indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Royalty Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
ordering | Which field to use when ordering the results. |
royalty-type > update
This viewset returns a list of all Royalty Types and includes full CRUD functionality for specific Royalty Types indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Royalty Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
ordering | Which field to use when ordering the results. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name_fr | |
name_ar | |
wiki_description required |
royalty-type > partial_update
This viewset returns a list of all Royalty Types and includes full CRUD functionality for specific Royalty Types indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Royalty Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
ordering | Which field to use when ordering the results. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name_fr | |
name_ar | |
wiki_description |
royalty-type > delete
This viewset returns a list of all Royalty Types and includes full CRUD functionality for specific Royalty Types indexed by id.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Royalty Type. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
ordering | Which field to use when ordering the results. |
text
ccl-code > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
parent | |
search | A search term. |
ordering | Which field to use when ordering the results. |
ccl-code > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
parent required | |
content required |
ccl-code > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this CCL Code. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
parent | |
search | A search term. |
ordering | Which field to use when ordering the results. |
ccl-code > update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this CCL Code. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
parent | |
search | A search term. |
ordering | Which field to use when ordering the results. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
parent required | |
content required |
ccl-code > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this CCL Code. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
parent | |
search | A search term. |
ordering | Which field to use when ordering the results. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
parent | |
content |
ccl-code > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this CCL Code. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
parent | |
search | A search term. |
ordering | Which field to use when ordering the results. |
ccl-code-hierarchy > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
search | A search term. |
ordering | Which field to use when ordering the results. |
ccl-code-hierarchy > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
title required |
ccl-code-hierarchy > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this CCL Code Hierarchy. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
ordering | Which field to use when ordering the results. |
ccl-code-hierarchy > update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this CCL Code Hierarchy. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
ordering | Which field to use when ordering the results. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
title required |
ccl-code-hierarchy > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this CCL Code Hierarchy. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
ordering | Which field to use when ordering the results. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
title |
ccl-code-hierarchy > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this CCL Code Hierarchy. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
search | A search term. |
ordering | Which field to use when ordering the results. |
ccl-decree > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
category | |
search | A search term. |
ordering | Which field to use when ordering the results. |
ccl-decree > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
date required | |
title required | |
category required | |
number required | |
reference_jort required | |
content required |
ccl-decree > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this CCL Decree. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
category | |
search | A search term. |
ordering | Which field to use when ordering the results. |
ccl-decree > update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this CCL Decree. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
category | |
search | A search term. |
ordering | Which field to use when ordering the results. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
date required | |
title required | |
category required | |
number required | |
reference_jort required | |
content required |
ccl-decree > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this CCL Decree. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
category | |
search | A search term. |
ordering | Which field to use when ordering the results. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
date | |
title | |
category | |
number | |
reference_jort | |
content |
ccl-decree > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this CCL Decree. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
category | |
search | A search term. |
ordering | Which field to use when ordering the results. |
jocl-journal > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
jocl-journal > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
number required | |
date required | |
year required |
jocl-journal > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this JOCL Journal. |
jocl-journal > update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this JOCL Journal. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
number required | |
date required | |
year required |
jocl-journal > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this JOCL Journal. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
number | |
date | |
year |
jocl-journal > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this JOCL Journal. |
jocl-text > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
category | |
locality | |
jocl_journal | |
search | A search term. |
ordering | Which field to use when ordering the results. |
jocl-text > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
title required | |
locality required | |
jocl_journal required | |
content required | |
category required |
jocl-text > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this JOCL Text. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
category | |
locality | |
jocl_journal | |
search | A search term. |
ordering | Which field to use when ordering the results. |
jocl-text > update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this JOCL Text. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
category | |
locality | |
jocl_journal | |
search | A search term. |
ordering | Which field to use when ordering the results. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
title required | |
locality required | |
jocl_journal required | |
content required | |
category required |
jocl-text > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this JOCL Text. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
category | |
locality | |
jocl_journal | |
search | A search term. |
ordering | Which field to use when ordering the results. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
title | |
locality | |
jocl_journal | |
content | |
category |
jocl-text > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this JOCL Text. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
category | |
locality | |
jocl_journal | |
search | A search term. |
ordering | Which field to use when ordering the results. |
law-text > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
themes | |
search | A search term. |
ordering | Which field to use when ordering the results. |
law-text > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
title required | |
content | |
themes required |
law-text > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Law Text. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
themes | |
search | A search term. |
ordering | Which field to use when ordering the results. |
law-text > update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Law Text. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
themes | |
search | A search term. |
ordering | Which field to use when ordering the results. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
title required | |
content | |
themes required |
law-text > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Law Text. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
themes | |
search | A search term. |
ordering | Which field to use when ordering the results. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
title | |
content | |
themes |
law-text > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Law Text. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
themes | |
search | A search term. |
ordering | Which field to use when ordering the results. |
law-theme > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
law-theme > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
title required |
law-theme > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Law Theme. |
law-theme > update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Law Theme. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
title required |
law-theme > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Law Theme. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
title |
law-theme > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Law Theme. |
transparency
criteria > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
level | |
search | A search term. |
ordering | Which field to use when ordering the results. |
criteria > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name_fr | |
name_ar | |
max_score required | |
level required | |
parent required |
criteria > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Criterion. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
level | |
search | A search term. |
ordering | Which field to use when ordering the results. |
criteria > update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Criterion. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
level | |
search | A search term. |
ordering | Which field to use when ordering the results. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name_fr | |
name_ar | |
max_score required | |
level required | |
parent required |
criteria > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Criterion. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
level | |
search | A search term. |
ordering | Which field to use when ordering the results. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name_fr | |
name_ar | |
max_score | |
level | |
parent |
criteria > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Criterion. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
level | |
search | A search term. |
ordering | Which field to use when ordering the results. |
evaluations > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
locality | |
criterion | |
year | |
search | A search term. |
ordering | Which field to use when ordering the results. |
evaluations > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
locality required | |
criterion required | |
year required | |
score required |
evaluations > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Evaluation. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
locality | |
criterion | |
year | |
search | A search term. |
ordering | Which field to use when ordering the results. |
evaluations > update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Evaluation. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
locality | |
criterion | |
year | |
search | A search term. |
ordering | Which field to use when ordering the results. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
locality required | |
criterion required | |
year required | |
score required |
evaluations > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Evaluation. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
locality | |
criterion | |
year | |
search | A search term. |
ordering | Which field to use when ordering the results. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
locality | |
criterion | |
year | |
score |
evaluations > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Evaluation. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
locality | |
criterion | |
year | |
search | A search term. |
ordering | Which field to use when ordering the results. |