akvo.rest.serializers package

Akvo RSR is covered by the GNU Affero General Public License. See more details in the license.txt file located at the root folder of the Akvo RSR module. For additional details on the GNU license please see < http://www.gnu.org/licenses/agpl.html >.

class akvo.rest.serializers.AdministrativeLocationSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of AdministrativeLocation

class akvo.rest.serializers.BudgetItemLabelSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of BudgetItemLabel

class akvo.rest.serializers.BudgetItemRawSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of BudgetItem

class akvo.rest.serializers.BudgetItemSerializer(*args, **kwargs)

Bases: BudgetItemRawSerializer

class akvo.rest.serializers.CountryBudgetItemSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of CountryBudgetItem

class akvo.rest.serializers.CountrySerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of Country

class akvo.rest.serializers.CrsAddOtherFlagSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of CrsAddOtherFlag

class akvo.rest.serializers.CrsAddSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

extra_kwargs = {'channel_code': {'allow_null': True, 'required': False}}

fields = '__all__'

model

alias of CrsAdd

validate_channel_code(value)

class akvo.rest.serializers.DefaultPeriodSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of DefaultPeriod

class akvo.rest.serializers.DisaggregationSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = ('id', 'update', 'dimension_value', 'value', 'numerator', 'denominator', 'incomplete_data', 'category', 'category_id', 'type', 'type_id', 'created_at', 'last_modified_at')

model

alias of Disaggregation

class akvo.rest.serializers.DisaggregationTargetSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of DisaggregationTarget

get_dimension_name(obj)

class akvo.rest.serializers.EmploymentSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of Employment

class akvo.rest.serializers.ExternalProjectSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

exclude = ('related_project',)

model

alias of ExternalProject

class akvo.rest.serializers.FssForecastSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of FssForecast

class akvo.rest.serializers.FssSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of Fss

class akvo.rest.serializers.HumanitarianScopeSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of HumanitarianScope

class akvo.rest.serializers.IatiExportSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of IatiExport

class akvo.rest.serializers.IndicatorCustomFieldSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of IndicatorCustomField

class akvo.rest.serializers.IndicatorCustomValueSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = ('id', 'indicator', 'custom_field', 'text_value', 'boolean_value', 'dropdown_selection')

model

alias of IndicatorCustomValue

class akvo.rest.serializers.IndicatorDisaggregationTargetSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of IndicatorDisaggregationTarget

get_dimension_name(obj)

class akvo.rest.serializers.IndicatorFrameworkSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

exclude = ['enumerators']

model

alias of Indicator

to_internal_value(data)

Dict of native values <- Dict of primitive datatypes.

update(instance, validated_data)

validate_cumulative(data)

validate_disaggregation_targets(data)

class akvo.rest.serializers.IndicatorPeriodAggregationJobSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of IndicatorPeriodAggregationJob

class akvo.rest.serializers.IndicatorPeriodDataCommentSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of IndicatorPeriodDataComment

read_only_fields = ['user']

class akvo.rest.serializers.IndicatorPeriodDataFrameworkSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of IndicatorPeriodData

read_only_fields = ['user']

create(validated_data)

We have a bit of extra checking around this in order to provide descriptive messages when something goes wrong, but this method is essentially just:

return ExampleModel.objects.create(**validated_data)

If there are many to many fields present on the instance then they cannot be set until the model is instantiated, in which case the implementation is like so:

example_relationship = validated_data.pop(‘example_relationship’) instance = ExampleModel.objects.create(**validated_data) instance.example_relationship = example_relationship return instance

The default implementation also does not handle nested relationships. If you want to support writable nested relationships you’ll need to write an explicit .create() method.

get_audit_trail(obj)

is_valid(raise_exception=False)

update(instance, validated_data)

class akvo.rest.serializers.IndicatorPeriodDataSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of IndicatorPeriodData

read_only_fields = ['user']

