SchedulerWebService Web Service

SchedulerWebService

Click here for a complete list of operations.

GetTask

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

Parameter	Value
id:
PortalID:
userModuleId:
UserName:
secureToken:

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 /Modules/Admin/Scheduler/WebServices/SchedulerWebService.asmx HTTP/1.1
Host: bishwojyoti.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/GetTask"

<?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>
    <GetTask xmlns="http://tempuri.org/">
      <id>int</id>
      <PortalID>int</PortalID>
      <userModuleId>int</userModuleId>
      <UserName>string</UserName>
      <secureToken>string</secureToken>
    </GetTask>
  </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>
    <GetTaskResponse xmlns="http://tempuri.org/">
      <GetTaskResult>
        <ScheduleID>int</ScheduleID>
        <ScheduleName>string</ScheduleName>
        <FullNamespace>string</FullNamespace>
        <StartDate>string</StartDate>
        <EndDate>string</EndDate>
        <StartHour>int</StartHour>
        <StartMin>int</StartMin>
        <RepeatWeeks>int</RepeatWeeks>
        <RepeatDays>int</RepeatDays>
        <WeekOfMonth>int</WeekOfMonth>
        <EveryHours>int</EveryHours>
        <EveryMin>int</EveryMin>
        <Weekly>
          <int>int</int>
          <int>int</int>
        </Weekly>
        <Monthly>
          <int>int</int>
          <int>int</int>
        </Monthly>
        <Days>
          <int>int</int>
          <int>int</int>
        </Days>
        <ObjectDependencies>string</ObjectDependencies>
        <RetryTimeLapse>int</RetryTimeLapse>
        <RetryFrequencyUnit>int</RetryFrequencyUnit>
        <AttachToEvent>string</AttachToEvent>
        <CatchUpEnabled>boolean</CatchUpEnabled>
        <Servers>string</Servers>
        <CreatedByUserID>string</CreatedByUserID>
        <CreatedOnDate>string</CreatedOnDate>
        <LastModifiedbyUserID>int</LastModifiedbyUserID>
        <LastModifiedDate>string</LastModifiedDate>
        <ThreadID>int</ThreadID>
        <ProcessGroup>int</ProcessGroup>
        <NextStart>string</NextStart>
        <IsEnable>boolean</IsEnable>
        <RunningMode>Hourly or Daily or Weekly or WeekNumber or Calendar or Once</RunningMode>
        <AssemblyFileName>string</AssemblyFileName>
      </GetTaskResult>
    </GetTaskResponse>
  </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 /Modules/Admin/Scheduler/WebServices/SchedulerWebService.asmx HTTP/1.1
Host: bishwojyoti.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>
    <GetTask xmlns="http://tempuri.org/">
      <id>int</id>
      <PortalID>int</PortalID>
      <userModuleId>int</userModuleId>
      <UserName>string</UserName>
      <secureToken>string</secureToken>
    </GetTask>
  </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>
    <GetTaskResponse xmlns="http://tempuri.org/">
      <GetTaskResult>
        <ScheduleID>int</ScheduleID>
        <ScheduleName>string</ScheduleName>
        <FullNamespace>string</FullNamespace>
        <StartDate>string</StartDate>
        <EndDate>string</EndDate>
        <StartHour>int</StartHour>
        <StartMin>int</StartMin>
        <RepeatWeeks>int</RepeatWeeks>
        <RepeatDays>int</RepeatDays>
        <WeekOfMonth>int</WeekOfMonth>
        <EveryHours>int</EveryHours>
        <EveryMin>int</EveryMin>
        <Weekly>
          <int>int</int>
          <int>int</int>
        </Weekly>
        <Monthly>
          <int>int</int>
          <int>int</int>
        </Monthly>
        <Days>
          <int>int</int>
          <int>int</int>
        </Days>
        <ObjectDependencies>string</ObjectDependencies>
        <RetryTimeLapse>int</RetryTimeLapse>
        <RetryFrequencyUnit>int</RetryFrequencyUnit>
        <AttachToEvent>string</AttachToEvent>
        <CatchUpEnabled>boolean</CatchUpEnabled>
        <Servers>string</Servers>
        <CreatedByUserID>string</CreatedByUserID>
        <CreatedOnDate>string</CreatedOnDate>
        <LastModifiedbyUserID>int</LastModifiedbyUserID>
        <LastModifiedDate>string</LastModifiedDate>
        <ThreadID>int</ThreadID>
        <ProcessGroup>int</ProcessGroup>
        <NextStart>string</NextStart>
        <IsEnable>boolean</IsEnable>
        <RunningMode>Hourly or Daily or Weekly or WeekNumber or Calendar or Once</RunningMode>
        <AssemblyFileName>string</AssemblyFileName>
      </GetTaskResult>
    </GetTaskResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

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

