AOTG API: Delete Debtor: Difference between revisions

No edit summary
 
(6 intermediate revisions by the same user not shown)
Line 3:
*'''debtorId''' is a unique identifier created in AOTG.
*See [[AOTG API: Get List of Debtor#Response_From_Result|Get List of Debtor]] on how to obtain '''Id''' (that is created in AOTG).
{{AOTGApiMethodsSpec|DELETE|/api/public/v1/Debtor/{debtorId} |Params=None}}
 
==API Request Flow==
[[File:AOTGApiCompleteOrFailFlow.png|link=]]
#Submit Delete request of a debtor with an Id of the debtor
#Check the successful request status, if the action is completed'''Completed''' or failed'''Failed'''.
#To get the failed reason, use RESULT method to retrieve the message of completed or failed.
 
Line 165:
}}
 
====Response Status====
"RequestId": {{AOTGResponseStatus|"f0268032-c161-4548-a74a-adb7143274a6",}}
200 OK
=====Completed status=====
*'''Completed''' status Indicates that the DELETE request has been performed and succeeded.
<syntaxhighlight lang="json-object">
{
"RequestId": "f0268032-c161-4548-a74a-adb7143274a6",
"Status": "Completed"
}
</syntaxhighlight>
=====Failed status=====
*'''Failed''' status Indicates that the DELETE request has been performed but has error.
<syntaxhighlight lang="json-object">
{
"RequestId": "f0268032-c161-4548-a74a-adb7143274a6",
"Status": "Failed"
}
</syntaxhighlight>
 
==Use RESULT method to get the failed reason of DELETE request==
Line 251 ⟶ 235:
}}
 
<br/>
====Response Successful from HTTP RESULT====
200 OK
Line 290 ⟶ 275:
</tabber>
 
=====Account in use, can't delete debtor=====
<tabber>
Body=