Skip to content

Latest commit

 

History

History
46 lines (32 loc) · 1.58 KB

DELETE_CompanyAdmin.md

File metadata and controls

46 lines (32 loc) · 1.58 KB

DELETE /CompanyAdmin

Description

  • Requires API Key: No
  • Requires System Administrator: Yes
  • Requires Counterpoint Registration option: No

Sample Request

URI

DELETE https://localhost:81/CompanyAdmin/{CompanyName}/{AdminUser}

Headers

  • Authorization : Basic UUFUZXN0R29sZi5NR1I6cGFzc3dvcmQx
  • Accept : application/json

Parameters

  • CompanyName: The Company Name to retrieve information for.
  • AdminUser: The Admin User ID to delete.

Response Codes

  • 200 OK The request was successful, the result of the call will be in the response body.
  • 401 Unauthorized The request could not be fulfilled. Likely due to a missing or invalid authorization header.
  • 404 Not Found The requested resource could not be found but may be available again in the future. Subsequent requests by the client are permissible.
  • 500 Internal Server Error The request could not be fulfilled due to an unexpected internal error. This could be caused by a bug in the system, an unavailable database, or any other unexpected internal problem processing the request.

Error Codes

The following error codes may be returned from requests to this endpoint:

  • SUCCESS: The request was successful and the list of admins is present under the CompanyAdmins section of the response body.
  • ERROR_RECORD_NOT_FOUND: No admin user was found to delete by the given AdminUser parameter.

Sample Response Body

{
  "ErrorCode": "SUCCESS",
  "Message": "Admin MGR removed successfully"
}

Response Body

Message