Terminal Services API

This article describes the Worktime API methods for handling terminal services.

BeginActivity

Begins the specified event for the user specified in CallerAuthentication object

• CallerAuthentication - authentication object (see CallerAuthentication)
• ActivityTypeId - int, The Type of activity (Available activity type ids can be found using the GetActivityTypes function)
• BeginDateTime - Optional, datetime (ISO8601 compatible datetime format e.g. YYYY-MM-DDTHH:MM:SS. Timezone information not currently supported, EET/EEST used.)
• EndDateTime - Optional, datetime (ISO8601 compatible datetime format e.g. YYYY-MM-DDTHH:MM:SS. Timezone information not currently supported, EET/EEST used.)
• Comment - string, optional
• OvertimeBasePartTargetedTo - string, optional (one of following: "annualabsence", "balance", "bank", "flexiblehours", "flexibleworkhours", "levellingperiodhours", "overtimebalance", "salary", "uncompensated" or "worktimeshorteningleave". Omitting field or giving an incorrect value will use default settings.)
• OvertimeIncrementPartTargetedTo - string, optional (one of following: "annualabsence", "balance", "bank", "flexiblehours", "flexibleworkhours", "levellingperiodhours", "overtimebalance", "salary", "uncompensated" or "worktimeshorteningleave". Omitting field or giving an incorrect value will use default settings.)
• RelatedProjects - related projects and durations as a list of ActivityToProjectRelation elements, see ActivityToProjectRelation
• WorkIncrements - list of related WorkIncrement elements, see structure below

Return fields:

• ResponseCode - A numeric value describing the success or failure of the request, see Response codes
• ResponseString - A text description of the response success or reason for failure
• UserId - The ID for the user the activity was created for
• Locale - The language currently set for the user:

  en_US	English
  fi_FI	Finnish
  sv_SE	Swedish
  da_DK	Danish
  pl_PL	Polish
  et_EE	Estonian

• StartedActivity - The event as Activity object, see Activity (in GetActivitiesResponse)
• AccrualList - A list of Accrual objects (see structure below)

EndActivity

Ends the specified activity

• CallerAuthentication - authentication object (see CallerAuthentication)
• ActivityId – int, The id of the activity to be ended
• EndDateTime - Optional, datetime (ISO8601 compatible datetime format e.g. YYYY-MM-DDTHH:MM:SS. Timezone information not currently supported, EET/EEST used.)
• Comment - string, optional
• OvertimeBasePartTargetedTo - string, optional (one of following: "annualabsence", "balance", "bank", "flexiblehours", "flexibleworkhours", "levellingperiodhours", "overtimebalance", "salary", "uncompensated" or "worktimeshorteningleave". Omitting field or giving an incorrect value will use default settings.)
• OvertimeIncrementPartTargetedTo - string, optional (one of following: "annualabsence", "balance", "bank", "flexiblehours", "flexibleworkhours", "levellingperiodhours", "overtimebalance", "salary", "uncompensated" or "worktimeshorteningleave". Omitting field or giving an incorrect value will use default settings.)
• RelatedProjects - related projects and durations as a list of ActivityToProjectRelation elements, see structure below
• WorkIncrements - list of related WorkIncrement elements, see structure below

Return fields:

• ResponseCode - A numeric value describing the success or failure of the request, see Response codes
• ResponseString - A text description of the response success or reason for failure
• UserId - The ID for the user the activity was Ended for
• Locale - The language currently set for the user:

  en_US	English
  fi_FI	Finnish
  sv_SE	Swedish
  da_DK	Danish
  pl_PL	Polish
  et_EE	Estonian

• StartedActivity - The event as Activity object, see Activity (in GetActivitiesResponse)
• AccrualList - A list of Accrual objects (see structure below)

TerminalLogin

Fetches values set and available for user. These can be used to acknowledge supported values while adding activities for the user.

Input parameters:

• CallerAuthentication - authentication object (see CallerAuthentication)

Return fields:

• ResponseCode - A numeric value describing the success or failure of the request, see Response codes
• ResponseString - A text description of the response success or reason for failure
• UserId - int
• CustomerId - int
• Username - string
• Firstname - string
• Lastname - string
• Locale - string:

  en_US	English
  fi_FI	Finnish
  sv_SE	Swedish
  da_DK	Danish
  pl_PL	Polish
  et_EE	Estonian

• ProjectList - a list of Project elements for the user, see structure below
• ProjectsToContinue - a list of ActivityToProjectRelation elements, see ActivityToProjectRelation
• OnGoingActivity - Activity element of ongoing event, see Activity (in GetActivitiesResponse)
• ProjectMandatory - boolean
• WorkIncrementsForUser - a list of WorkIncrementName elements which provides supplements available for the user, see structure below
• DiningIncrements - element contains ActivityId and WorkIncrement for dining activity, see WSDL
• DefaultOvertimeBaseTargetedTo - string (one of following: "annualabsence", "balance", "bank", "flexiblehours", "flexibleworkhours", "levellingperiodhours", "overtimebalance", "salary", "uncompensated" or "worktimeshorteningleave". Omitting field or giving an incorrect value will use default settings.)
• DefaultOvertimeIncrementTargetedTo - string (one of following: "annualabsence", "balance", "bank", "flexiblehours", "flexibleworkhours", "levellingperiodhours", "overtimebalance", "salary", "uncompensated" or "worktimeshorteningleave". Omitting field or giving an incorrect value will use default settings.)
• ActivityTypes - list of ActivityType elements for the user, see structure below
• AccrualList - list of Accrual elements for the user, see structure below
• CurrentDateTimeUTC - datetime