Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Content imported from a Scroll Translations translation file.
Sv translation
languageen

http Status Code

The http status code indicates the result of the operation.

200 OK

When 200 OK is returned, data in JSON format will be returned with some responses. This is documented with the relevant function.

400 Bad Request

This usually indicates that a required parameter is missing. The server will provide more information in the response body (see below).

401 Unauthorized

This response indicates a problem with the supplied Bearer token, or an incorrect ClientsID, or a combination of both.

404 Not Found

This can indicate that the REST endpoint for the function being accessed does not exist, if the response body is empty.

If the REST endpoint does exist, the server will provide a JSON structure in the response body indicating the reason for the failure.

409 Conflict

This usually indicates that an operation cannot complete, because an object which is being created (or cloned) already exists, or another precondition is not satisfied. 

500 Internal Server Error

This indicates an internal server error has occurred. Please supply details of the rest call made, and the response received to the relevant support team.

Response Body

If the server can, it will provide a JSON structure in the response body indicating the reason for the failure. 

Fields

FieldTypeMeaning
statusIntegerThe http status code.
errorString A string indicating the reason for the error.

Example

For example:

Translations Ignore


Code Block
{
    "status": 404,
    "error": "Dialler campaign not found"
}





Sv translation
languagede

Status
colourRed
titleThis page is only available in English

Sv translation
languagefr

codes de statut http

Le code de statut http indique le résultat de l'opération.

200 OK

Lorsque 200 OK est renvoyé, les données au format JSON seront renvoyées avec quelques réponses. Ceci est documenté avec la fonction correspondante.

400 Bad Request

Cela indique généralement qu'un paramètre requis est manquant. Le serveur fournira plus d'informations dans le corps de réponse (voir ci-dessous).

401 Unauthorized

Cette réponse indique un problème avec le jeton au porteur fourni, ou un numéro d'identification du client incorrect, ou une combinaison des deux.

404 - Not found

Cela peut indiquer que le point final REST pour la fonction à laquelle on accède n'existe pas, si le corps de la réponse est vide.

Si le point de terminaison REST existe, le serveur fournira une structure JSON dans le corps de réponse indiquant la raison de la défaillance.

409 Conflict

Cela indique généralement qu'une opération ne peut pas se terminer, parce qu'un objet en cours de création (ou de clonage) existe déjà, ou qu'une autre condition préalable n'est pas remplie. 

500 Internal Server Error

Cela indique qu'une erreur interne du serveur s'est produite. Veuillez fournir les détails de l'appel de repos effectué et de la réponse reçue à l'équipe de soutien concernée.

Corps Réponse

Si le serveur le peut, il fournira une structure JSON dans le corps de réponse indiquant la raison de la défaillance. 

Champs

ChampTypeSignification
statutEntierCodes de statut http
erreurChaîne de caractères Une chaîne de caractères indiquant la raison de l'erreur.

Exemple

Par exemple:

Translations Ignore


Code Block
{ "status": 404, "error": "Dialler campaign not found" }