class akvo.rest.serializers.IndicatorPeriodFrameworkSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of IndicatorPeriod

get_disaggregation_targets(obj)

get_updates(obj)

class akvo.rest.serializers.IndicatorPeriodLabelSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of IndicatorPeriodLabel

class akvo.rest.serializers.IndicatorPeriodSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of IndicatorPeriod

create(validated_data)

We have a bit of extra checking around this in order to provide descriptive messages when something goes wrong, but this method is essentially just:

return ExampleModel.objects.create(**validated_data)

If there are many to many fields present on the instance then they cannot be set until the model is instantiated, in which case the implementation is like so:

example_relationship = validated_data.pop(‘example_relationship’) instance = ExampleModel.objects.create(**validated_data) instance.example_relationship = example_relationship return instance

The default implementation also does not handle nested relationships. If you want to support writable nested relationships you’ll need to write an explicit .create() method.

update(instance, validated_data)

validate_disaggregation_targets(data)

class akvo.rest.serializers.IndicatorReferenceSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of IndicatorReference

class akvo.rest.serializers.IndicatorSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

exclude = ['enumerators']

model

alias of Indicator

get_disaggregation_targets(obj)

class akvo.rest.serializers.KeywordSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of Keyword

class akvo.rest.serializers.LegacyDataSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of LegacyData

class akvo.rest.serializers.LinkSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of Link

class akvo.rest.serializers.OrganisationBasicSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = ('id', 'name', 'long_name', 'logo')

model

alias of Organisation

class akvo.rest.serializers.OrganisationCountryBudgetLineSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of OrganisationCountryBudgetLine

class akvo.rest.serializers.OrganisationCountryBudgetSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of OrganisationCountryBudget

class akvo.rest.serializers.OrganisationCustomFieldSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of OrganisationCustomField

class akvo.rest.serializers.OrganisationDocumentCategorySerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of OrganisationDocumentCategory

class akvo.rest.serializers.OrganisationDocumentCountrySerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of OrganisationDocumentCountry

class akvo.rest.serializers.OrganisationDocumentSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of OrganisationDocument

class akvo.rest.serializers.OrganisationExpenseLineSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of OrganisationExpenseLine

class akvo.rest.serializers.OrganisationIndicatorLabelSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of OrganisationIndicatorLabel

class akvo.rest.serializers.OrganisationLocationSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of OrganisationLocation

class akvo.rest.serializers.OrganisationRecipientOrgBudgetLineSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of OrganisationRecipientOrgBudgetLine

class akvo.rest.serializers.OrganisationRecipientOrgBudgetSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of OrganisationRecipientOrgBudget

class akvo.rest.serializers.OrganisationRegionBudgetLineSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of OrganisationRegionBudgetLine

class akvo.rest.serializers.OrganisationRegionBudgetSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of OrganisationRegionBudget

class akvo.rest.serializers.OrganisationSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of Organisation

create(validated_data)

We have a bit of extra checking around this in order to provide descriptive messages when something goes wrong, but this method is essentially just:

return ExampleModel.objects.create(**validated_data)

If there are many to many fields present on the instance then they cannot be set until the model is instantiated, in which case the implementation is like so:

example_relationship = validated_data.pop(‘example_relationship’) instance = ExampleModel.objects.create(**validated_data) instance.example_relationship = example_relationship return instance

The default implementation also does not handle nested relationships. If you want to support writable nested relationships you’ll need to write an explicit .create() method.

get_current_user_permissions(organisation)

class akvo.rest.serializers.OrganisationTotalBudgetLineSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of OrganisationTotalBudgetLine

class akvo.rest.serializers.OrganisationTotalBudgetSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of OrganisationTotalBudget

class akvo.rest.serializers.OrganisationTotalExpenditureSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of OrganisationTotalExpenditure

class akvo.rest.serializers.PartnershipBasicSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = ('id', 'project', 'organisation', 'iati_organisation_role', 'iati_organisation_role_label')

