Package rst.svc

Class IplWsvPsaRstApiSvc

java.lang.Object

de.pisa.psa.rst.svc.PsaRstApiSvcBas

rst.svc.IplWsvPsaRstApiSvc

@Path("api")
@PsaRstApiSvcIpl
public class IplWsvPsaRstApiSvc
extends PsaRstApiSvcBas

PSA_RST_API_SVC

Field Summary

Fields inherited from class de.pisa.psa.rst.svc.PsaRstApiSvcBas

COOKIE_JRAUTH, IAM_Key, IAM_Service, IAM_User_Info, Request, User

Constructor Summary

Constructors

Constructor	Description
IplWsvPsaRstApiSvc()

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	getCompanies(String gid, String user, String language)	Get a company record
javax.ws.rs.core.Response	getDocuments(String gid, String user, String language)	get a document
javax.ws.rs.core.Response	getDocumentsBlob(String gid, String user)	get the BLOB of a document as binary data
javax.ws.rs.core.Response	getMyContact(String language)	get the contact data of the current contact (identified by IAM)
javax.ws.rs.core.Response	getPersons(String gid, String user, String language)	Get a person record
javax.ws.rs.core.Response	getPhonenumbers(String number)	Search contacts by the phone number
javax.ws.rs.core.Response	getVersion()	get the server version
javax.ws.rs.core.Response	postCompanies(String json, String user, String language)	Create a new company
javax.ws.rs.core.Response	postDocuments(String json, String user, String language)	create a new document
javax.ws.rs.core.Response	postEurekaCompanies(String json, String user, String language)	EUREKA search for companies
javax.ws.rs.core.Response	postMessages(String json, String user, String language)	create an internal message
javax.ws.rs.core.Response	postSearchCompanies(String json, String user, String language)	Search multiple companies
javax.ws.rs.core.Response	postSearchDocuments(String json, String user, String language)	search documents
javax.ws.rs.core.Response	putAddresses(String json, String gid, String user, String language)	update an address
javax.ws.rs.core.Response	putCompanies(String json, String gid, String user, String language)	update a company

Methods inherited from class de.pisa.psa.rst.svc.PsaRstApiSvcBas

createEvent, getAuthorizationHeader, getData, getIAMUserInfo, getIAMUserInfo, getLanguageFromRequest, getRequestCookie, getRequestHeader, getRequestHeaders, getRequestLanguages, getRequestMethod, getRequestPath, getRequestQuery, handleRequest, initialize, isSynchronous, loadConfiguration, newSsn, processEvent, setConfig, setEvent, validateIAM, validateKey

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

IplWsvPsaRstApiSvc

public IplWsvPsaRstApiSvc()

Method Details

getCompanies

@GET
@Path("companies/{id}")
@Produces("application/json")
public javax.ws.rs.core.Response getCompanies(@PathParam("id")
 String gid,
 @QueryParam("user")
 String user,
 @QueryParam("language")
 String language)
                                       throws Exception

Get a company record

Parameters:

gid - PSC_GID of the company

user - the user name to run the request with

language - the data language (e.g. GER / ENG)

Returns:

response with the company data

Throws:

Exception

getPersons

@GET
@Path("persons/{id}")
@Produces("application/json")
public javax.ws.rs.core.Response getPersons(@PathParam("id")
 String gid,
 @QueryParam("user")
 String user,
 @QueryParam("language")
 String language)
                                     throws Exception

Get a person record

Parameters:

gid - PSC_GID of the person

user - the user name to run the request with

language - the data language (e.g. GER / ENG)

Returns:

response with the person data

Throws:

Exception

postSearchCompanies

@POST
@Path("search-companies")
@Consumes("application/json")
@Produces("application/json")
public javax.ws.rs.core.Response postSearchCompanies(String json,
 @QueryParam("user")
 String user,
 @QueryParam("language")
 String language)
                                              throws Exception

Search multiple companies

Parameters:

json - query in JSON format

user - the user name to run the request with

language - the data language (e.g. GER / ENG)

Returns:

response with the companies

Throws:

Exception

postEurekaCompanies

@POST
@Path("eureka-companies")
@Consumes("application/json")
@Produces("application/json")
public javax.ws.rs.core.Response postEurekaCompanies(String json,
 @QueryParam("user")
 String user,
 @QueryParam("language")
 String language)
                                              throws Exception

EUREKA search for companies

Parameters:

json - query in JSON format

user - the user name to run the request with

language - the data language (e.g. GER / ENG)

Returns:

