Document toolboxDocument toolbox

Integration ServiceOptimizer Common API Concepts Employee Jobs Inteface

Employee Jobs Interface

The Employee Jobs interface supplies the information about employees’ jobs and standard activities for a particular date.

As well as a function to get the actual jobs (GetJobsRequest) and activities (GetActsRequest), there is a function which can be used to get all the employees in a Responsibility Unit (GetEmpsRequest) and another function to get all the Responsibility Units (GetRespUnitsRequest).

As an example of their use, the following pseudo-code illustrates how to get all of the jobs in all RUs  for a single day:

 while (more_RUs_available)
{     GetRespUnitsRequest
      for (each responsibility unit)
      {     while (more_emps_available)
            {     GetEmpsRequest;
                  for (each employee)
                  {     while (more_jobs_available)
                        {
                              GetJobsRequest;
                        }
                        while (more_activities_available)
                        {
                              GetActsRequest;
            }     }     }
            while (more_unresourced_jobs_available)
            {
                  GetJobsRequest;
}     }     }

Each of the available functions has the capability of returning the data in batches if so desired. In each case, the size of the batch may be specified and the call will provide the marker for where to start the next batch from as part of the response. However, if there is no requirement for these batches, and all items are to be returned from a single call, the relevant fields should be omitted from the call.