model

alias of Partnership

class akvo.rest.serializers.PartnershipRawDeepSerializer(*args, **kwargs)

Bases: PartnershipRawSerializer

class akvo.rest.serializers.PartnershipRawSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of Partnership

class akvo.rest.serializers.PartnershipSerializer(*args, **kwargs)

Bases: PartnershipRawSerializer

class akvo.rest.serializers.PlannedDisbursementRawDeepSerializer(*args, **kwargs)

Bases: PlannedDisbursementRawSerializer

class akvo.rest.serializers.PlannedDisbursementRawSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of PlannedDisbursement

class akvo.rest.serializers.PlannedDisbursementSerializer(*args, **kwargs)

Bases: PlannedDisbursementRawSerializer

class akvo.rest.serializers.PolicyMarkerRawSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of PolicyMarker

class akvo.rest.serializers.PolicyMarkerSerializer(*args, **kwargs)

Bases: PolicyMarkerRawSerializer

class akvo.rest.serializers.ProjectConditionRawSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of ProjectCondition

class akvo.rest.serializers.ProjectContactRawDeepSerializer(*args, **kwargs)

Bases: ProjectContactRawSerializer

class akvo.rest.serializers.ProjectContactRawSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of ProjectContact

class akvo.rest.serializers.ProjectContactSerializer(*args, **kwargs)

Bases: ProjectContactRawSerializer

class akvo.rest.serializers.ProjectCustomFieldSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of ProjectCustomField

class akvo.rest.serializers.ProjectDirectoryDynamicFieldsSerializer(*args, **kwargs)

Bases: ModelSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of Project

get_countries(project)

get_image(project: Project)

get_partners(project)

class akvo.rest.serializers.ProjectDirectorySerializer(*args, **kwargs)

Bases: ModelSerializer

class Meta

Bases: object

fields = ('id', 'title', 'subtitle', 'summary', 'latitude', 'longitude', 'image', 'countries', 'organisation', 'organisations', 'sectors', 'dropdown_custom_fields', 'order_score')

model

alias of Project

get_countries(project)

get_dropdown_custom_fields(project)

get_image(project)

get_order_score(project)

get_organisations(project)

get_sectors(project)

class akvo.rest.serializers.ProjectDocumentRawSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of ProjectDocument

class akvo.rest.serializers.ProjectDocumentSerializer(*args, **kwargs)

Bases: ProjectDocumentRawSerializer

create(validated_data)

We have a bit of extra checking around this in order to provide descriptive messages when something goes wrong, but this method is essentially just:

return ExampleModel.objects.create(**validated_data)

If there are many to many fields present on the instance then they cannot be set until the model is instantiated, in which case the implementation is like so:

example_relationship = validated_data.pop(‘example_relationship’) instance = ExampleModel.objects.create(**validated_data) instance.example_relationship = example_relationship return instance

The default implementation also does not handle nested relationships. If you want to support writable nested relationships you’ll need to write an explicit .create() method.

update(document, validated_data)

class akvo.rest.serializers.ProjectExtraSerializer(*args, **kwargs)

Bases: ProjectSerializer

class Meta

Bases: Meta

class akvo.rest.serializers.ProjectHierarchySerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = ('id', 'root_project', 'organisation', 'max_depth', 'is_master')

model

alias of ProjectHierarchy

class akvo.rest.serializers.ProjectIatiExportSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = ('id', 'title', 'is_public', 'publishing_status', 'status', 'checks_errors', 'checks_warnings', 'iati_status', 'date_start_actual', 'date_end_actual')

model

alias of Project

class akvo.rest.serializers.ProjectLocationCountryNameSerializer(*args, **kwargs)

Bases: Serializer

class Meta

Bases: object

fields = ('country', 'iso_code')

class akvo.rest.serializers.ProjectLocationRawSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of ProjectLocation

class akvo.rest.serializers.ProjectLocationSerializer(*args, **kwargs)

