Entêtes acceptées

Les entêtes suivantes sont acceptées :
Authorization, Content-Type, Content-Disposition, X-Requested-With, x-rmsitesorg-app, X-API-KEY.

CORS

Les entêtes CORS sont systématiquement renvoyées dans chaque réponse.

Format des données de la requête

Pour les requêtes de type POST ou PUT, les données à envoyer peuvent être fournies soit en tant que paramètres de la requête, soit dans son body en JSON, exemple :

POST /v1/organismes?nomUsage=Exemple
ou 
POST /v1/organismes {"nomUsage":"Exemple"}

Format des réponses

Toutes les réponses sont renvoyées au format JSON :

{
  "idOrganisme": 1,
  "nomUsage": "Exemple"
}

Formats de retour génériques

200 - Succès (pour les services sans type de réponse spécifique)

{
  "code": 200,
  "message": "Succès",
  "data": [...]
}

400 - Paramètre invalide (filtre ou paramètre GET/POST/PUT/DELETE invalide)

{
  "code": 400,
  "message": "Le paramètre xxx n'est pas valide"
}

500 - Échec de validation de fomulaire (pour les services de type POST ou PUT)

{
  "code": 500,
  "message": "La validation du formulaire a échoué",
  "formErrors": {
    "nomChamp": [
      "Cette valeur n'est pas valide."
    ]
  }
}

Documentation auto-generated on Wed, 12 Dec 18 08:25:41 +0100