lamplight-phpclient

Lamplight API php client

This project is maintained by mattparker

Error codes

The Lamplight API will return error codes in the following circumstances. In some cases, the response message will include additional information about the error to help you resolve it.

1001
"Role of person not recognised" The role parameter was invalid. May be returned to person or organisation requests.
1002
"Person of type requested is not publishable" Either the global publishing settings do not allow publishing of this type of person/organisation, or the particular one being requested is not published.
1003
"Only people or organisations may be requested" Internal error.
1004
"Method not recognised: should be one of all, some or one": your uri is incorrect.
1005
"Method all not permitted with work records"
1006
"Work records are not publishable" Either the global publishing settings do not allow publishing of work records, or the particular one being requested is not published.
1007
"An unknown error occurred. It is likely an unpublished record was requested". The most likely situation that this error will be returned is if a non-existent, or non-published record is requested (perhaps by manually changing an ID value).
1008
Workareas can only use method all
1020
"The data in module for work records is not enabled". The datain functionality is not available with your current Lamplight subscription. Please contact us to enable it.
1021
"No valid work record id was passed to attend". The id parameter should be an integer, returned by Lamplight.
1022
"The attendee did not pass a valid identifier". The email address provided is not valid.
1023
"The record may not be added to". Work records in Lamplight need to have the 'allow attendees to be added via the API' checkbox selected.
1024
"The attendee could not be unambiguously identified in the database". This means that they either are not there at at all, or appear more than once. A message will be created within Lamplight for the system administrator, providing details.
1025
"There are no spaces available on the record requested". If set, the maximum number of attendees has been reached and no more people can be added to the record. A message will be created within Lamplight for the system administrator, providing details.
1026
"This attendee is already attending the record requested". They are already listed.
1027
"This type of record (work etc) may not be accessed through the API". You are trying to add someone to a record of a type that has been denied access - your system administrator will need to set this in the datain section of the admin menu.
1040
Referral data provided was not valid
1050
Updating person or organisation data must be POSTed
1051
If you want to update a record you need to provide a valid ID
1052
Do not have permission to update this type of body
1053
This particular profile may not be updated
1054
Do not have permission to add profiles of this type
1055
Data provided to add/update profile was not valid
1056
No valid data found to add/update
1057
There was a problem saving the core name/address fields for the update
1058
There was a problem saving some custom fields: most likely values provided are not valid for the field. Core details (name/address) will have been saved if provided.
1070
API access to relationships is not authorised. They need to be switched on within Lamplight
1071
Incorrect parameter types to create a relationship between profiles
1072
Relationship between profiles could not be created
1073
To create relationship data use a POST request
1080
API adding to groups / waiting lists not authorised
1081
Incorrect parameters passed to add to a group
1082
Group is of the wrong type to add to directly. Only manual groups or waiting lists can be used.
1083
Use a POST request to add a person to a group or waiting list
1084
The profile could not be added to the group / waiting list
1085
The profile could not be found
1086
Multiple profiles were found
9999
Data provided may have been a malicious attack and has not been added. Specifically, POSTed content includes html tags and the request is immediately rejected.

Contents

Introduction and authentication

Requesting and creating profiles

Requesting and attending work records

Creating referral records

Error codes

Hints and tips