H2OAPIv20 Web Service

H2OAPIv20

Click here for a complete list of operations.

Tasks_Query

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 /v20/default.asmx HTTP/1.1
Host: api.rev.io
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.myh2o.com/v20/Tasks_Query"

<?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>
    <Tasks_Query xmlns="http://api.myh2o.com/v20">
      <Request>
        <Credentials>
          <Username>string</Username>
          <Password>string</Password>
          <Client>string</Client>
          <ImpersonationKey>string</ImpersonationKey>
        </Credentials>
        <Session>
          <SessionKey>string</SessionKey>
        </Session>
        <Debug>boolean</Debug>
        <TaskID>int</TaskID>
        <TaskID>int</TaskID>
        <BillProfileID>int</BillProfileID>
        <BillProfileID>int</BillProfileID>
        <CustomerID>int</CustomerID>
        <CustomerID>int</CustomerID>
        <TaskTypeID>int</TaskTypeID>
        <TaskTypeID>int</TaskTypeID>
        <TaskWorkflowID>int</TaskWorkflowID>
        <TaskWorkflowID>int</TaskWorkflowID>
        <OrderID>int</OrderID>
        <OrderID>int</OrderID>
        <WorkOrderID>int</WorkOrderID>
        <WorkOrderID>int</WorkOrderID>
        <TicketID>int</TicketID>
        <TicketID>int</TicketID>
        <AssignedTo>int</AssignedTo>
        <AssignedTo>int</AssignedTo>
        <Canceled_Flag>boolean</Canceled_Flag>
        <Completed_Flag>boolean</Completed_Flag>
      </Request>
    </Tasks_Query>
  </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>
    <Tasks_QueryResponse xmlns="http://api.myh2o.com/v20">
      <Tasks_QueryResult>
        <Header>
          <Success>boolean</Success>
          <Message>string</Message>
          <SessionKey>string</SessionKey>
          <Impersonated>boolean</Impersonated>
          <Error_Code>string</Error_Code>
          <Error_Description>string</Error_Description>
        </Header>
        <Debug>
          <Request>
            <Credentials>
              <Username>string</Username>
              <Password>string</Password>
              <Client>string</Client>
              <ImpersonationKey>string</ImpersonationKey>
            </Credentials>
            <Session>
              <SessionKey>string</SessionKey>
            </Session>
            <Debug>boolean</Debug>
            <TaskID>int</TaskID>
            <TaskID>int</TaskID>
            <BillProfileID>int</BillProfileID>
            <BillProfileID>int</BillProfileID>
            <CustomerID>int</CustomerID>
            <CustomerID>int</CustomerID>
            <TaskTypeID>int</TaskTypeID>
            <TaskTypeID>int</TaskTypeID>
            <TaskWorkflowID>int</TaskWorkflowID>
            <TaskWorkflowID>int</TaskWorkflowID>
            <OrderID>int</OrderID>
            <OrderID>int</OrderID>
            <WorkOrderID>int</WorkOrderID>
            <WorkOrderID>int</WorkOrderID>
            <TicketID>int</TicketID>
            <TicketID>int</TicketID>
            <AssignedTo>int</AssignedTo>
            <AssignedTo>int</AssignedTo>
            <Canceled_Flag>boolean</Canceled_Flag>
            <Completed_Flag>boolean</Completed_Flag>
          </Request>
        </Debug>
        <Tasks>
          <Task>
            <Task_ID>int</Task_ID>
            <Customer_ID>int</Customer_ID>
            <Ticket_ID>int</Ticket_ID>
            <Order_ID>int</Order_ID>
            <Work_Order_ID>int</Work_Order_ID>
            <Task_Workflow_ID>int</Task_Workflow_ID>
            <Task_Type_ID>int</Task_Type_ID>
            <Subject>string</Subject>
            <Message>string</Message>
            <Assigned_To>int</Assigned_To>
            <Due_Date>dateTime</Due_Date>
            <Complete>boolean</Complete>
            <Completed_Date>dateTime</Completed_Date>
            <Created_Date>dateTime</Created_Date>
            <Created_By>int</Created_By>
            <Canceled_Flag>boolean</Canceled_Flag>
          </Task>
          <Task>
            <Task_ID>int</Task_ID>
            <Customer_ID>int</Customer_ID>
            <Ticket_ID>int</Ticket_ID>
            <Order_ID>int</Order_ID>
            <Work_Order_ID>int</Work_Order_ID>
            <Task_Workflow_ID>int</Task_Workflow_ID>
            <Task_Type_ID>int</Task_Type_ID>
            <Subject>string</Subject>
            <Message>string</Message>
            <Assigned_To>int</Assigned_To>
            <Due_Date>dateTime</Due_Date>
            <Complete>boolean</Complete>
            <Completed_Date>dateTime</Completed_Date>
            <Created_Date>dateTime</Created_Date>
            <Created_By>int</Created_By>
            <Canceled_Flag>boolean</Canceled_Flag>
          </Task>
        </Tasks>
      </Tasks_QueryResult>
    </Tasks_QueryResponse>
  </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 /v20/default.asmx HTTP/1.1
