flexmeasures.api.common.responses
Functions
- flexmeasures.api.common.responses.already_received_and_successfully_processed(message: str) tuple[dict, int] | tuple[dict, int, dict]
- flexmeasures.api.common.responses.conflicting_resolutions(message: str) tuple[dict, int] | tuple[dict, int, dict]
- flexmeasures.api.common.responses.deprecated_api_version(message: str) tuple[dict, int] | tuple[dict, int, dict]
- flexmeasures.api.common.responses.fallback_schedule_redirect(message: str, location: str) tuple[dict, int] | tuple[dict, int, dict]
- flexmeasures.api.common.responses.incomplete_event(requested_event_id, requested_event_type, message) tuple[dict, int] | tuple[dict, int, dict]
- flexmeasures.api.common.responses.invalid_datetime(message: str) tuple[dict, int] | tuple[dict, int, dict]
- flexmeasures.api.common.responses.invalid_domain(message: str) tuple[dict, int] | tuple[dict, int, dict]
- flexmeasures.api.common.responses.invalid_horizon(message: str) tuple[dict, int] | tuple[dict, int, dict]
- flexmeasures.api.common.responses.invalid_message_type(message_type: str) tuple[dict, int] | tuple[dict, int, dict]
- flexmeasures.api.common.responses.invalid_method(request_method) tuple[dict, int] | tuple[dict, int, dict]
- flexmeasures.api.common.responses.invalid_period(message: str) tuple[dict, int] | tuple[dict, int, dict]
- flexmeasures.api.common.responses.invalid_ptu_duration(message: str) tuple[dict, int] | tuple[dict, int, dict]
- flexmeasures.api.common.responses.invalid_replacement(message: str) tuple[dict, int] | tuple[dict, int, dict]
- flexmeasures.api.common.responses.invalid_resolution_str(message: str) tuple[dict, int] | tuple[dict, int, dict]
- flexmeasures.api.common.responses.invalid_role(requested_access_role: str) tuple[dict, int] | tuple[dict, int, dict]
- flexmeasures.api.common.responses.invalid_sender(required_permissions: list[str] | None = None, message: str | None = None) tuple[dict, int] | tuple[dict, int, dict]
Signify that the sender is invalid to perform the request. Fits well with 403 errors. Optionally tell the user which permissions they should have.
- flexmeasures.api.common.responses.invalid_source(message: str) tuple[dict, int] | tuple[dict, int, dict]
- flexmeasures.api.common.responses.invalid_timezone(message: str) tuple[dict, int] | tuple[dict, int, dict]
- flexmeasures.api.common.responses.invalid_unit(quantity: str | None, units: Sequence[str] | tuple[str] | None) tuple[dict, int] | tuple[dict, int, dict]
- flexmeasures.api.common.responses.is_response_tuple(value) bool
Check if an object qualifies as a ResponseTuple
- flexmeasures.api.common.responses.no_message_type(message: str) tuple[dict, int] | tuple[dict, int, dict]
- flexmeasures.api.common.responses.outdated_event_id(requested_event_id, existing_event_id) tuple[dict, int] | tuple[dict, int, dict]
- flexmeasures.api.common.responses.pluralize(usef_role_name: str) str
Adding a trailing ‘s’ works well for USEF roles.
- flexmeasures.api.common.responses.power_value_too_big(message: str) tuple[dict, int] | tuple[dict, int, dict]
- flexmeasures.api.common.responses.power_value_too_small(message: str) tuple[dict, int] | tuple[dict, int, dict]
- flexmeasures.api.common.responses.ptus_incomplete(message: str) tuple[dict, int] | tuple[dict, int, dict]
- flexmeasures.api.common.responses.request_accepted_for_processing(job_id: str, message: str = 'Request has been accepted for processing.', legacy_key: str | None = None, deprecated_since: str | None = None, job_results_url: str | None = None) tuple[dict, int] | tuple[dict, int, dict]
Standard 202 response when a background job is accepted.
Optional backwards-compatibility: if legacy_key is provided the response will include the job id under that legacy key (e.g. schedule or forecast). The response will also include a deprecated-fields object with guidance for migrating to job.
Optional job_results_url may be supplied to provide a direct link to the sensor-specific job results endpoint, e.g. /api/v3_0/sensors/<id>/schedules/<uuid>.
- flexmeasures.api.common.responses.request_processed(message: str) tuple[dict, int] | tuple[dict, int, dict]
- flexmeasures.api.common.responses.request_too_large(message: str) tuple[dict, int] | tuple[dict, int, dict]
- flexmeasures.api.common.responses.required_info_missing(fields: Sequence[str], message: str = '') tuple[dict, int] | tuple[dict, int, dict]
- flexmeasures.api.common.responses.unapplicable_resolution(message: str) tuple[dict, int] | tuple[dict, int, dict]
- flexmeasures.api.common.responses.unknown_forecast(message: str) tuple[dict, int] | tuple[dict, int, dict]
- flexmeasures.api.common.responses.unknown_prices(message: str) tuple[dict, int] | tuple[dict, int, dict]
- flexmeasures.api.common.responses.unknown_schedule(message: str) tuple[dict, int] | tuple[dict, int, dict]
- flexmeasures.api.common.responses.unprocessable_entity(message: str) tuple[dict, int] | tuple[dict, int, dict]
- flexmeasures.api.common.responses.unrecognized_asset(message: str) tuple[dict, int] | tuple[dict, int, dict]
- flexmeasures.api.common.responses.unrecognized_connection_group(message: str) tuple[dict, int] | tuple[dict, int, dict]
- flexmeasures.api.common.responses.unrecognized_event(requested_event_id, requested_event_type) tuple[dict, int] | tuple[dict, int, dict]
- flexmeasures.api.common.responses.unrecognized_event_type(requested_event_type) tuple[dict, int] | tuple[dict, int, dict]
- flexmeasures.api.common.responses.unrecognized_market(requested_market) tuple[dict, int] | tuple[dict, int, dict]
- flexmeasures.api.common.responses.unrecognized_sensor(lat: float | None = None, lng: float | None = None) tuple[dict, int] | tuple[dict, int, dict]
Classes