Bases: ProjectLocationRawSerializer

create(validated_data)

We have a bit of extra checking around this in order to provide descriptive messages when something goes wrong, but this method is essentially just:

return ExampleModel.objects.create(**validated_data)

If there are many to many fields present on the instance then they cannot be set until the model is instantiated, in which case the implementation is like so:

example_relationship = validated_data.pop(‘example_relationship’) instance = ExampleModel.objects.create(**validated_data) instance.example_relationship = example_relationship return instance

The default implementation also does not handle nested relationships. If you want to support writable nested relationships you’ll need to write an explicit .create() method.

update(instance, validated_data)

class akvo.rest.serializers.ProjectMetadataSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = ('id', 'title', 'subtitle', 'date_end_actual', 'date_end_planned', 'date_start_actual', 'date_start_planned', 'locations', 'status', 'is_public', 'sectors', 'parent', 'editable', 'recipient_countries', 'restricted', 'roles', 'use_project_roles', 'is_program', 'primary_organisation', 'children_count')

model

alias of Project

get_children_count(obj)

get_editable(obj)

Method used by the editable SerializerMethodField

get_locations(obj)

get_parent(obj)

get_restricted(project)

True if the project is restricted for the user

class akvo.rest.serializers.ProjectRoleSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = ('id', 'project', 'email', 'role', 'name')

model

alias of ProjectRole

class akvo.rest.serializers.ProjectSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of Project

create(validated_data)

We have a bit of extra checking around this in order to provide descriptive messages when something goes wrong, but this method is essentially just:

return ExampleModel.objects.create(**validated_data)

If there are many to many fields present on the instance then they cannot be set until the model is instantiated, in which case the implementation is like so:

example_relationship = validated_data.pop(‘example_relationship’) instance = ExampleModel.objects.create(**validated_data) instance.example_relationship = example_relationship return instance

The default implementation also does not handle nested relationships. If you want to support writable nested relationships you’ll need to write an explicit .create() method.

get_can_edit_access(obj)

get_can_edit_enumerator_access(obj)

get_can_edit_settings(obj)

get_can_publish(obj)

get_created_at(project: Project)

This is a work around to silence the “Invalid datetime for the timezone Europe/Stockholm” which has appeared several times and not yet known why.

TODO: This may no longer necessary as of Django 4.2

get_editable(obj)

Method used by the editable SerializerMethodField

get_iati_profile_url(obj)

get_path(project: Project)

get_program(obj)

update(project: Project, validated_data: dict)

class akvo.rest.serializers.ProjectUpSerializer(*args, **kwargs)

Bases: ProjectSerializer

Custom endpoint for RSR Up

class Meta

Bases: Meta

class akvo.rest.serializers.ProjectUpdateDeepSerializer(*args, **kwargs)

Bases: ProjectUpdateSerializer

Deep serializer for project updates.

class akvo.rest.serializers.ProjectUpdateExtraSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

This serializer includes data about user and connected organisation.

class Meta

Bases: object

depth = 2

fields = '__all__'

model

alias of ProjectUpdate

class akvo.rest.serializers.ProjectUpdateLocationNestedSerializer(*args, **kwargs)

Bases: ProjectUpdateLocationSerializer

class Meta

Bases: object

exclude = ('location_target',)

model

alias of ProjectUpdateLocation

class akvo.rest.serializers.ProjectUpdateLocationSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of ProjectUpdateLocation

class akvo.rest.serializers.ProjectUpdatePhotoSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of ProjectUpdatePhoto

class akvo.rest.serializers.ProjectUpdateSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

Serializer for project updates.

class Meta

Bases: object

extra_kwargs = {'photo_caption': {'allow_null': True, 'required': False}, 'photo_credit': {'allow_null': True, 'required': False}, 'video_caption': {'allow_null': True, 'required': False}, 'video_credit': {'allow_null': True, 'required': False}}

