Template:AOTGResponseStatus: Difference between revisions

Content added Content deleted

Inline

Latest revision as of 04:30, 19 May 2021

4 possible responses from process status.

InQueue status

InQueue status Indicates that the requests to AOTG Server is waiting to be processed.
Usually this happen when many requests are called to AOTG Web API in within a second.
Make sure the request in the loop has pause time,

or use 'batch' method to process multiple records in single request if applicable.

"RequestId": {{{1}}},
"Status": "InQueue"

Processing status

Processing status indicates that the request is not complete.

"RequestId": {{{1}}},
"Status": "Processing"

Completed status

Completed status Indicates that the request has been performed and succeeded.

"RequestId": {{{1}}},
"Status": "Completed"

Failed status

Failed status indicates that the request has been performed but has error.

"RequestId": {{{1}}},
"Status": "Failed"

@@ Line 1: / Line 1: @@
+__NOTOC__
-=====InQueue status=====
+'''4 possible responses from process status.'''
+======InQueue status======
 *'''InQueue''' status Indicates that the requests to AOTG Server is waiting to be processed.
-*Usually this happen when many requests are in a loop.
+*Usually this happen when many requests are called to AOTG Web API in within a second.
-*:Tips: Make sure the request in the loop has a pause time, or use 'batch' method to process multiple records in single request.
+*:Make sure the request in the loop has pause time,
+*:or use 'batch' method to process multiple records in single request if applicable.
-<syntaxhighlight lang="json-object">
-{
-    "RequestId": {{{1}}},
+ <span style="color:#336600;">"RequestId"</span>: <span style="color:#cc0000;">{{{1}}}</span>,
-    "Status": "InQueue"
+ <span style="color:#336600;">"Status"</span>: <span style="color:#cc0000;">"InQueue"</span>
-}
+======Processing status======
-</syntaxhighlight>
-=====Processing status=====
+*'''Processing''' status indicates that the request is not complete.
+ <span style="color:#336600;">"RequestId"</span>: <span style="color:#cc0000;">{{{1}}}</span>,
-*'''Processing''' status indicates that the Create debtor request is not complete.
+ <span style="color:#336600;">"Status"</span>: <span style="color:#cc0000;">"Processing"</span>
-<syntaxhighlight lang="json-object">
-{
+======Completed status======
-    "RequestId": {{{1}}},
+*'''Completed''' status Indicates that the request has been performed and succeeded.
-    "Status": "Processing"
+ <span style="color:#336600;">"RequestId"</span>: <span style="color:#cc0000;">{{{1}}},
-}
+ <span style="color:#336600;">"Status"</span>: <span style="color:#cc0000;">"Completed"</span>
-</syntaxhighlight>
-=====Completed status=====
+======Failed status======
-*'''Completed''' status Indicates that the Create debtor request has been performed and succeeded.
+*'''Failed''' status indicates that the request has been performed but has error.
-<syntaxhighlight lang="json-object">
+ <span style="color:#336600;">"RequestId"</span>: <span style="color:#cc0000;">{{{1}}},
-{
+ <span style="color:#336600;">"Status"</span>: <span style="color:#cc0000;">"Failed"</span>
-    "RequestId": {{{1}}},
-    "Status": "Completed"
-}
-</syntaxhighlight>
-=====Failed status=====
-*'''Failed''' status indicates that the Create debtor request has been performed but has error.
-<syntaxhighlight lang="json-object">
-{
-    "RequestId": {{{1}}},
-    "Status": "Failed"
-}
-</syntaxhighlight>