Skip to main content
Aria Knowledge Central

authenticate_caller_m Sample Call and Response

This example shows a call to authenticate_caller_m, based on the plsql_m_r73.yml Core API definition file for release 73. The example verifies that a given client number and authentication key combination is valid.

This example covers the complete argument list for this method, since authenticate_caller_m accepts only the standard client_no and auth_key credentials and no other fields.

Sample call

{
  "rest_call": "authenticate_caller_m",
  "output_format": "json",
  "client_no": 34281,
  "auth_key": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6"
}

client_no and auth_key are the standard Aria-assigned client credentials required on every Core API call. The rest_call and output_format fields are added by the REST layer and are not part of the method's own argument list.

Sample response

{
  "error_code": 0,
  "error_msg": "OK"
}

error_code of 0 combined with an error_msg of "OK" indicates that the client number and auth key combination is valid. authenticate_caller_m returns no other fields on success. This example leaves out the error_details structure entirely, because that field is marked nonpublic in the underlying definition and is not part of the public response.

TOP
  • Was this article helpful?