Package rst.svc

Klasse 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

Feldübersicht

Von Klasse geerbte Felder de.pisa.psa.rst.svc.PsaRstApiSvcBas

COOKIE_JRAUTH, IAM_Key, IAM_Service, IAM_User_Info, Request, User

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
IplWsvPsaRstApiSvc()

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
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	postMessages(String json, String user, String language)	create an internal message
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
javax.ws.rs.core.Response	putEurekaCompanies(String json, String user, String language)	EUREKA search for companies
javax.ws.rs.core.Response	putSearchCompanies(String json, String user, String language)	Search multiple companies
javax.ws.rs.core.Response	putSearchDocuments(String json, String user, String language)	search documents

Von Klasse geerbte Methoden 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

Von Klasse geerbte Methoden java.lang.Object

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

Konstruktordetails

IplWsvPsaRstApiSvc

public IplWsvPsaRstApiSvc()

Methodendetails

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

Parameter:

gid - PSC_GID of the company

user - the user name to run the request with

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

Gibt zurück:

response with the company data

Löst aus:

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

Parameter:

gid - PSC_GID of the person

user - the user name to run the request with

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

Gibt zurück:

response with the person data

Löst aus:

Exception

putSearchCompanies

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

Search multiple companies

Parameter:

json - query in JSON format

user - the user name to run the request with

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

Gibt zurück:

response with the companies

Löst aus:

Exception

putEurekaCompanies

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

EUREKA search for companies

Parameter:

json - query in JSON format

user - the user name to run the request with

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

Gibt zurück:

response with the companies

Löst aus:

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

Parameter:

json - company data

user - the user name to run the request with

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

Gibt zurück:

the created company

Löst aus:

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

Parameter:

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)

Gibt zurück:

the created company

Löst aus:

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

Parameter:

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)

Gibt zurück:

updated address

Löst aus:

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)

Parameter:

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

Gibt zurück:

contact data

Löst aus:

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

Parameter:

gid - PSC_GID of the document

user - the user name to run the request with

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

Gibt zurück:

response with the document data

Löst aus:

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

Parameter:

gid - PSC_GID of the document

user - the user name to run the request with

Gibt zurück:

binary data

Löst aus:

Exception

putSearchDocuments

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

search documents

Parameter:

json - query in JSON format

user - the user name to run the request with

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

Gibt zurück:

response with the documents

Löst aus:

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

Parameter:

json - document data

user - the user name to run the request with

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

Gibt zurück:

response with the new document data

Löst aus:

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

Parameter:

json - message data

user - the user name to run the request with

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

Gibt zurück:

status code

Löst aus:

Exception

getVersion

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

get the server version

Gibt zurück:

version JSON

Löst aus:

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

Parameter:

number - the number to search

Gibt zurück:

list of contacts

Löst aus:

Exception