fields = '__all__'

model

alias of ProjectUpdate

read_only_fields = ['user']

create(validated_data)

We have a bit of extra checking around this in order to provide descriptive messages when something goes wrong, but this method is essentially just:

return ExampleModel.objects.create(**validated_data)

If there are many to many fields present on the instance then they cannot be set until the model is instantiated, in which case the implementation is like so:

example_relationship = validated_data.pop(‘example_relationship’) instance = ExampleModel.objects.create(**validated_data) instance.example_relationship = example_relationship return instance

The default implementation also does not handle nested relationships. If you want to support writable nested relationships you’ll need to write an explicit .create() method.

get_deletable(obj)

Method used by the deletable SerializerMethodField

get_editable(obj)

Method used by the editable SerializerMethodField

class akvo.rest.serializers.PublishingStatusSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of PublishingStatus

class akvo.rest.serializers.RecipientCountryRawSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of RecipientCountry

class akvo.rest.serializers.RecipientCountrySerializer(*args, **kwargs)

Bases: RecipientCountryRawSerializer

class akvo.rest.serializers.RecipientRegionRawSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of RecipientRegion

class akvo.rest.serializers.RecipientRegionSerializer(*args, **kwargs)

Bases: RecipientRegionRawSerializer

class akvo.rest.serializers.RelatedProjectRawSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of RelatedProject

class akvo.rest.serializers.RelatedProjectSerializer(*args, **kwargs)

Bases: RelatedProjectRawSerializer

class akvo.rest.serializers.ReportFormatSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = ('name', 'display_name', 'icon')

model

alias of ReportFormat

class akvo.rest.serializers.ReportSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = ('id', 'name', 'title', 'description', 'url', 'parameters', 'formats', 'organisations')

model

alias of Report

class akvo.rest.serializers.ResultRawSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of Result

class akvo.rest.serializers.ResultSerializer(*args, **kwargs)

Bases: ResultRawSerializer

class akvo.rest.serializers.ResultSerializerV2(*args, **kwargs)

Bases: ResultRawSerializer

class akvo.rest.serializers.ResultsFrameworkSerializer(*args, **kwargs)

Bases: ResultRawSerializer

class akvo.rest.serializers.SectorRawSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of Sector

class akvo.rest.serializers.SectorSerializer(*args, **kwargs)

Bases: SectorRawSerializer

class akvo.rest.serializers.TransactionRawDeepSerializer(*args, **kwargs)

Bases: TransactionRawSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of Transaction

class akvo.rest.serializers.TransactionRawSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of Transaction

class akvo.rest.serializers.TransactionSectorSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = '__all__'

model

alias of TransactionSector

class akvo.rest.serializers.TransactionSerializer(*args, **kwargs)

Bases: TransactionRawSerializer

class akvo.rest.serializers.TypeaheadOrganisationSerializer(*args, **kwargs)

Bases: ModelSerializer

class Meta

Bases: object

fields = ('id', 'name', 'long_name')

model

alias of Organisation

class akvo.rest.serializers.TypeaheadProjectSerializer(*args, **kwargs)

Bases: ModelSerializer

class Meta

Bases: object

fields = ('id', 'title', 'subtitle')

model

alias of Project

class akvo.rest.serializers.TypeaheadProjectUpdateSerializer(*args, **kwargs)

Bases: ModelSerializer

class Meta

Bases: object

fields = ('id', 'project', 'title')

model

alias of ProjectUpdate

class akvo.rest.serializers.TypeaheadSectorSerializer(*args, **kwargs)

Bases: ModelSerializer

class Meta

Bases: object

fields = ('id', 'name')

model

alias of Sector

get_id(obj)

get_name(obj)

