Get All Stock Auditors API

Description

Get a list of all stock auditors in the system

Security

Logged in user has stock auditor API permissions

API Version

Argos API V6

URL

GET http://{{serverLocation}}/api/v{api-version}/stockAuditors

Parameters          

1. stockAuditorCode: [string, optional] search for stock auditor by code        
2. stockAuditorName: [string, optional] search for stock auditor by name        
3. activeOnly: [optional] restrict list to active stock auditors
   

Response

Field	Type	Description
StockAuditor	Array[StockAuditorOverviewDto]	The list of results if successful, null otherwise

StockAuditorOverviewDto

Field	Type	Description
id	Integer	The stock auditor ID
code	String	The stock auditor Code
description	String	The stock auditor description
active	Boolean	True if the stock auditor is active
internalAuditor	Boolean	True if the stock auditor is active

Example

{                                                                                                                                               

"id": 0,

"code": "string",

"description": "string",

"active": true,

"internalAuditor": true

} 

Error Codes

HTTP Status Code	Type
200	OK (Success)
204	No Content (no records match the search)
401	Unauthorised (not Authenticated)
403	Forbidden (invalid Authorisation)
503	Service Unavailable (due to maintenance)

• Related Articles

• 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 ...

• 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 ...

• 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 ...

• Bailment Stock Auditor Details

  Purpose Establish details of each Stock Auditor, and allocates to them the regions they can undertake stock audits for External User ID’s may also be established so stock auditors can login to the Bailment web site to obtain stock audit information ...