response with the companies

Throws:

Exception

postCompanies

@POST
@Path("companies")
@Consumes("application/json")
@Produces("application/json")
public javax.ws.rs.core.Response postCompanies(String json,
 @QueryParam("user")
 String user,
 @QueryParam("language")
 String language)
                                        throws Exception

Create a new company

Parameters:

json - company data

user - the user name to run the request with

language - the data language (e.g. GER / ENG)

Returns:

the created company

Throws:

Exception

putCompanies

@PUT
@Path("companies/{id}")
@Consumes("application/json")
@Produces("application/json")
public javax.ws.rs.core.Response putCompanies(String json,
 @PathParam("id")
 String gid,
 @QueryParam("user")
 String user,
 @QueryParam("language")
 String language)
                                       throws Exception

update a company

Parameters:

json - company data

gid - PSC_GID of the company

user - the user name to run the request with

language - the data language (e.g. GER / ENG)

Returns:

the created company

Throws:

Exception

putAddresses

@PUT
@Path("addresses/{id}")
@Consumes("application/json")
@Produces("application/json")
public javax.ws.rs.core.Response putAddresses(String json,
 @PathParam("id")
 String gid,
 @QueryParam("user")
 String user,
 @QueryParam("language")
 String language)
                                       throws Exception

update an address

Parameters:

json - address data

gid - PSC_GID of the address

user - the user name to run the request with

language - the data language (e.g. GER / ENG)

Returns:

updated address

Throws:

Exception

getMyContact

@GET
@Path("my/contact")
@Produces("application/json")
public javax.ws.rs.core.Response getMyContact(@QueryParam("language")
 String language)
                                       throws Exception

get the contact data of the current contact (identified by IAM)

Parameters:

language - the data language (e.g. GER / ENG)

Returns:

contact data

Throws:

Exception

getDocuments

@GET
@Path("documents/{id}")
@Produces("application/json")
public javax.ws.rs.core.Response getDocuments(@PathParam("id")
 String gid,
 @QueryParam("user")
 String user,
 @QueryParam("language")
 String language)
                                       throws Exception

get a document

Parameters:

gid - PSC_GID of the document

user - the user name to run the request with

language - the data language (e.g. GER / ENG)

Returns:

response with the document data

Throws:

Exception

getDocumentsBlob

@GET
@Path("documents/blob/{id}")
@Produces("application/octet-stream")
public javax.ws.rs.core.Response getDocumentsBlob(@PathParam("id")
 String gid,
 @QueryParam("user")
 String user)
                                           throws Exception

get the BLOB of a document as binary data

Parameters:

gid - PSC_GID of the document

user - the user name to run the request with

Returns:

binary data

Throws:

Exception

postSearchDocuments

@POST
@Path("search-documents")
@Consumes("application/json")
@Produces("application/json")
public javax.ws.rs.core.Response postSearchDocuments(String json,
 @QueryParam("user")
 String user,
 @QueryParam("language")
 String language)
                                              throws Exception

search documents

Parameters:

json - query in JSON format

user - the user name to run the request with

language - the data language (e.g. GER / ENG)

Returns:

response with the documents

Throws:

Exception

postDocuments

@POST
@Path("documents")
@Consumes("application/json")
@Produces("application/json")
public javax.ws.rs.core.Response postDocuments(String json,
 @QueryParam("user")
 String user,
 @QueryParam("language")
 String language)
                                        throws Exception

create a new document

Parameters:

json - document data

user - the user name to run the request with

language - the data language (e.g. GER / ENG)

Returns:

response with the new document data

Throws:

Exception

postMessages

@POST
@Path("messages")
@Consumes("application/json")
@Produces("application/json")
public javax.ws.rs.core.Response postMessages(String json,
 @QueryParam("user")
 String user,
 @QueryParam("language")
 String language)
                                       throws Exception

create an internal message

Parameters:

json - message data

user - the user name to run the request with

language - the data language (e.g. GER / ENG)

Returns:

status code

Throws:

Exception

getVersion

@GET
@Path("version")
@Produces("application/json")
public javax.ws.rs.core.Response getVersion()
                                     throws Exception

get the server version

Returns:

version JSON

Throws:

Exception

getPhonenumbers

@GET
@Path("phonenumbers/{number}")
@Produces("application/json")
public javax.ws.rs.core.Response getPhonenumbers(@PathParam("number")
 String number)
                                          throws Exception

Search contacts by the phone number

Parameters:

number - the number to search

Returns:

list of contacts

Throws:

Exception