newAction

This method enables recording actions associated with an action plan. To use it, it is necessary to follow the standard documented below:

Java class
Request	web/wwwroot/ws/java/timecontrol/NewActionRequestType.java
Return	web/wwwroot/ws/java/timecontrol/NewActionResponseType.java

Request:

ID #	Required	Description
ActionPlanID	X	ID # of the action plan to which the action belongs.
ActionID		Action ID #.
ActionTitle	X	Action title (What?).
CatID	X¹	Action category ID #.
FgTypeAction	X	Action execution type. 1 - Immediate; 2 - Planned. Note: The Immediate configuration will only be enabled if it is configured in the action plan category.
TeamID		Action team ID #.
RespID	X	User ID of the Responsible for execution (Who?).
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?), in the 10000.00 format, where the "." is the decimal separator. Thousandth separator is not used.
DsWhy		Why?
DsWhere		Where?
DsHow		How?
DsResult	X²	Result.

info

• ¹ - It will be required only if a list of allowed categories is configured in the action plan category.
• ² - It will be required only for an immediate action to be added, and if the result is set as required in the plan category.

Request structure:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:timecontrol">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:newAction>
         <!--You may enter the following 16 items in any order-->
         <urn:ActionplanID>?</urn:ActionplanID>
         <urn:ActionID>?</urn:ActionID>
         <urn:ActionTitle>?</urn:ActionTitle>
         <urn:CatID>?</urn:CatID>
         <urn:FgTypeAction>?</urn:FgTypeAction>
         <urn:TeamID>?</urn:TeamID>
         <urn:RespID>?</urn:RespID>
         <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:newAction>
   </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 - ID # of the plan or action 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. ▪ -12 - The entered ID # already exists. Please edit it; ▪ -13 - Action plan not found; ▪ -14 - Inexistent user; ▪ -15 - Inactive user; ▪ -16 - Inexistent team; ▪ -17 - Inactive team; ▪ -18 - Category not found; ▪ -19 - Inactive category; ▪ -20 - End date earlier than start date; ▪ -21 - Plan already finished; ▪ -22 - The user does not have permission in the entered category; ▪ -23 - The user does not have permission in the entered plan; ▪ -24 - The category configuration does not allow adding an immediate action; ▪ -25 - The entered category is not in the restricted category list; ▪ -26 - It is not allowed to use retroactive dates; ▪ -27 - Unknown error when processing the request; ▪ -29 - The action plan had the maximum value of the How much? field exceeded; ▪ -30 - The action plan has already been finished; ▪ -32 - The action plan cannot be edited because of its status;
Detail	SUCCESS: Method executed successfully FAILURE: Description of the error that was found.

Return structure:

<newActionResponse>
        <RecordID>?</RecordID>
        <Status>?</Status>
        <Code>?</Code>
        <Detail>?</Detail>
</newActionResponse>