Request External Audit API

Description

Creates a new audit request for a Bailment dealer with External System Audit Id.

Security

Logged in user has API > Audit> Create External Audit permissions

API Version

Argos API V6

URL

POST http://{{serverLocation}}/api/v{api-version}/audits/requestexternalaudit

Parameters        

Model

Field	Type	Description
bailmentDealerCode	String	The bailment dealer code
stockAuditorCode	String	The stock auditor code
externalSystemStockAuditId	String	The external audit system's audit Id

Example

{                                                                                                                                         

"bailmentDealerCode": "string",

"stockAuditorCode": "string",

"externalSystemStockAuditId": "string",

} 

Response

Model

Field	Type	Description
success	Boolean	True, if the audit request was successfully create, false otherwise
errorMessage	String (optional)	Details the error if success is false, null otherwise
auditId	String	The audit Id used to create the audit request

Example

{                                                                                                                                         

 "success": true,

 "errorMessage": "string",

 "auditId": "string"

} 

Error Codes

HTTP Status Code	Type
200	OK (Success)
204	No Content (no records match the search)
400	Bad request Dealer not found or auditor not found (error will be detailed in response)
401	Unauthorised (not Authenticated)
403	Forbidden (invalid Authorisation)
503	Service Unavailable (due to maintenance)

• Related Articles

• Create External Audit API

  Description For the requested External audit, uploads the audit results matching the External System Audit Id. Security Logged in user has API > Audit> Create External Audit permissions API Version Argos API V6 URL POST ...

• Get Stock Audit Report Data API

  Description Get stock audit checklist report data columns required by external audit systems Security Logged in user has stock audit API permissions API Version Argos API V6 URL GET ...

• External Stock Audit API Setup

  Purpose To allow users to send files directly from within Argos Bailment via an API Connection Access Bailment | Setup | External Stock Audit API Setup Dialog Details This dialog must be competed before any API Transfers can take place You may ...

• Argos Vault Release Notes V5.141

  Release Completion Date: 17 May 2022 Please disregard the release notes for the modules you do not use. Unless otherwise indicated, more detail about any change will be included in the relevant dialog [Help] button. Other documents referred to in the ...

• Argos Vault Release Notes V5.144

  Release Completion Date: 17/05/2024 Please disregard the release notes for the modules you do not use. Unless otherwise indicated, more detail about any change will be included in the relevant dialog [Help] button. Other documents referred to in the ...