API docs by Redocly

opt-temps-attente-agences-api API (2.8.2)

Download OpenAPI specification:Download

API REST des temps d'attente en agence OPT.nc

Api

Récupération des agences

Récupère la liste des agences avec toutes leurs informations. Si les paramètres lon, lat et distanceInMeters sont renseignés (les 3 en même temps), on récupère les agences autour de la position de l'utilisateur, sinon on récupère toutes les agences

query Parameters
commune
string
Examples:
  • commune=Nouméa -
  • commune=NOUMEA -
  • commune=noumea -
  • commune=Paris -

Nom de la commune pour la recherche des agences

distanceInMeters
integer <int64> >= 1
Examples:
  • distanceInMeters=1000 -
  • distanceInMeters=-100 -

Distance en mètres pour la recherche des agences autour de la position de l'utilisateur

lat
number <double> [ -90 .. 90 ]
Examples:
  • lat=-22.276 -
  • lat=100 -

Latitude de la position de l'utilisateur

lon
number <double> [ -180 .. 180 ]
Examples:
  • lon=166.448 -
  • lon=200 -

Longitude de la position de l'utilisateur

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Récupération des agences pour l'IoT

Récupère la liste des agences et de leur id pour l'IoT

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Vérification de la mise à jour des données d'une agence

On vérifie si les données de l'agence sont à jour par rapport à la date actuelle

query Parameters
id
integer <int32> >= 1
Examples:
  • id=1151 -
  • id=4151 -
  • id=-1 -
  • id=99999 -

Identifiant de l'agence, si aucun identifiant n'est renseigné, on prend l'agence principale (1151) par défaut

Responses

Response samples

Content type
application/json
Example
{
  • "idAgence": 1151,
  • "delayInSeconds": "60",
  • "upToDate": "true"
}

Récupération d'une agence par son identifiant

Récupère une agence et ses informations à partir de son identifiant

path Parameters
id
required
integer <int32> >= 1
Examples:
  • 1151 -
  • -1 -
  • 99999 -

Identifiant de l'agence

Responses

Response samples

Content type
application/json
{
  • "idAgence": 1151,
  • "designation": "Agence principale",
  • "realMaxWaitingTimeMs": 0,
  • "realAvgWaitingTimeMs": 0,
  • "estimatedAvgWaitingTimeMs": 0,
  • "coordonneeX": 166.448,
  • "coordonneeY": -22.276,
  • "coordonneeXPrecise": 0,
  • "coordonneeYPrecise": 0,
  • "position": {
    },
  • "commune": "Nouméa",
  • "type": "Agence principale",
  • "codeESirius": "1151",
  • "codePostal": "98800",
  • "lieuDitOuTribu": "",
  • "localite": "Nouméa",
  • "idRefloc": "98818",
  • "codePostalRefloc": "98800",
  • "localiteRefloc": "Nouméa",
  • "updatedDate": "2024-10-08T08:40:00"
}

Historique des temps d'attente d'une agence

Récupère l'historique des temps d'attente d'une agence entre deux dates, si aucune date n'est renseignée, on récupère l'historique du jour

path Parameters
id
required
integer <int32> >= 1
Examples:
  • 1151 -
  • -1 -
  • 99999 -

Identifiant de l'agence

query Parameters
debut
string^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}([+-]\d{2...
Examples:
  • debut=2024-10-08T08:40:00+11:00 -
  • debut=2024-10-08T08:40:00 -

Date de début de l'historique au format ISO 8601 (YYYY-MM-DDTHH:MM:SS+HH:MM)

fin
string^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}([+-]\d{2...
Examples:
  • fin=2024-10-11T08:40:00+11:00 -
  • fin=2024-10-11T08:40:00 -

Date de fin de l'historique au format ISO 8601 (YYYY-MM-DDTHH:MM:SS+HH:MM)

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Historique des temps d'attente d'une agence pour un mois donné

Récupère l'historique des temps d'attente d'une agence pour un mois donné

path Parameters
id
required
integer <int32> >= 1
Examples:
  • 1151 -
  • -1 -
  • 99999 -

Identifiant de l'agence

query Parameters
annee-mois
string^\d{4}-\d{2}$
Examples:
  • annee-mois=2024-10 -
  • annee-mois=2024-13 -

Année et mois de l'historique au format ISO 8601 (YYYY-MM)

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Récupération des noms des communes

Récupère la liste des noms des communes contenant des agences

Responses

Response samples

Content type
application/json
[
  • "Nouméa",
  • "Dumbéa",
  • "Mont-Dore",
  • "Païta"
]