Navigation:  Integration via SOAP web services > Published web services > Request >

newKeyWordRequest

Previous  Top  Next

This method enables to insert and edit:

Data of a request;

 

To insert each of these items, it is necessary to follow the standard documented below.

 

Java class

Request

web\wwwroot\ws\java\servicer\NewKeyWordRequestRequestType.java

Return

web\wwwroot\ws\java\servicer\NewKeyWordRequestResponseType.java

 

Request

ID #

Required

Description

IDREQUEST

X

Request ID #

NMREQUEST

X

Request name

IDREQUESTTYPE

X

Request type ID #. The object type of the request type should be Document, and the Operation should be blank or with the Keyword option selected.

IDUSEREMIT

X

ID # of the user who issued the request

DSREQUEST

X

Request description

DSREASON

X

Request explanation. If the request type requires an explanation to be entered, the DSREASON parameter becomes required.

DTREQUESTENDDATE

X

Request closure date. The date format must be Y-M-D (Year-Month-Day).

ATTRIBUTES

X

Request attributes.

Example: ID#_OF_ATTRIBUTE1=VALUE_OF_ATTRIBUTE1;ID#_OF_ATTRIBUTE2=VALUE_OF_ATTRIBUTE2;ID#_OF_ATTRIBUTE3=VALUE_OF_ATTRIBUTE3.

 

Example with a multivalued attribute. Note that the separator for the values of the multivalued attributes is a "," (comma): ID#_OF_ATTRIBUTE1=VALUE1_OF_ATTRIBUTE1,VALUE2_OF_ATTRIBUTE1,VALUE3_OF_ATTRIBUTE1.

 

Note: For attributes with a numeric value, the decimal place separator must be "." (dot). For date fields, the value must have the “Y-M-D”(Year-Month-Day) format.

IDAPPROVALROUTE

X

Approval route ID #. Required for requests that have approval.

 

Return

ID #

Description

return

SUCCESS: Returns a ("Operation successfully performed") message

FAILURE: Returns a message with the error that occurred.