General

API Error messages

OVERVIEW

Error message format

JSON Error message

{

    "error": {

        "summary": "The requested organisation does not exist",

        "ref": 75,

        "link": "http://example.com/context/api/2/error/1885"

    }

}

XML Error message

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<error>

    <summary>The requested organisation does not exist</summary>

    <ref>75</ref>

    <link>http://example.com/context/api/2/error/1885</link>

</error>

 

Common error messages

 

Details

HTTP Code

Ref Code

 Message
If “Enable API” is False

403

51

 API is not enabled
If API callers IP address is not found in the IP list (API registration page)

401

53

 IP address is not registered for this application API
If API is POST or PUT and request body is empty

400

74

 Request parameters are missing
If you do not have permission to any API, then show this error

403

123

 Access denied

 

User API error messages

User List API
Details

HTTP Code

Ref Code

 Message
API token user is an “Internal user” and calling this API

403

N/A

 Access denied
API token is invalid

401

401

 Not authorised
If the user has passed the “offset” parameter value : negative or non number

400

106

 Invalid parameter: offset
If the user has passed the “limit” parameter value : negative or non number

400

107

 Invalid parameter: limit
If the user hasn't passed the “sort” parameter value: First character must be "+" or "-" and field name should be in following list: firstname, lastname, email, status, organisation, invited, lastlogin, created, updated

400

79

 Invalid parameter: sort
If the user hasn't passed the “status” parameter value: Value should be in following list: "active", "archive", "disable", "suspended", "pending", "1", "2", "0", "3"

400

80

 Invalid parameter: status
If the user hasn't passed the “createddate” parameter value: This field value should be "lastweek" or "lastmonth" or "lastyear" or ("Start date" and "End date" range - Invalid date format, start date greater than end date)

400

81

 Invalid parameter: createddate
If the user hasn't passed the “lastlogindate” parameter value: This field value should be "lastweek" or "lastmonth" or "lastyear" or ("Start date" and "End date" range - Invalid date format, start date greater than end date)

400

82

 Invalid parameter: lastlogindate
If the user hasn't passed the “inviteddate” parameter value: This field value should be "lastweek" or "lastmonth" or "lastyear" or "neverloggedin" or ("Start date" and "End date" range - Invalid date format, start date greater than end date)

400

83

 Invalid parameter: inviteddate
If the user hasn't passed “modifieddate” parameter value : This field value should be "lastweek" or "lastmonth" or "lastyear" or ("Start date" and "End date" range - Invalid date format, start date greater than end date)

400

84

 Invalid parameter: modifieddate
XSS script found in URL

400

N/A

 [Dynamic message]

 

Get User API

 

Details

HTTP Code

Ref Code

 Message
Invalid User Id or public user id pass in URL

404

108

 The requested user does not exist

 

Add/Update User API

 

Details

HTTP Code

Ref Code

 Message
If name tag not found

400

N/A

 First name and last name are required
If name tag found and First name

400

N/A

 First name is required
If name tag found and Last name

400

N/A

 Last name is required
Email is empty

400

N/A

 Email address is required
Email address already exists

400

N/A

 Email address already exists
Invalid email address

400

N/A

 Invalid email address
Domain does not exist in any organisation

400

N/A

 Domain does not exist
Invalid domain name found in email address

400

N/A

 Invalid domain name
Organisation domain already exists in other organisation

400

N/A

 Organisation domain already exists
Organisation tag not found

400 

N/A

 Organisation is required
Organisation GUID or name is empty

400

N/A

 Organisationguid is required
Organisationg name or GUID not found in Database

400

N/A

 Organisationguid does not exist
Organisation domain mismatch

400

N/A

 Organisation domain mismatch
