From 400179ed0b60e245a24614bd7a120a8bd4a4ea2c Mon Sep 17 00:00:00 2001 From: "Altomarketing.com" Date: Sat, 27 May 2023 16:10:33 -0300 Subject: [PATCH] Update Tickets.rst more clear about return --- Developer Documentation/API/Tickets.rst | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/Developer Documentation/API/Tickets.rst b/Developer Documentation/API/Tickets.rst index b03c148..916695d 100644 --- a/Developer Documentation/API/Tickets.rst +++ b/Developer Documentation/API/Tickets.rst @@ -167,16 +167,21 @@ Local piping can utilize :code:`api/pipe.php` without the neeed to setup an API **Response** -If successful, the server will send :code:`HTTP/201 Created`. Otherwise, it will send an appropriate HTTP status with the content being the error description. Most likely offenders are +If *successful*, the server will send :code:`HTTP/201 Created`. -#. Required field not included -#. Data type mismatch (text send for numeric field) -#. Incorrectly encoded base64 data -#. Unsupported field sent -#. Incorrectly formatted content (bad JSON or XML) -#. Upon success, the content of the response will be the external ticket id of the newly-created ticket. +Upon success, the content of the response will be the external ticket id of the newly-created ticket. .. code-block:: bash Status: 201 Created 123456 + +Where 123456 is the number of new ticket. + +Otherwise, it will send an appropriate HTTP status with the content being the error description. Most likely offenders are + +#. Required field not included +#. Data type mismatch (text send for numeric field) +#. Incorrectly encoded base64 data +#. Unsupported field sent +#. Incorrectly formatted content (bad JSON or XML)