org.exoplatform.social.rest.api

Interface IdentityRestResources

All Superinterfaces:

org.exoplatform.services.rest.resource.ResourceContainer, SocialRest

All Known Implementing Classes:

IdentityRestResourcesV1

public interface IdentityRestResources
extends SocialRest

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createIdentities(javax.ws.rs.core.UriInfo uriInfo, String remoteId, String providerId, String expand) Process to create an identity
javax.ws.rs.core.Response	deleteIdentityById(javax.ws.rs.core.UriInfo uriInfo, String id, String expand) Process to delete an identity
javax.ws.rs.core.Response	getIdentities(javax.ws.rs.core.UriInfo uriInfo, String type, int offset, int limit, boolean returnSize, String expand) Process to return a list of identities in json format
javax.ws.rs.core.Response	getIdentityById(javax.ws.rs.core.UriInfo uriInfo, String id, String expand) Process to return an identity in json format
javax.ws.rs.core.Response	getRelationshipsOfIdentity(javax.ws.rs.core.UriInfo uriInfo, String id, String with, boolean returnSize, int offset, int limit, String expand) Process to return all relationships of an identity in json format
javax.ws.rs.core.Response	updateIdentityById(javax.ws.rs.core.UriInfo uriInfo, String id, String expand, ProfileEntity model) Process to update an identity by id

Method Detail

getIdentities

javax.ws.rs.core.Response getIdentities(@Context
                                        javax.ws.rs.core.UriInfo uriInfo,
                                        String type,
                                        int offset,
                                        int limit,
                                        boolean returnSize,
                                        String expand)
                                 throws Exception

Process to return a list of identities in json format

Parameters:

uriInfo -

Returns:

Throws:

Exception

createIdentities

javax.ws.rs.core.Response createIdentities(@Context
                                           javax.ws.rs.core.UriInfo uriInfo,
                                           String remoteId,
                                           String providerId,
                                           String expand)
                                    throws Exception

Process to create an identity

Parameters:

uriInfo -

Returns:

Throws:

Exception

getIdentityById

javax.ws.rs.core.Response getIdentityById(@Context
                                          javax.ws.rs.core.UriInfo uriInfo,
                                          String id,
                                          String expand)
                                   throws Exception

Process to return an identity in json format

Parameters:

uriInfo -

Returns:

Throws:

Exception

updateIdentityById

javax.ws.rs.core.Response updateIdentityById(@Context
                                             javax.ws.rs.core.UriInfo uriInfo,
                                             String id,
                                             String expand,
                                             ProfileEntity model)
                                      throws Exception

Process to update an identity by id

Parameters:

uriInfo -

Returns:

Throws:

Exception

deleteIdentityById

javax.ws.rs.core.Response deleteIdentityById(@Context
                                             javax.ws.rs.core.UriInfo uriInfo,
                                             String id,
                                             String expand)
                                      throws Exception

Process to delete an identity

Parameters:

uriInfo -

Returns:

Throws:

Exception

getRelationshipsOfIdentity

javax.ws.rs.core.Response getRelationshipsOfIdentity(@Context
                                                     javax.ws.rs.core.UriInfo uriInfo,
                                                     String id,
                                                     String with,
                                                     boolean returnSize,
                                                     int offset,
                                                     int limit,
                                                     String expand)
                                              throws Exception

Process to return all relationships of an identity in json format

Parameters:

uriInfo -

Returns:

Throws:

Exception