RESTAPI Class Reference

Inheritance diagram for RESTAPI:

List of all members.

Public Member Functions
	processRequest ($params=null)
	getParam ($id)
	isLoginRequired ()
	throwError ($message, $code=400)
	doAction ()
	processParams ($params)
	doPOST ()
	doGET ()
	doPUT ()
	doDELETE ()
Public Attributes
	$params = array()

---

Member Function Documentation

RESTAPI::doAction

(

)

Runs the API action

Reimplemented from API.

RESTAPI::doDELETE

(

)

[abstract]

DELETE/DELETE

Reimplemented in EliteProfileAPI, CollaborationAPI, ContributionAPI, CRMContactAPI, CRMOpportunityAPI, CRMTaskAPI, DiversityAPI, FreezeAPI, JournalAPI, LIMSContactAPI, LIMSOpportunityAPI, LIMSTaskAPI, MailingListAPI, MailingListRuleAPI, BoardAPI, BoardsAPI, PersonPostAPI, PostAPI, PostsAPI, ThreadAPI, ThreadsAPI, PDFAPI, AlumniAPI, PeopleAPI, PeopleManagedAPI, PersonAPI, PersonContributionsAPI, PersonProductAPI, PersonProjectsAPI, PersonRelationsAPI, PersonRolesAPI, PersonRoleStringAPI, PersonSubRolesAPI, PersonThemesAPI, PersonUniversitiesAPI, SimilarPeopleAPI, PostingAPI, BibliographyAPI, ProductAPI, ProductCitationAPI, ProductDuplicatesAPI, ProductTagsAPI, ProjectAPI, ProjectContributionsAPI, ProjectMembersAPI, ProjectProductAPI, ThemeAPI, ThemeProjectsAPI, RoleAPI, GlobalSearchAPI, DepartmentAPI, UniversityAPI, and WikiPageAPI.

RESTAPI::doGET

(

)

[abstract]

READ/GET

Reimplemented in ElitePostingAPI, EliteProfileAPI, CollaborationAPI, ContributionAPI, CRMContactAPI, CRMOpportunityAPI, CRMTaskAPI, DiversityAPI, FreezeAPI, JournalAPI, LIMSContactAPI, LIMSOpportunityAPI, LIMSTaskAPI, MailingListAPI, MailingListRuleAPI, BoardAPI, BoardsAPI, PersonPostAPI, PostAPI, PostsAPI, ThreadAPI, ThreadsAPI, PDFAPI, AlumniAPI, PeopleAPI, PeopleManagedAPI, PersonAPI, PersonContributionsAPI, PersonProductAPI, PersonProjectsAPI, PersonRelationsAPI, PersonRolesAPI, PersonRoleStringAPI, PersonSubRolesAPI, PersonThemesAPI, PersonUniversitiesAPI, SimilarPeopleAPI, PostingAPI, BibliographyAPI, ProductAPI, ProductCitationAPI, ProductDuplicatesAPI, ProductTagsAPI, ProjectAPI, ProjectContributionsAPI, ProjectMembersAPI, ProjectProductAPI, ThemeAPI, ThemeProjectsAPI, RoleAPI, GlobalSearchAPI, DepartmentAPI, UniversityAPI, and WikiPageAPI.

RESTAPI::doPOST

(

)

[abstract]

CREATE/POST

Reimplemented in EliteProfileAPI, CollaborationAPI, ContributionAPI, CRMContactAPI, CRMOpportunityAPI, CRMTaskAPI, DiversityAPI, FreezeAPI, JournalAPI, LIMSContactAPI, LIMSOpportunityAPI, LIMSTaskAPI, MailingListAPI, MailingListRuleAPI, BoardAPI, BoardsAPI, PersonPostAPI, PostAPI, PostsAPI, ThreadAPI, ThreadsAPI, PDFAPI, AlumniAPI, PeopleAPI, PeopleManagedAPI, PersonAPI, PersonContributionsAPI, PersonProductAPI, PersonProjectsAPI, PersonRelationsAPI, PersonRolesAPI, PersonRoleStringAPI, PersonSubRolesAPI, PersonThemesAPI, PersonUniversitiesAPI, SimilarPeopleAPI, PostingAPI, BibliographyAPI, ProductAPI, ProductCitationAPI, ProductDuplicatesAPI, ProductTagsAPI, ProjectAPI, ProjectContributionsAPI, ProjectMembersAPI, ProjectProductAPI, ThemeAPI, ThemeProjectsAPI, RoleAPI, GlobalSearchAPI, DepartmentAPI, UniversityAPI, and WikiPageAPI.

RESTAPI::doPUT

(

)

[abstract]

UPDATE/PUT

Reimplemented in EliteProfileAPI, CollaborationAPI, ContributionAPI, CRMContactAPI, CRMOpportunityAPI, CRMTaskAPI, DiversityAPI, FreezeAPI, JournalAPI, LIMSContactAPI, LIMSOpportunityAPI, LIMSTaskAPI, MailingListAPI, MailingListRuleAPI, BoardAPI, BoardsAPI, PersonPostAPI, PostAPI, PostsAPI, ThreadAPI, ThreadsAPI, PDFAPI, AlumniAPI, PeopleAPI, PeopleManagedAPI, PersonAPI, PersonContributionsAPI, PersonProductAPI, PersonProjectsAPI, PersonRelationsAPI, PersonRolesAPI, PersonRoleStringAPI, PersonSubRolesAPI, PersonThemesAPI, PersonUniversitiesAPI, SimilarPeopleAPI, PostingAPI, BibliographyAPI, ProductAPI, ProductCitationAPI, ProductDuplicatesAPI, ProductTagsAPI, ProjectAPI, ProjectContributionsAPI, ProjectMembersAPI, ProjectProductAPI, ThemeAPI, ThemeProjectsAPI, RoleAPI, GlobalSearchAPI, DepartmentAPI, UniversityAPI, and WikiPageAPI.

RESTAPI::getParam

(

$

id

)

Returns the value of the specified parameter if it exists ("" otherwise)

Parameters:

string

$id The id of the parameter

Returns:

string Returns the value of the parameter

RESTAPI::isLoginRequired

(

)

In most cases for the RESTAPI login should not be required. This should instead be implemented for each of the doACTION functions.

Reimplemented from API.

RESTAPI::processParams

(

$

params

)

Does some pre-proccessing to the parameters

Parameters:

array

$params The array of GET parameters

Reimplemented from API.

RESTAPI::throwError	(	$	message,
		$	code = 400
	)

Generates a error message via the HTTP 400 return code, and exits execution

Parameters:

	string	$message The message to display
	int	$code the HTTP error code

---

The documentation for this class was generated from the following file:

• extensions/API/RESTAPI.php