API Web Service

API

Click here for a complete list of operations.

GetEffectiveSettingsForUsers

Gets the effective settings for users.

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /api/api.asmx HTTP/1.1
Host: jobctrl.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://jobctrl.com/GetEffectiveSettingsForUsers"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetEffectiveSettingsForUsers xmlns="http://jobctrl.com/">
      <CompanyAuthCode>guid</CompanyAuthCode>
      <userIds>
        <int>int</int>
        <int>int</int>
      </userIds>
    </GetEffectiveSettingsForUsers>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetEffectiveSettingsForUsersResponse xmlns="http://jobctrl.com/">
      <GetEffectiveSettingsForUsersResult>OK or UnknownError or AuthCodeNotValid</GetEffectiveSettingsForUsersResult>
      <effectiveSettings>
        <UserEffectiveSetting>
          <UserId>int</UserId>
          <CoreTime>
            <StartTime>short</StartTime>
            <EndTime>short</EndTime>
            <MinimumWorkTime>short</MinimumWorkTime>
            <StartOffset>short</StartOffset>
            <EndOffset>short</EndOffset>
          </CoreTime>
          <Client>
            <WorktimeStartInMins>int</WorktimeStartInMins>
            <WorktimeEndInMins>int</WorktimeEndInMins>
            <AfterWorktimeIdleInMins>int</AfterWorktimeIdleInMins>
            <DuringWorkTimeIdleInMins>int</DuringWorkTimeIdleInMins>
            <DuringWorkTimeIdleManualIntervalInMilisec>int</DuringWorkTimeIdleManualIntervalInMilisec>
            <MaxManualMeetingIntervalInMilisec>int</MaxManualMeetingIntervalInMilisec>
            <RuleRestrictions>None or CannotOverrideRules or CannotCreateOrModifyRules or CanModifyRuleTitle or CannotUseAnyOkValueForLearningRule or CanUseOkDefault or CanUseOkUntilWindowClosed or CanUseOkForOneHour or CanUseOkForOneDay</RuleRestrictions>
            <ScreenshotQuality>Excellent or Good or Low or None</ScreenshotQuality>
            <BusyTimeThreshold>int</BusyTimeThreshold>
            <MaxOfflineWorkItems>int</MaxOfflineWorkItems>
            <CoincidentalClientsEnabled>boolean</CoincidentalClientsEnabled>
            <DefaultTaskId>int</DefaultTaskId>
            <IsAutomaticTaskSelection>boolean</IsAutomaticTaskSelection>
            <IsOutlookAddinMailTrackingUseSubject>boolean</IsOutlookAddinMailTrackingUseSubject>
            <IsAnonymModeEnabled>boolean</IsAnonymModeEnabled>
            <IsManualMeetingStartsOnLock>boolean</IsManualMeetingStartsOnLock>
          </Client>
          <Meeting>
            <EnableMeetingTracking>boolean</EnableMeetingTracking>
            <EnableLotusNotesMeetingTracking>boolean</EnableLotusNotesMeetingTracking>
            <IsGoogleCalendarTrackingEnabled>boolean</IsGoogleCalendarTrackingEnabled>
            <DefaultTaskId>int</DefaultTaskId>
            <IsMeetingSubjectMandatory>boolean</IsMeetingSubjectMandatory>
            <IsOfflineWorkingTimeRequestAutomatic>boolean</IsOfflineWorkingTimeRequestAutomatic>
            <SynchronizeCalendarMeetingModifications>boolean</SynchronizeCalendarMeetingModifications>
            <AllowApprovalOfMeetingsLongerOrEqualThan24Hours>boolean</AllowApprovalOfMeetingsLongerOrEqualThan24Hours>
            <KeepMeetingParallelWorktime>boolean</KeepMeetingParallelWorktime>
            <AreTentativeMeetingsSynched>boolean</AreTentativeMeetingsSynched>
          </Meeting>
          <Mobile>
            <LocationTrackMode>NoLocation or Location or LocationSetByUser</LocationTrackMode>
            <PrivateCallDuration>int</PrivateCallDuration>
            <AfterWorkTimeIdleMinutes>int</AfterWorkTimeIdleMinutes>
            <WorkCallDuration>int</WorkCallDuration>
            <MinimumDurationOfStayInMins>short</MinimumDurationOfStayInMins>
          </Mobile>
          <IncidentManager>
            <RemoveWorkTimeAutomatically>boolean</RemoveWorkTimeAutomatically>
            <MinimumIncidentTime>int</MinimumIncidentTime>
            <MinimumWorkTimeInMinutesToGenerateAtNight>int</MinimumWorkTimeInMinutesToGenerateAtNight>
            <IncidentAutoAcceptTimeInWorkDays>int</IncidentAutoAcceptTimeInWorkDays>
          </IncidentManager>
          <Other>
            <CostCenterId>int</CostCenterId>
            <TimeZoneId>unsignedByte</TimeZoneId>
            <CalendarId>int</CalendarId>
            <DailyWorkTimeInMinutes>short</DailyWorkTimeInMinutes>
            <TaskMandatoryFields>None or Priority or StartEndDate or PlannedWorkTime or PlannedCost or Description or Category</TaskMandatoryFields>
            <TaskAssignmentMandatoryFields>None or Priority or StartEndDate or PlannedWorkTime</TaskAssignmentMandatoryFields>
            <ManualWorkItemEditAgeLimit>int</ManualWorkItemEditAgeLimit>
            <MinNumOfActiveUsersInGroup>int</MinNumOfActiveUsersInGroup>
            <MinPercentOfActiveUsersInGroup>int</MinPercentOfActiveUsersInGroup>
            <TargetWorkTimeIntervalsInMinutes xsi:nil="true" />
          </Other>
        </UserEffectiveSetting>
        <UserEffectiveSetting>
          <UserId>int</UserId>
          <CoreTime>
            <StartTime>short</StartTime>
            <EndTime>short</EndTime>
            <MinimumWorkTime>short</MinimumWorkTime>
            <StartOffset>short</StartOffset>
            <EndOffset>short</EndOffset>
          </CoreTime>
          <Client>
            <WorktimeStartInMins>int</WorktimeStartInMins>
            <WorktimeEndInMins>int</WorktimeEndInMins>
            <AfterWorktimeIdleInMins>int</AfterWorktimeIdleInMins>
            <DuringWorkTimeIdleInMins>int</DuringWorkTimeIdleInMins>
            <DuringWorkTimeIdleManualIntervalInMilisec>int</DuringWorkTimeIdleManualIntervalInMilisec>
            <MaxManualMeetingIntervalInMilisec>int</MaxManualMeetingIntervalInMilisec>
            <RuleRestrictions>None or CannotOverrideRules or CannotCreateOrModifyRules or CanModifyRuleTitle or CannotUseAnyOkValueForLearningRule or CanUseOkDefault or CanUseOkUntilWindowClosed or CanUseOkForOneHour or CanUseOkForOneDay</RuleRestrictions>
            <ScreenshotQuality>Excellent or Good or Low or None</ScreenshotQuality>
            <BusyTimeThreshold>int</BusyTimeThreshold>
            <MaxOfflineWorkItems>int</MaxOfflineWorkItems>
            <CoincidentalClientsEnabled>boolean</CoincidentalClientsEnabled>
            <DefaultTaskId>int</DefaultTaskId>
            <IsAutomaticTaskSelection>boolean</IsAutomaticTaskSelection>
            <IsOutlookAddinMailTrackingUseSubject>boolean</IsOutlookAddinMailTrackingUseSubject>
            <IsAnonymModeEnabled>boolean</IsAnonymModeEnabled>
            <IsManualMeetingStartsOnLock>boolean</IsManualMeetingStartsOnLock>
          </Client>
          <Meeting>
            <EnableMeetingTracking>boolean</EnableMeetingTracking>
            <EnableLotusNotesMeetingTracking>boolean</EnableLotusNotesMeetingTracking>
            <IsGoogleCalendarTrackingEnabled>boolean</IsGoogleCalendarTrackingEnabled>
            <DefaultTaskId>int</DefaultTaskId>
            <IsMeetingSubjectMandatory>boolean</IsMeetingSubjectMandatory>
            <IsOfflineWorkingTimeRequestAutomatic>boolean</IsOfflineWorkingTimeRequestAutomatic>
            <SynchronizeCalendarMeetingModifications>boolean</SynchronizeCalendarMeetingModifications>
            <AllowApprovalOfMeetingsLongerOrEqualThan24Hours>boolean</AllowApprovalOfMeetingsLongerOrEqualThan24Hours>
            <KeepMeetingParallelWorktime>boolean</KeepMeetingParallelWorktime>
            <AreTentativeMeetingsSynched>boolean</AreTentativeMeetingsSynched>
          </Meeting>
          <Mobile>
            <LocationTrackMode>NoLocation or Location or LocationSetByUser</LocationTrackMode>
            <PrivateCallDuration>int</PrivateCallDuration>
            <AfterWorkTimeIdleMinutes>int</AfterWorkTimeIdleMinutes>
            <WorkCallDuration>int</WorkCallDuration>
            <MinimumDurationOfStayInMins>short</MinimumDurationOfStayInMins>
          </Mobile>
          <IncidentManager>
            <RemoveWorkTimeAutomatically>boolean</RemoveWorkTimeAutomatically>
            <MinimumIncidentTime>int</MinimumIncidentTime>
            <MinimumWorkTimeInMinutesToGenerateAtNight>int</MinimumWorkTimeInMinutesToGenerateAtNight>
            <IncidentAutoAcceptTimeInWorkDays>int</IncidentAutoAcceptTimeInWorkDays>
          </IncidentManager>
          <Other>
            <CostCenterId>int</CostCenterId>
            <TimeZoneId>unsignedByte</TimeZoneId>
            <CalendarId>int</CalendarId>
            <DailyWorkTimeInMinutes>short</DailyWorkTimeInMinutes>
            <TaskMandatoryFields>None or Priority or StartEndDate or PlannedWorkTime or PlannedCost or Description or Category</TaskMandatoryFields>
            <TaskAssignmentMandatoryFields>None or Priority or StartEndDate or PlannedWorkTime</TaskAssignmentMandatoryFields>
            <ManualWorkItemEditAgeLimit>int</ManualWorkItemEditAgeLimit>
            <MinNumOfActiveUsersInGroup>int</MinNumOfActiveUsersInGroup>
            <MinPercentOfActiveUsersInGroup>int</MinPercentOfActiveUsersInGroup>
            <TargetWorkTimeIntervalsInMinutes xsi:nil="true" />
          </Other>
        </UserEffectiveSetting>
      </effectiveSettings>
    </GetEffectiveSettingsForUsersResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /api/api.asmx HTTP/1.1
