Skip to content

API Error Messages

Robert Klohr edited this page Nov 12, 2020 · 3 revisions

Error Response Messages

Name is a required field

(CreateGroup, UpdateGroup)

{"Message": "Name is a required field.","StackTrace": null}

Username is a required field

(CreateUser, UpdateUser)

{"Message": "Username is a required field.","StackTrace": null}

You must assign at least one Keylight Security Role

(CreateUser, UpdateUser)

{"Message": "You must assign at least one Keylight Security Role.","StackTrace": null}

Object reference not set to an instance of an object

The data passed (Id, tablealias, etc.) to the API call was not found in the platform

{"Message":"Object reference not set to an instance of an object.","StackTrace":null}

A valid session is required for API access

No valid authentication cookie was sent in the request

{"Message":"A valid session is required for API access.","StackTrace":null}

Failed to deserialize JSON, please ensure it is formatted correctly

API request included a body and the platform was not able to parse the input

{"Message":"Failed to deserialize JSON, please ensure it is formatted correctly.","StackTrace":null}

Cannot filter records with one or more of the provided field aliases

The filter provided in the API request includes an invalid field

{"Message": "Cannot filter records with one or more of the provided field aliases.","StackTrace": null}

Invalid permissions

The object being updated does not exist OR the account making the API request does not have access to the object

{"Message": "Invalid permissions.","StackTrace": null}

Password Validation Message

The message will read at a minimum:

{"Message": "Password must be at least 5 characters and cannot match your last 1 password","StackTrace": null}

Extended Password Validation Message

Additional password validation message phrases; if the number allowed for a phrase is >=0 then the phrase will not be shown if the value is 0

{"Message": "Password must be at least (>=5) characters and contain: (>=0) lower letter, (>=0) upper letter, (>=0) number, (>=0) symbol and cannot match your last (>=1) passwords","StackTrace": null}

Endpoint not found

The API request endpoint is incorrect

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html
  xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <title>Service</title>
    <style>BODY { color: #000000; background-color: white; font-family: Verdana; margin-left: 0px; margin-top: 0px; } #content { margin-left: 30px; font-size: .70em; padding-bottom: 2em; } A:link { color: #336699; font-weight: bold; text-decoration: underline; } A:visited { color: #6699cc; font-weight: bold; text-decoration: underline; } A:active { color: #336699; font-weight: bold; text-decoration: underline; } .heading1 { background-color: #003366; border-bottom: #336699 6px solid; color: #ffffff; font-family: Tahoma; font-size: 26px; font-weight: normal;margin: 0em 0em 10px -20px; padding-bottom: 8px; padding-left: 30px;padding-top: 16px;} pre { font-size:small; background-color: #e5e5cc; padding: 5px; font-family: Courier New; margin-top: 0px; border: 1px #f0f0e0 solid; white-space: pre-wrap; white-space: -pre-wrap; word-wrap: break-word; } table { border-collapse: collapse; border-spacing: 0px; font-family: Verdana;} table th { border-right: 2px white solid; border-bottom: 2px white solid; font-weight: bold; background-color: #cecf9c;} table td { border-right: 2px white solid; border-bottom: 2px white solid; background-color: #e5e5cc;}</style>
  </head>
  <body>
    <div id="content">
      <p class="heading1">Service</p>
      <p>Endpoint not found.</p>
    </div>
  </body>
</html>

Method not allowed

The account making the API request does not have access to update or delete the object

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html
  xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <title>Service</title>
    <style>BODY { color: #000000; background-color: white; font-family: Verdana; margin-left: 0px; margin-top: 0px; } #content { margin-left: 30px; font-size: .70em; padding-bottom: 2em; } A:link { color: #336699; font-weight: bold; text-decoration: underline; } A:visited { color: #6699cc; font-weight: bold; text-decoration: underline; } A:active { color: #336699; font-weight: bold; text-decoration: underline; } .heading1 { background-color: #003366; border-bottom: #336699 6px solid; color: #ffffff; font-family: Tahoma; font-size: 26px; font-weight: normal;margin: 0em 0em 10px -20px; padding-bottom: 8px; padding-left: 30px;padding-top: 16px;} pre { font-size:small; background-color: #e5e5cc; padding: 5px; font-family: Courier New; margin-top: 0px; border: 1px #f0f0e0 solid; white-space: pre-wrap; white-space: -pre-wrap; word-wrap: break-word; } table { border-collapse: collapse; border-spacing: 0px; font-family: Verdana;} table th { border-right: 2px white solid; border-bottom: 2px white solid; font-weight: bold; background-color: #cecf9c;} table td { border-right: 2px white solid; border-bottom: 2px white solid; background-color: #e5e5cc;}</style>
  </head>
  <body>
    <div id="content">
      <p class="heading1">Service</p>
      <p>Method not allowed.</p>
    </div>
  </body>
</html>

Value cannot be null.\r\nParameter name: key

Either the key or the key value in the query string is incorrect

{"Message": "Value cannot be null.\r\nParameter name: key","StackTrace": null}

Clone this wiki locally