Host: api.rev.io
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>
    <Tasks_Query xmlns="http://api.myh2o.com/v20">
      <Request>
        <Credentials>
          <Username>string</Username>
          <Password>string</Password>
          <Client>string</Client>
          <ImpersonationKey>string</ImpersonationKey>
        </Credentials>
        <Session>
          <SessionKey>string</SessionKey>
        </Session>
        <Debug>boolean</Debug>
        <TaskID>int</TaskID>
        <TaskID>int</TaskID>
        <BillProfileID>int</BillProfileID>
        <BillProfileID>int</BillProfileID>
        <CustomerID>int</CustomerID>
        <CustomerID>int</CustomerID>
        <TaskTypeID>int</TaskTypeID>
        <TaskTypeID>int</TaskTypeID>
        <TaskWorkflowID>int</TaskWorkflowID>
        <TaskWorkflowID>int</TaskWorkflowID>
        <OrderID>int</OrderID>
        <OrderID>int</OrderID>
        <WorkOrderID>int</WorkOrderID>
        <WorkOrderID>int</WorkOrderID>
        <TicketID>int</TicketID>
        <TicketID>int</TicketID>
        <AssignedTo>int</AssignedTo>
        <AssignedTo>int</AssignedTo>
        <Canceled_Flag>boolean</Canceled_Flag>
        <Completed_Flag>boolean</Completed_Flag>
      </Request>
    </Tasks_Query>
  </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>
    <Tasks_QueryResponse xmlns="http://api.myh2o.com/v20">
      <Tasks_QueryResult>
        <Header>
          <Success>boolean</Success>
          <Message>string</Message>
          <SessionKey>string</SessionKey>
          <Impersonated>boolean</Impersonated>
          <Error_Code>string</Error_Code>
          <Error_Description>string</Error_Description>
        </Header>
        <Debug>
          <Request>
            <Credentials>
              <Username>string</Username>
              <Password>string</Password>
              <Client>string</Client>
              <ImpersonationKey>string</ImpersonationKey>
            </Credentials>
            <Session>
              <SessionKey>string</SessionKey>
            </Session>
            <Debug>boolean</Debug>
            <TaskID>int</TaskID>
            <TaskID>int</TaskID>
            <BillProfileID>int</BillProfileID>
            <BillProfileID>int</BillProfileID>
            <CustomerID>int</CustomerID>
            <CustomerID>int</CustomerID>
            <TaskTypeID>int</TaskTypeID>
            <TaskTypeID>int</TaskTypeID>
            <TaskWorkflowID>int</TaskWorkflowID>
            <TaskWorkflowID>int</TaskWorkflowID>
            <OrderID>int</OrderID>
            <OrderID>int</OrderID>
            <WorkOrderID>int</WorkOrderID>
            <WorkOrderID>int</WorkOrderID>
            <TicketID>int</TicketID>
            <TicketID>int</TicketID>
            <AssignedTo>int</AssignedTo>
            <AssignedTo>int</AssignedTo>
            <Canceled_Flag>boolean</Canceled_Flag>
            <Completed_Flag>boolean</Completed_Flag>
          </Request>
        </Debug>
        <Tasks>
          <Task>
            <Task_ID>int</Task_ID>
            <Customer_ID>int</Customer_ID>
            <Ticket_ID>int</Ticket_ID>
            <Order_ID>int</Order_ID>
            <Work_Order_ID>int</Work_Order_ID>
            <Task_Workflow_ID>int</Task_Workflow_ID>
            <Task_Type_ID>int</Task_Type_ID>
            <Subject>string</Subject>
            <Message>string</Message>
            <Assigned_To>int</Assigned_To>
            <Due_Date>dateTime</Due_Date>
            <Complete>boolean</Complete>
            <Completed_Date>dateTime</Completed_Date>
            <Created_Date>dateTime</Created_Date>
            <Created_By>int</Created_By>
            <Canceled_Flag>boolean</Canceled_Flag>
          </Task>
          <Task>
            <Task_ID>int</Task_ID>
            <Customer_ID>int</Customer_ID>
            <Ticket_ID>int</Ticket_ID>
            <Order_ID>int</Order_ID>
            <Work_Order_ID>int</Work_Order_ID>
            <Task_Workflow_ID>int</Task_Workflow_ID>
            <Task_Type_ID>int</Task_Type_ID>
            <Subject>string</Subject>
            <Message>string</Message>
            <Assigned_To>int</Assigned_To>
            <Due_Date>dateTime</Due_Date>
            <Complete>boolean</Complete>
            <Completed_Date>dateTime</Completed_Date>
            <Created_Date>dateTime</Created_Date>
            <Created_By>int</Created_By>
            <Canceled_Flag>boolean</Canceled_Flag>
          </Task>
        </Tasks>
      </Tasks_QueryResult>
    </Tasks_QueryResponse>
  </soap12:Body>
</soap12:Envelope>