newIsolatedAction
This method allows creating isolated actions. To use it, it is necessary to follow the standard documented below:
Java class | |
---|---|
Request | web/wwwroot/ws/java/timecontrol/NewIsolatedActionRequestType.java |
Return | web/wwwroot/ws/java/timecontrol/NewIsolatedActionResponseType.java |
Request:
ID # | Required | Description |
---|---|---|
IsolatedActionModelID | Isolated action template ID #. | |
IsolatedActionID | Isolated action ID #. If it is not entered, a sequential ID # will be generated. | |
IsolatedActionTitle | X¹ | Isolated action title (What?). |
CategoryID | Isolated action category ID #. | |
FgTypeAction | X¹ | Execution type of the isolated action. 1 - Immediate; 2 - Planned. |
IsolatedActionRespID | X¹ | ID of the user responsible for the action. |
IsolatedActionExecRespID | X¹ | User ID of the Responsible for execution (Who?). |
TeamID | Action team ID #. | |
CalendarID | Action calendar ID #. | |
DtPlanStart | X¹ | Planned start date (When?) in the YYYY-MM-DD format. |
TmPlanStart | Planned start time (When?) in the HH:MM format. If it is not filled out, the system will consider the current time. | |
DtPlanEnd | X¹ | Planned end date (When?) in the YYYY-MM-DD format. |
TmPlanEnd | Planned end time (When?) in the HH:MM format. If it is not filled out, the system will consider the current time. | |
VlPlanCost | Planned cost (How much?): Format: 999.99. | |
DsWhy | Why? | |
DsWhere | Where? | |
DsHow | How? | |
DsResult | Result. It will be used only for the creation of immediate actions. If it is entered during the creation of a planned action, it will be disregarded. |
info
- ¹ - Required when an isolated action template is not entered.
Request structure:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:timecontrol">
<soapenv:Header/>
<soapenv:Body>
<urn:newIsolatedAction>
<!--You may enter the following 18 items in any order-->
<urn:IsolatedActionModelID>?</urn:IsolatedActionModelID>
<urn:IsolatedActionID>?</urn:IsolatedActionID>
<urn:IsolatedActionTitle>?</urn:IsolatedActionTitle>
<urn:CategoryID>?</urn:CategoryID>
<urn:FgTypeAction>?</urn:FgTypeAction>
<urn:IsolatedActionRespID>?</urn:IsolatedActionRespID>
<urn:IsolatedActionExecRespID>?</urn:IsolatedActionExecRespID>
<urn:TeamID>?</urn:TeamID>
<urn:CalendarID>?</urn:CalendarID>
<urn:DtPlanStart>?</urn:DtPlanStart>
<urn:TmPlanStart>?</urn:TmPlanStart>
<urn:DtPlanEnd>?</urn:DtPlanEnd>
<urn:TmPlanEnd>?</urn:TmPlanEnd>
<urn:VlPlanCost>?</urn:VlPlanCost>
<urn:DsWhy>?</urn:DsWhy>
<urn:DsWhere>?</urn:DsWhere>
<urn:DsHow>?</urn:DsHow>
<urn:DsResult>?</urn:DsResult>
</urn:newIsolatedAction>
</soapenv:Body>
</soapenv:Envelope>
Return:
ID # | Description |
---|---|
RecordID | SUCCESS: Action ID # recorded. |
Status | Returns the status of the execution. SUCCESS on success and FAILURE on failure. |
Code | Returns the execution code: â–ª 1 - Method executed successfully; â–ª -1 - Error in the configuration of the input parameters; â–ª -2 - The isolated action ID # is duplicated in the database; â–ª -3 - The authentication user does not have the necessary permission to execute this method. Check if the user has access to the PL025 menu. â–ª -4 - Category not found; â–ª -5 - Inactive category; â–ª -6 - User not found. (Responsible for the action); â–ª -7 - Inactive user. (Responsible for the action); â–ª -8 - User not found. (Responsible for the action execution); â–ª -9 - Inactive user. (Responsible for the action execution); â–ª -10 - The user responsible for execution must have access to the PL009 menu; â–ª -11 - Team not found; â–ª -12 - Inactive team; â–ª -13 - Calendar not found; â–ª -14 - Inactive calendar; â–ª -16 - The authentication user does not have the necessary permission (Add); â–ª -17 - Date inconsistency (Error details informed in the return); â–ª -18 - Unknown error when processing the request. Check log files or contact system administrator. â–ª -19 - The isolated action template entered does not exist. |
Detail | SUCCESS: Method executed successfully FAILURE: Description of the error that was found. |
Return structure:
<newIsolatedActionResponse>
<RecordID>?</RecordID>
<Status>?</Status>
<Code>?</Code>
<Detail>?</Detail>
</newIsolatedActionResponse>