sectors = {'111': 'Education, Level Unspecified', '112': 'Basic Education', '113': 'Secondary Education', '114': 'Post-Secondary Education', '121': 'Health, General', '122': 'Basic Health', '123': 'Non-communicable diseases (NCDs)', '130': 'Population Policies/Programmes & Reproductive Health', '140': 'Water Supply & Sanitation', '151': 'Government & Civil Society-general', '152': 'Conflict, Peace & Security', '160': 'Other Social Infrastructure & Services', '210': 'Transport & Storage', '220': 'Communications', '230': 'ENERGY GENERATION AND SUPPLY', '231': 'Energy Policy', '232': 'Energy generation, renewable sources', '233': 'Energy generation, non-renewable sources', '234': 'Hybrid energy plants', '235': 'Nuclear energy plants', '236': 'Energy distribution', '240': 'Banking & Financial Services', '250': 'Business & Other Services', '311': 'Agriculture', '312': 'Forestry', '313': 'Fishing', '321': 'Industry', '322': 'Mineral Resources & Mining', '323': 'Construction', '331': 'Trade Policies & Regulations', '332': 'Tourism', '410': 'General Environment Protection', '430': 'Other Multisector', '510': 'General Budget Support', '520': 'Development Food Assistance', '530': 'Other Commodity Assistance', '600': 'Action Relating to Debt', '720': 'Emergency Response', '730': 'Reconstruction Relief & Rehabilitation', '740': 'Disaster Prevention & Preparedness', '910': 'Administrative Costs of Donors', '920': 'SUPPORT TO NON- GOVERNMENTAL ORGANISATIONS (NGOs)', '930': 'Refugees in Donor Countries', '998': 'Unallocated / Unspecified'}

class akvo.rest.serializers.UserDetailsSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = ('id', 'email', 'first_name', 'last_name', 'approved_organisations')

model

alias of User

class akvo.rest.serializers.UserPasswordSerializer(*args, **kwargs)

Bases: Serializer

Change password serializer

class Meta

Bases: object

fields = '__all__'

save()

validate(data)

Check if password1 and password2 match

validate_old_password(value)

Check for current password

class akvo.rest.serializers.UserRawSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

Raw user serializer.

class Meta

Bases: object

fields = ('id', 'first_name', 'last_name', 'email', 'is_active', 'is_staff', 'is_admin', 'is_support', 'is_superuser')

model

alias of User

class akvo.rest.serializers.UserSerializer(*args, **kwargs)

Bases: BaseRSRSerializer

class Meta

Bases: object

fields = ('id', 'first_name', 'last_name', 'email', 'username', 'is_active', 'is_staff', 'is_admin', 'is_support', 'is_superuser', 'can_manage_users', 'organisation', 'organisations', 'approved_employments', 'api_key', 'enforce_2fa', 'otp_keys', 'legacy_org', 'programs', 'user_management_organisations', 'seen_announcements')

model

alias of User

get_can_manage_users(obj)

get_legacy_org(obj)

Up needs the last tag to be the user’s org, it only needs the org ID

get_otp_keys(obj)

get_programs(user)

get_username(obj)

Submodules

• akvo.rest.serializers.budget_item module
  • BudgetItemRawDeepSerializer
  • BudgetItemRawSerializer
  • BudgetItemSerializer
  • CountryBudgetItemSerializer
• akvo.rest.serializers.budget_item_label module
  • BudgetItemLabelSerializer
• akvo.rest.serializers.country module
  • CountrySerializer
• akvo.rest.serializers.crs_add module
  • CrsAddOtherFlagSerializer
  • CrsAddSerializer
• akvo.rest.serializers.custom_field module
  • OrganisationCustomFieldSerializer
  • ProjectCustomFieldSerializer
  • ProjectDirectoryProjectCustomFieldSerializer
• akvo.rest.serializers.default_period module
  • DefaultPeriodSerializer
• akvo.rest.serializers.disaggregation module
  • DisaggregationReadOnlySerializer
  • DisaggregationSerializer
• akvo.rest.serializers.disaggregation_contribution module
  • DisaggregationContributionSerializer
