2925916 - Error Code definition for externalLearner Upsert

Missing required fields

For example, if status is missing in the request, there will be followin resposne.

{

"error" : {

"code" : "COE_MISSING_REQUIRED_PROPERTIES", "message" : {

"lang" : "en-US", "value" : "Required property status is missing"

}

}

}

Input data exceeds the max length of the field.

For example, if we input "eeeee" as status value in the request, there will be following response:

{

"error" : {

"code" : "COE_PROPERTY_EXCEED_MAX_LENGTH", "message" : {

"lang" : "en-US", "value" : "String length exceed the limit(actual=5, limit=2) of field status!"

}

}

}

User id/user name is invalid

 For example, if we use "external1$" as user id in the request, there will be following response:

{

"error" : {

"code" : "6", "message" : {

"lang" : "en-US", "value" : "The User Id you provided is not valid.  Please use the following character types: [‘a’ to ‘z’, ‘A’ to ‘Z’, ‘0’ to ‘9’, ‘-‘, ‘_’, ‘.’, ’@’] and do not use the following patterns: \n \nWhere “#” represents a number (0-9), “X” represents a letter (A-Z), and “-“,“_“,“.“,“@“represent themselves.  For example, for the pattern X.##.X you cannot enter M.12.n or t.58.Q but you can enter 3.13.P."

}

}

}

The value field in the response is localized. It uses the user's default locale.

Here are the messages that the API might return.

"1" /* CANNOT_VALIDATE */: There was an error when creating your account.  Please try again to register.

"2" /* USER_ID_EXIST */: The User Id you provided is already in use. Please select another User Id.

"3" /* USER_NAME_EXIST */: The User Name you provided is already in use. Please select another User Name.

"4" /* USER_ID_EMPTY */: Please provide a User Id.

"5" /* USER_NAME_EMPTY */: Please provide a User Name.

"6" /* USER_ID_INVALID */:

The User Id you provided is not valid. Please use the following character types: [‘a’ to ‘z’, ‘A’ to ‘Z’, ‘0’ to ‘9’, ‘-‘, ‘_’, ‘.’, ’@’] and do not use the following patterns: \n\

 {0} \n\

 Where “#” represents a number (0-9), “X” represents a letter (A-Z), and “-“,“_“,“.“,“@“represent themselves. For example, for the pattern X.##.X you cannot enter M.12.n or t.58.Q but you can enter 3.13.P.

"7" /* USER_NAME_INVALID */:

The User Name you provided is not valid. Please use the following character types: [‘a’ to ‘z’, ‘A’ to ‘Z’, ‘0’ to ‘9’, ‘-‘, ‘_’, ‘.’, ’@’] and do not use the following patterns: \n\

 {0} \n\

 Where “#” represents a number (0-9), “X” represents a letter (A-Z), and “-“,“_“,“.“,“@“represent themselves. For example, for the pattern X.##.X you cannot enter M.12.n or t.58.Q but you can enter 3.13.P.

 Password does not meet password policy

 For example, if the min lenght of password is 2 and we use "a" as password, there will following response:

{

"error" : {

"code" : "8", "message" : {

"lang" : "en-US", "value" : "Your password does not meet the password requirements.  The requirements are: \n Passwords must be from 2 to 18 characters long.\n Passwords are case sensitive.\n They are not required to be mixed case.\n Passwords do not have any character-type restrictions.\n Passwords may contain any combination of letters and digits.\n"

}

}

}

The value field in the response is localized. It uses the user's default locale.

Here is definition of code in the resposne.

"8" /* PASSWORD_INVALID */: Your password does not meet the password requirements.  The requirements are: \n Passwords must be from 2 to 18 characters long.\n Passwords are case sensitive.\n They are not required to be mixed case.\n Passwords do not have any character-type restrictions.\n Passwords may contain any combination of letters and digits.\n

1

The general error for External User OData API

An error has occurred, please contact the system administrator

2

The user id already exists

The User Id you provided is already in use. Please select another User Id.

3

The user name already exists

The User Name you provided is already in use. Please select another User Name.

4

The user id is empty

Please provide a User Id.

5

The user name is empty

Please provide a User Name.

6

The user id is invalid

The User Id you provided is not valid. Please use the following character types: [‘a’ to ‘z’, ‘A’ to ‘Z’, ‘0’ to ‘9’, ‘-‘, ‘_’, ‘.’, ’@’] and do not use the following patterns: \n\

 {0} \n\

 Where “#” represents a number (0-9), “X” represents a letter (A-Z), and “-“,“_“,“.“,“@“represent themselves. For example, for the pattern X.##.X you cannot enter M.12.n or t.58.Q but you can enter 3.13.P.

7

The user name is invalid.

The User Name you provided is not valid. Please use the following character types: [‘a’ to ‘z’, ‘A’ to ‘Z’, ‘0’ to ‘9’, ‘-‘, ‘_’, ‘.’, ’@’] and do not use the following patterns: \n\

 {0} \n\

 Where “#” represents a number (0-9), “X” represents a letter (A-Z), and “-“,“_“,“.“,“@“represent themselves. For example, for the pattern X.##.X you cannot enter M.12.n or t.58.Q but you can enter 3.13.P.

8

The password is invalid.

Your password does not meet the password requirements.  The requirements are: \n Passwords must be from 2 to 18 characters long.\n Passwords are case sensitive.\n They are not required to be mixed case.\n Passwords do not have any character-type restrictions.\n Passwords may contain any combination of letters and digits.\n

10

External User feature is disabled

An error has occurred, please contact the system administrator

12

Cannot update internal user by External User OData API

An error has occurred, please contact the system administrator

13

User status is invalid

An error has occurred, please contact the system administrator

14

Get password policy

Your password does not meet the password requirements. The requirements are: \n

15

Get username format

Please use the following character types: ['a' to 'z', 'A' to 'Z', '0' to '9', '-', '_', '.', '@'] and do not use the following patterns:

16

Picklist ecEmailType is not configured

An error has occurred, please contact the system administrator

17

Picklist ecPhoneType is not configured

An error has occurred, please contact the system administrator

18

Picklist addressType is not configured

An error has occurred, please contact the system administrator

19

Requested options are not in picklist ecEmailType

An error has occurred, please contact the system administrator

20

Requested options are not in picklist ecPhoneType

An error has occurred, please contact the system administrator

21

Requested options are not in picklist addressType

An error has occurred, please contact the system administrator

22

Password is missing

Your password does not meet the password requirements.  The requirements are: \n Passwords must be from 2 to 18 characters long.\n Passwords are case sensitive.\n They are not required to be mixed case.\n Passwords do not have any character-type restrictions.\n Passwords may contain any combination of letters and digits.\n

23

Product Name is invalid.

An error has occurred, please contact the system administrator

24

Product Name cannot be changed.

An error has occurred, please contact the system administrator

25

Country field is missing in address.

Please select Country in addresses.

26

PersonId cannot be changed.

An error has occurred, please contact the system administrator

27

PersonIdExternal cannot be changed.

An error has occurred, please contact the system administrator

28

PersonGUID cannot be changed.

An error has occurred, please contact the system administrator

29

source channel external code not found

No optionId was found for given external code (ext_code5) in learningSourceChannel picklist

30

multiple options are found for given external code

More than one optionIds were found for given external code (ext_code6) in learningSourceChannel picklist