Skip to main content
Version: 2.2.3

newKeyWordRequest

This method allows adding and editing:

  • Data of a request;

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

Request:

ID #RequiredDescription
IDREQUESTXRequest ID #
NMREQUESTXRequest name
IDREQUESTTYPEXRequest type ID #. The object type of the request type should be Document, and the Operation should be blank or with the Keyword option selected.
IDUSEREMITXID of the user who issued the request
DSREQUESTXRequest description
DSREASONXRequest explanation. If the request type requires an explanation to be entered, the DSREASON parameter becomes required.
DTREQUESTENDDATEXRequest closure date. The date format must be Y-M-D (Year-Month-Day).
ATTRIBUTESXRequest 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#F_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.
IDAPPROVALROUTEXApproval route ID #. Required for requests that have approval.

Request structure:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:srequest">
<soapenv:Header/>
<soapenv:Body>
<urn:newKeyWordRequest>
<!--You may enter the following 9 items in any order-->
<urn:idrequest>?</urn:idrequest>
<urn:nmrequest>?</urn:nmrequest>
<urn:idrequesttype>?</urn:idrequesttype>
<urn:iduseremit>?</urn:iduseremit>
<urn:dsrequest>?</urn:dsrequest>
<urn:dsreason>?</urn:dsreason>
<urn:dtrequestenddate>?</urn:dtrequestenddate>
<urn:attributes>?</urn:attributes>
<urn:idapprovalroute>?</urn:idapprovalroute>
</urn:newKeyWordRequest>
</soapenv:Body>
</soapenv:Envelope>

Return:

ID #Description
returnSUCCESS: Returns a ("Operation successfully performed") message.
FAILURE: Returns a message regarding the error that occurred.