gpf_pub_agent_road2.road2_api_client module

Classe pour requêter l’API Administration de Road2

class gpf_pub_agent_road2.road2_api_client.Road2APIClient(url: str)

Bases : object

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

__init__(url: str) → None

Constructeur de la classe Road2APIClient.

Paramètres:

url (str) – URL de l’API administration de Road2

get_services() → list[str]

Requête sur la route /services

Renvoie:

Liste des identifiants des services disponibles de Road2

Type renvoyé:

List[str]

is_srs_available_in_one_service(srs: str) → bool

Vérifie si une projection est disponible sur un des services

Paramètres:

srs (str) – Identifiant de la projection

Renvoie:

Renvoie true si la projection est disponible sur un des services, False autrement

Type renvoyé:

bool

is_srs_available_in_service(service: str, srs: str) → bool

Requête sur la route /services/:service/projection/:srs

Paramètres:

• service (str) – Identifiant du service

• srs (str) – Identifiant de la projection

Renvoie:

Renvoie true si la projection est disponible sur le service, False autrement

Type renvoyé:

bool

restart(service: str) → bool

Requête sur la route /services/:service/restart

Paramètres:

service (str) – Identifiant du service à redémarrer

Renvoie:

Renvoie true si le service a bien redémarré

Type renvoyé:

bool