GET /Modules/Admin/Scheduler/WebServices/SchedulerWebService.asmx/GetTask?id=string&PortalID=string&userModuleId=string&UserName=string&secureToken=string HTTP/1.1
Host: bishwojyoti.com

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

<?xml version="1.0" encoding="utf-8"?>
<Schedule xmlns="http://tempuri.org/">
  <ScheduleID>int</ScheduleID>
  <ScheduleName>string</ScheduleName>
  <FullNamespace>string</FullNamespace>
  <StartDate>string</StartDate>
  <EndDate>string</EndDate>
  <StartHour>int</StartHour>
  <StartMin>int</StartMin>
  <RepeatWeeks>int</RepeatWeeks>
  <RepeatDays>int</RepeatDays>
  <WeekOfMonth>int</WeekOfMonth>
  <EveryHours>int</EveryHours>
  <EveryMin>int</EveryMin>
  <Weekly>
    <int>int</int>
    <int>int</int>
  </Weekly>
  <Monthly>
    <int>int</int>
    <int>int</int>
  </Monthly>
  <Days>
    <int>int</int>
    <int>int</int>
  </Days>
  <ObjectDependencies>string</ObjectDependencies>
  <RetryTimeLapse>int</RetryTimeLapse>
  <RetryFrequencyUnit>int</RetryFrequencyUnit>
  <AttachToEvent>string</AttachToEvent>
  <CatchUpEnabled>boolean</CatchUpEnabled>
  <Servers>string</Servers>
  <CreatedByUserID>string</CreatedByUserID>
  <CreatedOnDate>string</CreatedOnDate>
  <LastModifiedbyUserID>int</LastModifiedbyUserID>
  <LastModifiedDate>string</LastModifiedDate>
  <ThreadID>int</ThreadID>
  <ProcessGroup>int</ProcessGroup>
  <NextStart>string</NextStart>
  <IsEnable>boolean</IsEnable>
  <RunningMode>Hourly or Daily or Weekly or WeekNumber or Calendar or Once</RunningMode>
  <AssemblyFileName>string</AssemblyFileName>
</Schedule>

HTTP POST

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

POST /Modules/Admin/Scheduler/WebServices/SchedulerWebService.asmx/GetTask HTTP/1.1
Host: bishwojyoti.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

id=string&PortalID=string&userModuleId=string&UserName=string&secureToken=string

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

<?xml version="1.0" encoding="utf-8"?>
<Schedule xmlns="http://tempuri.org/">
  <ScheduleID>int</ScheduleID>
  <ScheduleName>string</ScheduleName>
  <FullNamespace>string</FullNamespace>
  <StartDate>string</StartDate>
  <EndDate>string</EndDate>
  <StartHour>int</StartHour>
  <StartMin>int</StartMin>
  <RepeatWeeks>int</RepeatWeeks>
  <RepeatDays>int</RepeatDays>
  <WeekOfMonth>int</WeekOfMonth>
  <EveryHours>int</EveryHours>
  <EveryMin>int</EveryMin>
  <Weekly>
    <int>int</int>
    <int>int</int>
  </Weekly>
  <Monthly>
    <int>int</int>
    <int>int</int>
  </Monthly>
  <Days>
    <int>int</int>
    <int>int</int>
  </Days>
  <ObjectDependencies>string</ObjectDependencies>
  <RetryTimeLapse>int</RetryTimeLapse>
  <RetryFrequencyUnit>int</RetryFrequencyUnit>
  <AttachToEvent>string</AttachToEvent>
  <CatchUpEnabled>boolean</CatchUpEnabled>
  <Servers>string</Servers>
  <CreatedByUserID>string</CreatedByUserID>
  <CreatedOnDate>string</CreatedOnDate>
  <LastModifiedbyUserID>int</LastModifiedbyUserID>
  <LastModifiedDate>string</LastModifiedDate>
  <ThreadID>int</ThreadID>
  <ProcessGroup>int</ProcessGroup>
  <NextStart>string</NextStart>
  <IsEnable>boolean</IsEnable>
  <RunningMode>Hourly or Daily or Weekly or WeekNumber or Calendar or Once</RunningMode>
  <AssemblyFileName>string</AssemblyFileName>
</Schedule>