Invalid status value (Valid value: “active", "archive", "disable", "suspended", "1", "2", "0", "3")

400

N/A

 Invalid status
If the user has passed the "department" field value and this value is not found in department metadata

400

N/A

 Invalid department
Invalid phone number (Same as Collaborate)

400

N/A

 Invalid phone number
Invalid Office phone country code (Only 0 to 9 character)

400

N/A

 Invalid office phone country code
Invalid Office phone area code (Only 0 to 9 character)

400

N/A

 Invalid office phone area code
Invalid Office phone number (Only 0 to 9 character)

400

N/A

 Invalid office phone number
Invalid Mobile phone country code (Only 0 to 9 character)

400

N/A

 Invalid mobile phone country code
Invalid Mobile phone number (Only 0 to 9 character)

400

N/A

 Invalid mobile phone number
If User address tag found and “Addressid” tag not found or 0 and city field is empty

400

N/A

 City is required
If User address tag found and “Addressid” tag not found or 0 and Country field is empty

400

N/A

 Country is required
If User address tag found and “Addressid” tag not found or 0 and Country field value not found in database

400

 N/A Invalid country
API call for update user and user id pass is 0 then

400

N/A

 User Id is required
API call for update user and user id not found in system

400

N/A

 The requested user does not exist
Custom Links tag found in request body and custom links value found and name not found or empty

400

N/A

 Custom link name is required
Custom Links tag found in request body and custom links name found and value not found or empty

400

N/A

 Custom link value is required
Custom Links tag found in request body and value start with “mailto:” and email address is invalid

400

N/A

 Invalid email address
Custom Links tag found in request body and value start with “http or https” and link not invalid

400

N/A

 Invalid Custom link URL
Messaging Links tag found in request body and messaging links value found and name not found or empty

400

N/A

 Messaging link name is required
Messaging Links tag found in request body and messaging links name found and value not found or empty

400

N/A

 Messaging link value is required
Messaging Links tag found in request body and messaging links name not found in database

400

N/A

 Invalid messaging link name
Social Links tag found in request body and social links value found and name not found or empty

400

N/A

 Social link name is required
Social Links tag found in request body and social links name invalid

400

N/A

 Social link value is required
Social Links tag found in request body and social links name found and value not found or empty

400

N/A

 Invalid social link name
Secretary name tag found in request body and secretary email tag not found

400

N/A

 Secretary email is required
Secretary email tag found in request body and this email not found in system and secretary name tag not found

400

N/A

 Secretary name is required
Secretary email tag found in request body and this email not a valid email address

400

N/A

 Invalid secretary email
Orgaddressid tag found in request body and this id address is not found in system

400

N/A

 Invalid organisation address Id

External Id tag found in request body and this field value not found in database

400

N/A

 External Id already exists
Call for Update user and Invalid User Id or public user Id pass in URL

404

108

 The requested user does not exist

 

Activate User API

 

Details

HTTP Code

Ref Code

 Message
If the user is already activated

400

47

 User is already activated
Invalid User Id or public user id pass in URL

404

108

 The requested user does not exist

 

Archive User API

 

Details

HTTP Code

Ref Code

 Message
User is already archived

400

48

 User is already archived
Invalid User Id or public user id pass in URL

404

108

 The requested user does not exist

 

Disable User API

 

Details

HTTP Code

Ref Code

 Message
User is already disabled

400

49

 User is already disabled
Invalid User Id or public user Id pass in URL

404

108

 The requested user does not exist

 

Add User profile image API

 

Details

HTTP Code

Ref Code

 Message
Invalid User Id or public user Id pass in URL

404

108

 The requested user does not exist
Uploaded image with width less than 330 and height less than 330

400

N/A

 The image is too small, please ensure it is at least 330px wide by 330px tall
If virus found in file

400

N/A

 The uploaded image may be potentially harmful to the system, and could not be processed. Please try again
Invalid file extension

400

N/A

 You are trying to add a document with an invalid extension [<file extension value>] If you need to add this to the list of supported extensions, please email [<MAIL_TO_DOC property value>] with the details.
Invalid or corrupt file upload

400

N/A

 The file provided is invalid

 

Get User Email preferences API

 

Details

HTTP Code

Ref Code

 Message
Invalid User Id or public user Id pass in URL

404

108

 The requested user does not exist

 

Update User Email preferences API

 

Details

HTTP Code

Ref Code

 Message
Invalid User Id or public user Id pass in URL

404

108

 The requested user does not exist
Invalid metadata found in request body

400

N/A

 Invalid metadata: <Metadata name>
Invalid email frequency found in request body

400

N/A

 Invalid email frequency: < frequency name>
Invalid modules name found in request body

400

N/A

 Invalid modules: <module name>
Invalid alerter services name found in request body

400

N/A

 Invalid alerter services: <alerter services name>
Module preferences not found in request body

400

N/A

 Module preference required at indices : <index>
Invalid module preferences found in request body (only on/off/custom)

400

N/A

 Invalid module preferences : <module preferences name>
Invalid alerter services name found in request body

400

N/A

 Invalid alerter service preferences : <alerter service name>
Alerter services preferences not found in request body

400

N/A

 Alerter service preference required at indices : <index>

 

Get User System preferences API

 

Details

HTTP Code

Ref Code

 Message
Invalid User Id or public user Id pass in URL

404

108

 The requested user does not exist

 

Update User System preferences API

 

Details

HTTP Code

Ref Code

 Message
Invalid User Id or public user Id pass in URL

404

108

 The requested user does not exist
Invalid Language code found in request body

400

N/A

 Invalid Language code
Invalid metadata found in request body

400

N/A

 Invalid metadata: <Metadata name>

 

 

User Group API error messages

Get User Group list API

 

Details

HTTP Code

Ref Code

 Message
If the user hasn't passed the “sort” parameter value : First character must be "+" or "-" and field name should be in following list: name, created, updated

400

79

 Invalid parameter: sort
If the user hasn't passed the “createddate” parameter value : This field value should be "lastweek" or "lastmonth" or "lastyear" or ("Start date" and "End date" range - Invalid date format, start date greater than end date)

400

81

 Invalid parameter: createddate
If the user hasn't passed the “modifieddate” parameter value : This field value should be "lastweek" or "lastmonth" or "lastyear" or or ("Start date" and "End date" range - Invalid date format, start date greater than end date)

400

84

 Invalid parameter: modifieddate
If the user has passed the “offset” parameter value : negative or non number

400

106

 Invalid parameter: offset
If the user has passed the “limit” parameter value : negative or non number

400

107

 Invalid parameter: limit
User Group not found in system

404

112

 The requested user group does not exist

 

Get User Group API

 

Details

HTTP Code

Ref Code

 Message
User Group not found in system

404

112

 The requested user group does not exist

 

Remove User Group API

 

Details

HTTP Code

Ref Code

 Message
User Group not found in system

404

112

 The requested user group does not exist

 

Add/Update User Group API

 

Details

HTTP Code

Ref Code

 Message
User Group not found in system

404

112

 The requested user group does not exist
Invalid user Id pass in user list

400

N/A

 Invalid user Ids at indices: <user id>
User group is empty

400

N/A

 User group name is required

 

 

Organisation API error messages

Get Organisation List API
Details

HTTP Code

Ref Code

 Message
If the user hasn't passed the “sort” parameter value : First character must be "+" or "-" and field name should be in following list: id, name, status, URL

400

79

 Invalid parameter: sort
If the user hasn't passed the “status” parameter value: Value should be in following list: "active", "archive", "disable", "pending", "1", "2", "0"

400

80

 Invalid parameter: status
If the user hasn't passed the “createddate” parameter value : This field value should be "lastweek" or "lastmonth" or "lastyear" or ("Start date" and "End date" range - Invalid date format, start date greater than end date)

400

81

 Invalid parameter: createddate
If the user hasn't passed the “modifieddate” parameter value : This field value should be "lastweek" or "lastmonth" or "lastyear" or or ("Start date" and "End date" range - Invalid date format, start date greater than end date)

400

84

 Invalid parameter: modifieddate
If the user has passed the “offset” parameter value : negative or non number

400

106

 Invalid parameter: offset
If the user has passed the “limit” parameter value : negative or non number

400

107

 Invalid parameter: limit

 

Get Organisation API

 

Details

HTTP Code

Ref Code

 Message
Organisation not found in system

404

75

 The requested organisation does not exist
Organisation category tag found in request body and this value not found in organisation category metadata

400

N/A

 Invalid parameter: category
Organisation industry tag found in request body and this value not found in organisation industry metadata

400

N/A

 Invalid parameter: industry
Organisation homepage tag found in request body and this value not found in Organization channel permission list

400

N/A

 Invalid parameter: homepage

 

Add/Update Organisation API

 

Details

HTTP Code

Ref Code

 Message
Invalid organisation type field value (internal or external)

400

N/A

 Invalid parameter: type
Organisation is empty

400

N/A

 Organisation name is required
Organisation GUID already exists in other organisation

400

N/A

 Organisationguid already exists
Organisation name already exists in other organisation

400

N/A

 Organisation name already exists
Organisation domain name already exists in other organisation

400

N/A

 Organisation domain already exists
Invalid domain name found in domain list

400

N/A

 Invalid domain name
Invalid status value (Valid value: “active", "archive", "disable", "1", "2", "0")

400

N/A

 Invalid status
If the User address tag found and “Addressid” tag not found or 0 and city field is empty

400

N/A

 City is required at address indices: <index start with one>
If the User address tag found and “Addressid” tag not found or 0 and Country field is empty

400

N/A

 Country is required at address indices: <index start with one>
If the User address tag found and “Addressid” tag not found or 0 and Country field value not found in database

400

N/A

 Invalid country at address indices: <index start with one>
If default address flag found in address tag

400

N/A

 There can only be one default address
Invalid key contacts found

400

N/A

 Invalid key contacts at key contact indices: <Key Contacts CSV>
Duplicate address Id found in request body

400

N/A

 Duplicate address Id at address indices: < address Id>
Organisation not found in system

404

75

 The requested organisation does not exist

 

Update Organisation Email preferences API

 

Details

HTTP Code

Ref Code

 Message
Invalid metadata found in request body

400

N/A

 Invalid metadata: <Metadata name>
Invalid email frequency found in request body

400

N/A

 Invalid email frequency: < frequency name>
Invalid modules name found in request body

400

N/A

 Invalid modules: <module name>
Invalid alerter services name found in request body

400

N/A

 Invalid alerter services: <alerter services name>
Email frequency not found in request

400

N/A

 Email frequency is required
Module preferences not found in request body

400

N/A

 Module preference is required at indices : <index>
Invalid module preferences found in request body (only on/off)

400

N/A

 Invalid module preferences : <module preferences name>
Invalid alerter services name found in request body

400

N/A

 Invalid alerter service preferences : <alerter service name>
Alerter services preferences not found in request body

400

N/A

 Alerter service preference is required at indices : <index>
Organisation not found in system

404

75

 The requested organisation does not exist

 

Activate Organisation API

 

Details

HTTP Code

Ref Code

 Message
Organisation not found in system

404

75

 The requested organisation does not exist
Organisation is already activated

400

76

 Organisation is already activated

 

Archive Organisation API

 

Details

HTTP Code

Ref Code

 Message
Organisation not found in system

404

 75 The requested organisation does not exist
Organisation is already archived

400

 77 Organisation is already archived

 

Disable Organisation API

 

Details

HTTP Code

Ref Code

 Message
Organisation not found in system

404

 75 The requested organisation does not exist
Organisation is already disabled

400

 78 Organisation is already disabled

 

Add Organisation domain API

 

Details

HTTP Code

Ref Code

 Message
Organisation not found in system

404

75

 The requested organisation does not exist
Organisation domain not found in request body

400

N/A

 Organisation domain is required
Invalid domain name

400

N/A

 Invalid domain name

 

 

Organisation Group API error messages

Get Organisation Group list API

 

Details

HTTP Code

Ref Code

 Message
If the user hasn't passed the “sort” parameter value : First character must be "+" or "-" and field name should be in following list: name, created, updated

400

79

 Invalid parameter: sort
If the user hasn't passed the “createddate” parameter value : This field value should be "lastweek" or "lastmonth" or "lastyear" or ("Start date" and "End date" range - Invalid date format, start date greater than end date)

400

81

 Invalid parameter: createddate
If the user hasn't passed the “modifieddate” parameter value : This field value should be "lastweek" or "lastmonth" or "lastyear" or or ("Start date" and "End date" range - Invalid date format, start date greater than end date)

400

84

 Invalid parameter: modifieddate
If the user has passed the “offset” parameter value : negative or non number

400

106

 Invalid parameter: offset
If the user has passed the “limit” parameter value : negative or non number

400

107

 Invalid parameter: limit
Organisation Group not found in system

404

113

 The requested organisation group does not exist

 

Get Organisation Group API

 

Details

HTTP Code

Ref Code

 Message
Organisation Group not found in system

404

113

 The requested organisation group does not exist

 

Remove Organisation Group API

 

Details

HTTP Code

Ref Code

 Message
Organisation Group not found in system

404

113

 The requested organisation group does not exist

 

Add/Update Organisation Group API

 

Details

HTTP Code

Ref Code

 Message
Organisation Group not found in system

404

113

 The requested organisation group does not exist
Organisation Group name not found or empty in request body

400

N/A

 Organisation group name is required
Invalid Organisation Ids found or Id not found in database

400

N/A

 Invalid organisations Ids at indices: < organisations Id index>
Archive organisation Ids found in request body

400

N/A

 Invalid organisations Ids: < organisation Id>
Organisation Ids not found in database

400

N/A

 Organisations Ids does not exist: < organisation Id>
You have not passed a current domain in the domain list, Example - Current “HighQ” domain list is “highq.com, highq1.com” and you have passed only “highq.com” then show this error.

400

N/A

 Please provide all domains which are already linked with this organisation

 

 

Comments


1 Comments


What about this? This error occurs after the use of the add file API:


https://instance.highq.com/instance/api/6/error/16371918

31

Due to some system error we are not able to upload this





File Upload in the browser via weblogin does not work either. Here the message

Due to some system error we are not able to upload this

pops up.

Last Updated: Nov 08,2024