gpf_pub_agent_altimetrie.altimetrie_api_client module

Classe pour requêter l’API Administration de Altimetrie

class gpf_pub_agent_altimetrie.altimetrie_api_client.AltimetrieAPIClient(url: str)

Bases : object

Cette classe permet d’envoyer des requêtes à Altimetrie

create_resource(res: dict) → bool

Requête de création d’une nouvelle route /resources/*

Renvoie:

état de création de la ressource

Type renvoyé:

bool

get_resource(resource_id: str)

Requête sur la route /resources

Renvoie:

une resource de Altimetrie

Type renvoyé:

str

get_resources() → list[str]

Requête sur la route /resources

Renvoie:

Liste des ressources disponibles sur le service

Type renvoyé:

List[str]

health() → bool

Requête sur la route /

Vérifie l’état de Altimetrie :returns: Renvoie true si Altimetrie est en état de marche :rtype: bool

remove_resource(resource_id: str)

Requête sur la route /resources

Renvoie:

Liste des resources disponibles de Altimetrie

Type renvoyé:

List[str]