PC SOFT

DOCUMENTATION EN LIGNE
DE WINDEVWEBDEV ET WINDEV MOBILE

  • Détail des codes utilisables
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaEtats et RequêtesCode Utilisateur (MCU)
WEBDEV
WindowsLinuxPHPWEBDEV - Code Navigateur
WINDEV Mobile
AndroidWidget AndroidiPhone/iPadWidget iOSApple WatchCatalystUniversal Windows 10 AppWindows Mobile
Autres
Procédures stockées
WebserviceEcritCodeHTTP (Fonction)
En anglais : WebserviceWriteHTTPCode
AjaxNon disponible
Renseigne le code HTTP qui sera retourné à la fin de l'exécution de la fonction du Webservice REST. Cette fonction permet de spécifier certaines catégories de codes de retour :
  • Codes 2xx pour gérer le Succès d'exécution d'une fonction.
  • Codes 3xx pour gérer la Redirection d'une fonction.
  • Codes 4xx pour gérer une Erreur du client.
  • Codes 5xx pour gérer une Erreur du serveur.
Exemple
// Indique la création du client : 201 Created
WebserviceEcritCodeHTTP(201, "https://serveur/Client/" + Client.id)
// Et retourne le détail du client
RENVOYER sClient

// Indique l'absence de réponse : 204 No Content
WebserviceEcritCodeHTTP(204)
// Et ne retourne pas de réponse
RENVOYER ""

// Accepte un contenu JSON ou XML
SELON WebserviceLitTypeMIME()
CAS "application/json"
// Traite le cas JSON
...
CAS "application/xml"
// Traite le cas XML
...
AUTRES CAS
// Traite les autres cas (lance une erreur)
// Indique que les données reçus sont dans un format non reconnu :
// 415 Unsupported Media Type
WebserviceEcritCodeHTTP(415, sErreur)
RETOUR
FIN
Syntaxe
WebserviceEcritCodeHTTP(<Code HTTP> [, <Information supplémentaire>])
<Code HTTP> : Entier
Code HTTP retourné par l'appel au Webservice. Les codes actuellement acceptés sont :
  • Codes 2xx (Succès)
  • Codes 3xx (Redirection)
  • Codes 4xx (Erreur du client)
  • Codes 5xx (erreur du serveur)
Pour plus de détails, consultez Détail des codes utilisables.
<Information supplémentaire> : Chaîne de caractères optionnelle
Informations supplémentaires nécessaires pour certains codes de retour. Les codes de retour concernés sont les suivants :
  • Code 201 (Created) : information optionnelle : Adresse des informations ajoutées.
  • Code 301 (Moved Permanently) : information obligatoire : Adresse de redirection.
  • Code 302 (Moved Temporarily) : information obligatoire : Adresse de redirection.
  • Codes 4xx et 5xx : information obligatoire : Texte de l'erreur retournée au client. Le texte sera converti en UTF-8.
Remarques
  • Cette fonction est utile dans le cas où l'appel du Webservice REST doit retourner un code autre que 200.
  • Le serveur d'application WEBDEV génère automatiquement un code 4xx ou 5xx pour les erreurs qu'il détecte.
  • Cette fonction est disponible uniquement pendant l'appel de la fonction traitant une requête d'un Webservice REST. Dans tous les autres cas, la fonction provoque une erreur.

Détail des codes utilisables

Les codes HTTP retournés par l'appel au Webservice actuellement acceptés sont :
  • Codes 2xx (Succès)
    • 200 OK
    • 201 Created
    • 204 No Content
  • Codes 3xx (Redirection)
    • 301 Moved Permanently
    • 302 Moved Temporarily
  • Codes 4xx (Erreur du client)
    • 400 Bad Request
    • 401 Unauthorized
    • 403 Forbidden
    • 404 Not Found
    • 405 Method Not Allowed
    • 406 Not Acceptable
    • 415 Unsupported Media Type
  • Codes 5xx (erreur du serveur)
    • 500 Internal Server Error
    • 501 Not Implemented
    • 503 Service Unavailable
Composante : wd260awws.dll
Version minimum requise
  • Version 22
Documentation également disponible pour…
Commentaires
Cliquez sur [Ajouter] pour publier un commentaire