• akvo.rest.serializers.disaggregation_target module
  • DisaggregationTargetSerializer
• akvo.rest.serializers.employment module
  • EmploymentSerializer
• akvo.rest.serializers.external_project module
  • ExternalProjectSerializer
• akvo.rest.serializers.fss module
  • FssForecastSerializer
  • FssSerializer
• akvo.rest.serializers.humanitarian_scope module
  • HumanitarianScopeSerializer
• akvo.rest.serializers.iati_export module
  • IatiExportSerializer
• akvo.rest.serializers.indicator module
  • IndicatorDisaggregationTargetNestedSerializer
  • IndicatorFrameworkLiteSerializer
  • IndicatorFrameworkNotSoLiteSerializer
  • IndicatorFrameworkSerializer
  • IndicatorSerializer
  • LabelListingField
  • serialize_disaggregation_targets()
• akvo.rest.serializers.indicator_custom_field module
  • IndicatorCustomFieldSerializer
  • IndicatorCustomValueSerializer
• akvo.rest.serializers.indicator_dimension_name module
  • IndicatorDimensionNameSerializer
• akvo.rest.serializers.indicator_dimension_value module
  • IndicatorDimensionValueSerializer
• akvo.rest.serializers.indicator_disaggregation_target module
  • IndicatorDisaggregationTargetSerializer
• akvo.rest.serializers.indicator_period module
  • DisaggregationTargetNestedSerializer
  • IndicatorPeriodFrameworkLiteSerializer
  • IndicatorPeriodFrameworkNotSoLiteSerializer
  • IndicatorPeriodFrameworkSerializer
  • IndicatorPeriodSerializer
  • create_or_update_disaggregation_targets()
  • serialize_disaggregation_targets()
• akvo.rest.serializers.indicator_period_aggregation_job module
  • IndicatorPeriodAggregationJobSerializer
• akvo.rest.serializers.indicator_period_data module
  • IndicatorPeriodDataCommentNestedSerializer
  • IndicatorPeriodDataCommentSerializer
  • IndicatorPeriodDataFileSerializer
  • IndicatorPeriodDataFrameworkSerializer
  • IndicatorPeriodDataLiteSerializer
  • IndicatorPeriodDataPhotoSerializer
  • IndicatorPeriodDataSerializer
• akvo.rest.serializers.indicator_period_disaggregation module
  • IndicatorPeriodDisaggregationLiteSerializer
  • IndicatorPeriodDisaggregationReadOnlySerializer
• akvo.rest.serializers.indicator_period_label module
  • IndicatorPeriodLabelSerializer
• akvo.rest.serializers.indicator_reference module
  • IndicatorReferenceSerializer
• akvo.rest.serializers.keyword module
  • KeywordSerializer
• akvo.rest.serializers.legacy_data module
  • LegacyDataSerializer
• akvo.rest.serializers.link module
  • LinkSerializer
• akvo.rest.serializers.organisation module
  • OrganisationBasicSerializer
  • OrganisationExtraSerializer
  • OrganisationSerializer
  • UserManagementOrgSerializer
• akvo.rest.serializers.organisation_budget module
  • OrganisationCountryBudgetLineSerializer
  • OrganisationCountryBudgetSerializer
  • OrganisationExpenseLineSerializer
  • OrganisationRecipientOrgBudgetLineSerializer
  • OrganisationRecipientOrgBudgetSerializer
  • OrganisationRegionBudgetLineSerializer
  • OrganisationRegionBudgetSerializer
  • OrganisationTotalBudgetLineSerializer
  • OrganisationTotalBudgetSerializer
  • OrganisationTotalExpenditureSerializer
• akvo.rest.serializers.organisation_document module
  • OrganisationDocumentCategorySerializer
  • OrganisationDocumentCountrySerializer
  • OrganisationDocumentSerializer
• akvo.rest.serializers.organisation_indicator_label module
  • OrganisationIndicatorLabelSerializer