Host: jobctrl.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetEffectiveSettingsForUsers xmlns="http://jobctrl.com/">
      <CompanyAuthCode>guid</CompanyAuthCode>
      <userIds>
        <int>int</int>
        <int>int</int>
      </userIds>
    </GetEffectiveSettingsForUsers>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetEffectiveSettingsForUsersResponse xmlns="http://jobctrl.com/">
      <GetEffectiveSettingsForUsersResult>OK or UnknownError or AuthCodeNotValid</GetEffectiveSettingsForUsersResult>
      <effectiveSettings>
        <UserEffectiveSetting>
          <UserId>int</UserId>
          <CoreTime>
            <StartTime>short</StartTime>
            <EndTime>short</EndTime>
            <MinimumWorkTime>short</MinimumWorkTime>
            <StartOffset>short</StartOffset>
            <EndOffset>short</EndOffset>
          </CoreTime>
          <Client>
            <WorktimeStartInMins>int</WorktimeStartInMins>
            <WorktimeEndInMins>int</WorktimeEndInMins>
            <AfterWorktimeIdleInMins>int</AfterWorktimeIdleInMins>
            <DuringWorkTimeIdleInMins>int</DuringWorkTimeIdleInMins>
            <DuringWorkTimeIdleManualIntervalInMilisec>int</DuringWorkTimeIdleManualIntervalInMilisec>
            <MaxManualMeetingIntervalInMilisec>int</MaxManualMeetingIntervalInMilisec>
            <RuleRestrictions>None or CannotOverrideRules or CannotCreateOrModifyRules or CanModifyRuleTitle or CannotUseAnyOkValueForLearningRule or CanUseOkDefault or CanUseOkUntilWindowClosed or CanUseOkForOneHour or CanUseOkForOneDay</RuleRestrictions>
            <ScreenshotQuality>Excellent or Good or Low or None</ScreenshotQuality>
            <BusyTimeThreshold>int</BusyTimeThreshold>
            <MaxOfflineWorkItems>int</MaxOfflineWorkItems>
            <CoincidentalClientsEnabled>boolean</CoincidentalClientsEnabled>
            <DefaultTaskId>int</DefaultTaskId>
            <IsAutomaticTaskSelection>boolean</IsAutomaticTaskSelection>
            <IsOutlookAddinMailTrackingUseSubject>boolean</IsOutlookAddinMailTrackingUseSubject>
            <IsAnonymModeEnabled>boolean</IsAnonymModeEnabled>
            <IsManualMeetingStartsOnLock>boolean</IsManualMeetingStartsOnLock>
          </Client>
          <Meeting>
            <EnableMeetingTracking>boolean</EnableMeetingTracking>
            <EnableLotusNotesMeetingTracking>boolean</EnableLotusNotesMeetingTracking>
            <IsGoogleCalendarTrackingEnabled>boolean</IsGoogleCalendarTrackingEnabled>
            <DefaultTaskId>int</DefaultTaskId>
            <IsMeetingSubjectMandatory>boolean</IsMeetingSubjectMandatory>
            <IsOfflineWorkingTimeRequestAutomatic>boolean</IsOfflineWorkingTimeRequestAutomatic>
            <SynchronizeCalendarMeetingModifications>boolean</SynchronizeCalendarMeetingModifications>
            <AllowApprovalOfMeetingsLongerOrEqualThan24Hours>boolean</AllowApprovalOfMeetingsLongerOrEqualThan24Hours>
            <KeepMeetingParallelWorktime>boolean</KeepMeetingParallelWorktime>
            <AreTentativeMeetingsSynched>boolean</AreTentativeMeetingsSynched>
          </Meeting>
          <Mobile>
            <LocationTrackMode>NoLocation or Location or LocationSetByUser</LocationTrackMode>
            <PrivateCallDuration>int</PrivateCallDuration>
            <AfterWorkTimeIdleMinutes>int</AfterWorkTimeIdleMinutes>
            <WorkCallDuration>int</WorkCallDuration>
            <MinimumDurationOfStayInMins>short</MinimumDurationOfStayInMins>
          </Mobile>
          <IncidentManager>
            <RemoveWorkTimeAutomatically>boolean</RemoveWorkTimeAutomatically>
            <MinimumIncidentTime>int</MinimumIncidentTime>
            <MinimumWorkTimeInMinutesToGenerateAtNight>int</MinimumWorkTimeInMinutesToGenerateAtNight>
            <IncidentAutoAcceptTimeInWorkDays>int</IncidentAutoAcceptTimeInWorkDays>
          </IncidentManager>
          <Other>
            <CostCenterId>int</CostCenterId>
            <TimeZoneId>unsignedByte</TimeZoneId>
            <CalendarId>int</CalendarId>
            <DailyWorkTimeInMinutes>short</DailyWorkTimeInMinutes>
            <TaskMandatoryFields>None or Priority or StartEndDate or PlannedWorkTime or PlannedCost or Description or Category</TaskMandatoryFields>
            <TaskAssignmentMandatoryFields>None or Priority or StartEndDate or PlannedWorkTime</TaskAssignmentMandatoryFields>
            <ManualWorkItemEditAgeLimit>int</ManualWorkItemEditAgeLimit>
            <MinNumOfActiveUsersInGroup>int</MinNumOfActiveUsersInGroup>
            <MinPercentOfActiveUsersInGroup>int</MinPercentOfActiveUsersInGroup>
            <TargetWorkTimeIntervalsInMinutes xsi:nil="true" />
          </Other>
        </UserEffectiveSetting>
        <UserEffectiveSetting>
          <UserId>int</UserId>
          <CoreTime>
            <StartTime>short</StartTime>
            <EndTime>short</EndTime>
            <MinimumWorkTime>short</MinimumWorkTime>
            <StartOffset>short</StartOffset>
            <EndOffset>short</EndOffset>
          </CoreTime>
          <Client>
            <WorktimeStartInMins>int</WorktimeStartInMins>
            <WorktimeEndInMins>int</WorktimeEndInMins>
            <AfterWorktimeIdleInMins>int</AfterWorktimeIdleInMins>
            <DuringWorkTimeIdleInMins>int</DuringWorkTimeIdleInMins>
            <DuringWorkTimeIdleManualIntervalInMilisec>int</DuringWorkTimeIdleManualIntervalInMilisec>
            <MaxManualMeetingIntervalInMilisec>int</MaxManualMeetingIntervalInMilisec>
            <RuleRestrictions>None or CannotOverrideRules or CannotCreateOrModifyRules or CanModifyRuleTitle or CannotUseAnyOkValueForLearningRule or CanUseOkDefault or CanUseOkUntilWindowClosed or CanUseOkForOneHour or CanUseOkForOneDay</RuleRestrictions>
            <ScreenshotQuality>Excellent or Good or Low or None</ScreenshotQuality>
            <BusyTimeThreshold>int</BusyTimeThreshold>
            <MaxOfflineWorkItems>int</MaxOfflineWorkItems>
            <CoincidentalClientsEnabled>boolean</CoincidentalClientsEnabled>
            <DefaultTaskId>int</DefaultTaskId>
            <IsAutomaticTaskSelection>boolean</IsAutomaticTaskSelection>
            <IsOutlookAddinMailTrackingUseSubject>boolean</IsOutlookAddinMailTrackingUseSubject>
            <IsAnonymModeEnabled>boolean</IsAnonymModeEnabled>
            <IsManualMeetingStartsOnLock>boolean</IsManualMeetingStartsOnLock>
          </Client>
          <Meeting>
            <EnableMeetingTracking>boolean</EnableMeetingTracking>
            <EnableLotusNotesMeetingTracking>boolean</EnableLotusNotesMeetingTracking>
            <IsGoogleCalendarTrackingEnabled>boolean</IsGoogleCalendarTrackingEnabled>
            <DefaultTaskId>int</DefaultTaskId>
            <IsMeetingSubjectMandatory>boolean</IsMeetingSubjectMandatory>
            <IsOfflineWorkingTimeRequestAutomatic>boolean</IsOfflineWorkingTimeRequestAutomatic>
            <SynchronizeCalendarMeetingModifications>boolean</SynchronizeCalendarMeetingModifications>
            <AllowApprovalOfMeetingsLongerOrEqualThan24Hours>boolean</AllowApprovalOfMeetingsLongerOrEqualThan24Hours>
            <KeepMeetingParallelWorktime>boolean</KeepMeetingParallelWorktime>
            <AreTentativeMeetingsSynched>boolean</AreTentativeMeetingsSynched>
          </Meeting>
          <Mobile>
            <LocationTrackMode>NoLocation or Location or LocationSetByUser</LocationTrackMode>
            <PrivateCallDuration>int</PrivateCallDuration>
            <AfterWorkTimeIdleMinutes>int</AfterWorkTimeIdleMinutes>
            <WorkCallDuration>int</WorkCallDuration>
            <MinimumDurationOfStayInMins>short</MinimumDurationOfStayInMins>
          </Mobile>
          <IncidentManager>
            <RemoveWorkTimeAutomatically>boolean</RemoveWorkTimeAutomatically>
            <MinimumIncidentTime>int</MinimumIncidentTime>
            <MinimumWorkTimeInMinutesToGenerateAtNight>int</MinimumWorkTimeInMinutesToGenerateAtNight>
            <IncidentAutoAcceptTimeInWorkDays>int</IncidentAutoAcceptTimeInWorkDays>
          </IncidentManager>
          <Other>
            <CostCenterId>int</CostCenterId>
            <TimeZoneId>unsignedByte</TimeZoneId>
            <CalendarId>int</CalendarId>
            <DailyWorkTimeInMinutes>short</DailyWorkTimeInMinutes>
            <TaskMandatoryFields>None or Priority or StartEndDate or PlannedWorkTime or PlannedCost or Description or Category</TaskMandatoryFields>
            <TaskAssignmentMandatoryFields>None or Priority or StartEndDate or PlannedWorkTime</TaskAssignmentMandatoryFields>
            <ManualWorkItemEditAgeLimit>int</ManualWorkItemEditAgeLimit>
            <MinNumOfActiveUsersInGroup>int</MinNumOfActiveUsersInGroup>
            <MinPercentOfActiveUsersInGroup>int</MinPercentOfActiveUsersInGroup>
            <TargetWorkTimeIntervalsInMinutes xsi:nil="true" />
          </Other>
        </UserEffectiveSetting>
      </effectiveSettings>
    </GetEffectiveSettingsForUsersResponse>
  </soap12:Body>
</soap12:Envelope>