API docs by Redocly

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

Download OpenAPI specification:Download

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

Get Agences

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. Si le champ 'updatedDate' est égal à '1973-01-01T00:00:00.00', cela signifie que l'agence ne possède pas de données de temps d'attente

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 d'une agence par son identifiant

Récupère une agence et ses informations à partir de son identifiant. Si le champ 'updatedDate' est égal à '1973-01-01T00:00:00.00, cela signifie que l'agence ne possède pas de données de temps d'attente

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",
  • "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"
}

Miscellaneous

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"
]