• akvo.rest.serializers.organisation_location module
  • MapOrganisationSerializer
  • OrganisationLocationExtraSerializer
  • OrganisationLocationSerializer
• akvo.rest.serializers.partnership module
  • PartnershipBasicSerializer
  • PartnershipRawDeepSerializer
  • PartnershipRawSerializer
  • PartnershipSerializer
• akvo.rest.serializers.planned_disbursement module
  • PlannedDisbursementRawDeepSerializer
  • PlannedDisbursementRawSerializer
  • PlannedDisbursementSerializer
• akvo.rest.serializers.policy_marker module
  • PolicyMarkerRawSerializer
  • PolicyMarkerSerializer
• akvo.rest.serializers.program module
  • ProgramSerializer
• akvo.rest.serializers.project module
  • ProjectDirectoryDynamicFieldsSerializer
  • ProjectDirectorySerializer
  • ProjectExtraSerializer
  • ProjectIatiExportSerializer
  • ProjectMetadataSerializer
  • ProjectSerializer
  • ProjectUpSerializer
  • TargetsAtField
  • make_descendants_tree()
• akvo.rest.serializers.project_condition module
  • ProjectConditionRawSerializer
• akvo.rest.serializers.project_contact module
  • ProjectContactRawDeepSerializer
  • ProjectContactRawSerializer
  • ProjectContactSerializer
• akvo.rest.serializers.project_document module
  • CategoryListingField
  • ProjectDocumentRawSerializer
  • ProjectDocumentSerializer
• akvo.rest.serializers.project_hierarchy module
  • ProjectHierarchySerializer
• akvo.rest.serializers.project_location module
  • AdministrativeLocationSerializer
  • MapProjectSerializer
  • ProjectLocationCountryNameSerializer
  • ProjectLocationExtraSerializer
  • ProjectLocationRawSerializer
  • ProjectLocationSerializer
• akvo.rest.serializers.project_role module
  • ProjectRoleSerializer
• akvo.rest.serializers.project_update module
  • ProjectUpdateDeepSerializer
  • ProjectUpdateExtraSerializer
  • ProjectUpdatePhotoSerializer
  • ProjectUpdateSerializer
• akvo.rest.serializers.project_update_location module
  • ProjectUpdateLocationExtraSerializer
  • ProjectUpdateLocationNestedSerializer
  • ProjectUpdateLocationSerializer
• akvo.rest.serializers.publishing_status module
  • PublishingStatusSerializer
• akvo.rest.serializers.recipient_country module
  • RecipientCountryRawSerializer
  • RecipientCountrySerializer
• akvo.rest.serializers.region module
  • RecipientRegionRawSerializer
  • RecipientRegionSerializer
• akvo.rest.serializers.related_project module
  • RelatedProjectRawSerializer
  • RelatedProjectSerializer
• akvo.rest.serializers.report module
  • ReportFormatSerializer
  • ReportSerializer
• akvo.rest.serializers.result module
  • ResultFrameworkNotSoLiteSerializer
  • ResultRawSerializer
  • ResultSerializer
  • ResultSerializerV2
  • ResultsFrameworkLiteSerializer
  • ResultsFrameworkSerializer
• akvo.rest.serializers.rsr_serializer module
  • BaseRSRSerializer
• akvo.rest.serializers.sector module
  • SectorRawSerializer
  • SectorSerializer
• akvo.rest.serializers.transaction module
  • TransactionRawDeepSerializer
  • TransactionRawSerializer
  • TransactionSectorSerializer
  • TransactionSerializer
• akvo.rest.serializers.typeahead module
  • TypeaheadOrganisationSerializer
  • TypeaheadProjectSerializer
  • TypeaheadProjectUpdateSerializer
  • TypeaheadSectorSerializer
• akvo.rest.serializers.user module
  • UserDetailsSerializer
  • UserPasswordSerializer
  • UserRawSerializer
  • UserSerializer