alti_api.versions.v1_0.responses module

Responses that can be returned from the API

async alti_api.versions.v1_0.responses.format_response(data: dict, output_format: format_enum | None = format_enum.json, indent: boolean_enum | None = boolean_enum.false, measures: boolean_enum | None = boolean_enum.false, zonly: boolean_enum | None = boolean_enum.false) → Response

Format the response

Paramètres:

• data – Dict of data to be formatted

• output_format – Output format

• indent – If true, data indented

• measures – If true, add measures details for each pyramide of the resource

• zonly – If true, response not extended

Renvoie:

Formatted response

async alti_api.versions.v1_0.responses.format_response_error(content: str, output_format: format_enum | None = format_enum.json, indent: boolean_enum | None = boolean_enum.false) → Response

Format the error content

Paramètres:

• content – Error message to be formatted

• output_format – Output format

• indent – If true, data indented

Renvoie:

Formatted response content

async alti_api.versions.v1_0.responses.format_response_to_json(data: dict, indent: boolean_enum | None = boolean_enum.false) → Response

Format the data into a valid JSON representation

Paramètres:

• data – Data to be formatted

• indent – If true, data to be indented

Renvoie:

Data formatted into a valid JSON representation

async alti_api.versions.v1_0.responses.format_response_to_xml(data: dict, indent: boolean_enum | None = boolean_enum.false, measures: boolean_enum | None = boolean_enum.false, zonly: boolean_enum | None = boolean_enum.false)

Format the data into a valid XML representation

Paramètres:

• data – Data to be formatted

• indent – If true, data to be indented

• measures – If true, add measures details for each pyramide of the resource

• zonly – If true, response not extended

Renvoie:

Data formatted into a valid XML representation