newIsolatedAction

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

X1

Isolated action title (What?).

CategoryID

Isolated action category ID #.

FgTypeAction

X1

Execution type of the isolated action.

1 – Immediate;

2 – Planned.

IsolatedActionRespID

X1

ID of the user responsible for the action.

IsolatedActionExecRespID

X1

User ID of the Responsible for execution (Who?).

TeamID

Action team ID #.

CalendarID

Action calendar ID #.

DtPlanStart

X1

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

X1

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 immediate actions to be created. If it is entered during the creation of a planned action, it will be disregarded.

Request structure

<newIsolatedAction>

<IsolatedActionModelID>?</IsolatedActionModelID>

   <IsolatedActionID>?</IsolatedActionID>

   <IsolatedActionTitle>?</IsolatedActionTitle>

   <CategoryID>?</CategoryID>

   <FgTypeAction>?</FgTypeAction>

   <IsolatedActionRespID>?</IsolatedActionRespID>

   <IsolatedActionExecRespID>?</IsolatedActionExecRespID>

   <TeamID>?</TeamID>

   <CalendarID>?</CalendarID>

   <DtPlanStart>?</DtPlanStart>

   <TmPlanStart>?</TmPlanStart>

   <DtPlanEnd>?</DtPlanEnd>

   <TmPlanEnd>?</TmPlanEnd>

   <VlPlanCost>?</VlPlanCost>

   <DsWhy>?</DsWhy>

   <DsWhere>?</DsWhere>

   <DsHow>?</DsHow>

   <DsResult>?</DsResult>

</newIsolatedAction>

Return structure

<newIsolatedActionResponse>

   <RecordID>?</RecordID>

   <Status>?</Status>

   <Code>?</Code>

   <Detail>?</Detail>

</newIsolatedActionResponse>

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 was 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 occurred.