API Web Service

API

Click here for a complete list of operations.

GetWorkflowReport

Get the company's workflow report for the specified time interval

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/GetWorkflowReport"

<?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>
    <GetWorkflowReport xmlns="http://jobctrl.com/">
      <CompanyAuthCode>guid</CompanyAuthCode>
      <StartDate>dateTime</StartDate>
      <EndDate>dateTime</EndDate>
      <userIdList>
        <int>int</int>
        <int>int</int>
      </userIdList>
      <workerGroupIds>
        <int>int</int>
        <int>int</int>
      </workerGroupIds>
      <taskIdList>
        <int>int</int>
        <int>int</int>
      </taskIdList>
    </GetWorkflowReport>
  </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>
    <GetWorkflowReportResponse xmlns="http://jobctrl.com/">
      <GetWorkflowReportResult>OK or UnknownError or AuthCodeNotValid</GetWorkflowReportResult>
      <Report>
        <WorkFlowView>
          <WorkFlowReportItem>
            <FirstName>string</FirstName>
            <LastName>string</LastName>
            <UserId>int</UserId>
            <TaskName>string</TaskName>
            <TaskId>int</TaskId>
            <ParentTaskNames xsi:nil="true" />
            <ParentWorkerGroupNames xsi:nil="true" />
            <StartDate>dateTime</StartDate>
            <EndDate>dateTime</EndDate>
            <WorkFlowReportItemType>PC or Mobile or Ivr or Manual or Meeting or MobileCallWithWorkTime or MobileCallWithoutWorkTime or ReasonResponse or BusyTime</WorkFlowReportItemType>
            <ActiveTimeInMillisecond>long</ActiveTimeInMillisecond>
            <InactiveTimeInMillisecond>long</InactiveTimeInMillisecond>
            <WorktimeModificationDescription>string</WorktimeModificationDescription>
            <PhoneNumber>string</PhoneNumber>
            <MobileContactName>string</MobileContactName>
            <IsInbound>boolean</IsInbound>
            <MeetingTitle>string</MeetingTitle>
            <MeetingDescription>string</MeetingDescription>
            <MeetingParticipants>string</MeetingParticipants>
            <MeetingType>Calendar or Manual</MeetingType>
            <ReasonResponseFullPath>string</ReasonResponseFullPath>
            <ReasonResponseFreeText>string</ReasonResponseFreeText>
          </WorkFlowReportItem>
          <WorkFlowReportItem>
            <FirstName>string</FirstName>
            <LastName>string</LastName>
            <UserId>int</UserId>
            <TaskName>string</TaskName>
            <TaskId>int</TaskId>
            <ParentTaskNames xsi:nil="true" />
            <ParentWorkerGroupNames xsi:nil="true" />
            <StartDate>dateTime</StartDate>
            <EndDate>dateTime</EndDate>
            <WorkFlowReportItemType>PC or Mobile or Ivr or Manual or Meeting or MobileCallWithWorkTime or MobileCallWithoutWorkTime or ReasonResponse or BusyTime</WorkFlowReportItemType>
            <ActiveTimeInMillisecond>long</ActiveTimeInMillisecond>
            <InactiveTimeInMillisecond>long</InactiveTimeInMillisecond>
            <WorktimeModificationDescription>string</WorktimeModificationDescription>
            <PhoneNumber>string</PhoneNumber>
            <MobileContactName>string</MobileContactName>
            <IsInbound>boolean</IsInbound>
            <MeetingTitle>string</MeetingTitle>
            <MeetingDescription>string</MeetingDescription>
            <MeetingParticipants>string</MeetingParticipants>
            <MeetingType>Calendar or Manual</MeetingType>
            <ReasonResponseFullPath>string</ReasonResponseFullPath>
            <ReasonResponseFreeText>string</ReasonResponseFreeText>
          </WorkFlowReportItem>
        </WorkFlowView>
      </Report>
    </GetWorkflowReportResponse>
  </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>
    <GetWorkflowReport xmlns="http://jobctrl.com/">
      <CompanyAuthCode>guid</CompanyAuthCode>
      <StartDate>dateTime</StartDate>
      <EndDate>dateTime</EndDate>
      <userIdList>
        <int>int</int>
        <int>int</int>
      </userIdList>
      <workerGroupIds>
        <int>int</int>
        <int>int</int>
      </workerGroupIds>
      <taskIdList>
        <int>int</int>
        <int>int</int>
      </taskIdList>
    </GetWorkflowReport>
  </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>
    <GetWorkflowReportResponse xmlns="http://jobctrl.com/">
      <GetWorkflowReportResult>OK or UnknownError or AuthCodeNotValid</GetWorkflowReportResult>
      <Report>
        <WorkFlowView>
          <WorkFlowReportItem>
            <FirstName>string</FirstName>
            <LastName>string</LastName>
            <UserId>int</UserId>
            <TaskName>string</TaskName>
            <TaskId>int</TaskId>
            <ParentTaskNames xsi:nil="true" />
            <ParentWorkerGroupNames xsi:nil="true" />
            <StartDate>dateTime</StartDate>
            <EndDate>dateTime</EndDate>
            <WorkFlowReportItemType>PC or Mobile or Ivr or Manual or Meeting or MobileCallWithWorkTime or MobileCallWithoutWorkTime or ReasonResponse or BusyTime</WorkFlowReportItemType>
            <ActiveTimeInMillisecond>long</ActiveTimeInMillisecond>
            <InactiveTimeInMillisecond>long</InactiveTimeInMillisecond>
            <WorktimeModificationDescription>string</WorktimeModificationDescription>
            <PhoneNumber>string</PhoneNumber>
            <MobileContactName>string</MobileContactName>
            <IsInbound>boolean</IsInbound>
            <MeetingTitle>string</MeetingTitle>
            <MeetingDescription>string</MeetingDescription>
            <MeetingParticipants>string</MeetingParticipants>
            <MeetingType>Calendar or Manual</MeetingType>
            <ReasonResponseFullPath>string</ReasonResponseFullPath>
            <ReasonResponseFreeText>string</ReasonResponseFreeText>
          </WorkFlowReportItem>
          <WorkFlowReportItem>
            <FirstName>string</FirstName>
            <LastName>string</LastName>
            <UserId>int</UserId>
            <TaskName>string</TaskName>
            <TaskId>int</TaskId>
            <ParentTaskNames xsi:nil="true" />
            <ParentWorkerGroupNames xsi:nil="true" />
            <StartDate>dateTime</StartDate>
            <EndDate>dateTime</EndDate>
            <WorkFlowReportItemType>PC or Mobile or Ivr or Manual or Meeting or MobileCallWithWorkTime or MobileCallWithoutWorkTime or ReasonResponse or BusyTime</WorkFlowReportItemType>
            <ActiveTimeInMillisecond>long</ActiveTimeInMillisecond>
            <InactiveTimeInMillisecond>long</InactiveTimeInMillisecond>
            <WorktimeModificationDescription>string</WorktimeModificationDescription>
            <PhoneNumber>string</PhoneNumber>
            <MobileContactName>string</MobileContactName>
            <IsInbound>boolean</IsInbound>
            <MeetingTitle>string</MeetingTitle>
            <MeetingDescription>string</MeetingDescription>
            <MeetingParticipants>string</MeetingParticipants>
            <MeetingType>Calendar or Manual</MeetingType>
            <ReasonResponseFullPath>string</ReasonResponseFullPath>
            <ReasonResponseFreeText>string</ReasonResponseFreeText>
          </WorkFlowReportItem>
        </WorkFlowView>
      </Report>
    </GetWorkflowReportResponse>
  </soap12:Body>
</soap12:Envelope>