Version: 2.2.3

newActionPlan

This method enables the creation of action plans. To use it, it is necessary to follow the standard documented below:

Java class
Request	web/wwwroot/ws/java/timecontrol/NewActionPlanRequestType.java
Return	web/wwwroot/ws/java/timecontrol/NewActionPlanResponseType.java

Request:

ID #	Required	Description
IDMODELPLANACTIVITY		Action plan template ID #.
IDACTIONPLAN	X¹	Action plan ID #.
TITLE	X²	Action plan title.
IDCATEGORY	X²	Category ID #.
IDPLANNINGRESP	X	ID of the user responsible for planning the action plan.
IDACTIONPLANRESP	X	ID of the user responsible for the action plan.
IDTEAMPLANNINGRESP		ID of the team responsible for planning the action plan.
IDTEAMMONITORINGRESP		ID # of the team responsible for the action plan.
IDCALENDAR		Calendar ID #.
SUMMARY		Action plan description.
OBJECTIVE		Action plan objective.
JUSTIFY		Action plan explanation.
BENEFIT		Action plan benefit.

info

¹ - Required only when there are no identification masks configured in the category.
² - Required only when an action plan template is not used.

Request structure:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:timecontrol">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:newActionPlan>
         <!--You may enter the following 13 items in any order-->
         <urn:IDModelPlanActivity>?</urn:IDModelPlanActivity>
         <urn:IDActionPlan>?</urn:IDActionPlan>
         <urn:Title>?</urn:Title>
         <urn:IDCategory>?</urn:IDCategory>
         <urn:IDPlanningResp>?</urn:IDPlanningResp>
         <urn:IDActionPlanResp>?</urn:IDActionPlanResp>
         <urn:IDTeamPlanningResp>?</urn:IDTeamPlanningResp>
         <urn:IDTeamMonitoringResp>?</urn:IDTeamMonitoringResp>
         <urn:IDCalendar>?</urn:IDCalendar>
         <urn:Summary>?</urn:Summary>
         <urn:Objective>?</urn:Objective>
         <urn:Justify>?</urn:Justify>
         <urn:Benefit>?</urn:Benefit>
      </urn:newActionPlan>
   </soapenv:Body>
</soapenv:Envelope>

Return:

ID #	Description
Return	SUCCESS: Action plan ID # created. FAILURE: Code regarding the error that occurred: ▪ -1 - Action plan ID # already exists; ▪ -2 - The authentication user does not have permission to execute this method; ▪ -3 - The user does not have permission in the specified category; ▪ -4 - Category not found; ▪ -5 - User not found; ▪ -6 - Team not found; ▪ -7 - Calendar not found; ▪ -8 - Inactive user; ▪ -9 - Inactive team; ▪ -10 - Inactive category; ▪ -11 - Action plan template not found; ▪ -12 - Required parameter not entered; ▪ -13 - The user entered as responsible for planning the action plan does not have access to the planning menu; ▪ -14 - The user entered as responsible for the action plan does not have access to the tracking menu;

ID #

Description

Return

SUCCESS: Action plan ID # created.
FAILURE: Code regarding the error that occurred:
▪ -1 - Action plan ID # already exists;
▪ -2 - The authentication user does not have permission to execute this method;
▪ -3 - The user does not have permission in the specified category;
▪ -4 - Category not found;
▪ -5 - User not found;
▪ -6 - Team not found;
▪ -7 - Calendar not found;
▪ -8 - Inactive user;
▪ -9 - Inactive team;
▪ -10 - Inactive category;
▪ -11 - Action plan template not found;
▪ -12 - Required parameter not entered;
▪ -13 - The user entered as responsible for planning the action plan does not have access to the planning menu;
▪ -14 - The user entered as responsible for the action plan does not have access to the tracking menu;