PublicAPIService Web Service

PublicAPIService

Click here for a complete list of operations.

AddMultipleCalls

This function will add multiple service calls to the same work order. If calls.WorkOrder is provided system will attempt to use that number to create the work order.

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 /PIP/PublicAPIService.asmx HTTP/1.1
Host: einfo.lbm-sharp.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://digitalgateway.com/WebServices/PublicAPIService/AddMultipleCalls"

<?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>
    <AddMultipleCalls xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <calls>
        <WorkOrder>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </WorkOrder>
        <Calls>
          <CallData>
            <CallDate xsi:nil="true" />
            <ReqDate xsi:nil="true" />
            <EstStartDate xsi:nil="true" />
            <EstDuration xsi:nil="true" />
            <CallNumber xsi:nil="true" />
            <WorkOrderNumber xsi:nil="true" />
            <WorkOrderRemarks xsi:nil="true" />
            <StatusCode xsi:nil="true" />
            <HoldCode xsi:nil="true" />
            <BillCode xsi:nil="true" />
            <CallType xsi:nil="true" />
            <Caller xsi:nil="true" />
            <Description xsi:nil="true" />
            <TermCode xsi:nil="true" />
            <TerritoryCode xsi:nil="true" />
            <TechnicianNumber xsi:nil="true" />
            <Notes xsi:nil="true" />
            <PriorityCode xsi:nil="true" />
            <PONumber xsi:nil="true" />
            <PORequired xsi:nil="true" />
            <CloseDate xsi:nil="true" />
            <IncompleteDescription xsi:nil="true" />
            <IncompleteCode xsi:nil="true" />
            <IncompleteRequiredDate xsi:nil="true" />
            <IncompleteDeliveryMethod xsi:nil="true" />
            <Rank xsi:nil="true" />
            <WarrantyDate xsi:nil="true" />
            <PreventativeMaintenance xsi:nil="true" />
            <CancelCode xsi:nil="true" />
            <CancelDescription xsi:nil="true" />
            <MiscCharge xsi:nil="true" />
            <MiscDescription xsi:nil="true" />
            <StandardOffsetFromGMT xsi:nil="true" />
            <JobID xsi:nil="true" />
            <CustomerNumber xsi:nil="true" />
            <BillToNumber xsi:nil="true" />
            <CustomerName xsi:nil="true" />
            <Address xsi:nil="true" />
            <City xsi:nil="true" />
            <State xsi:nil="true" />
            <Zip xsi:nil="true" />
            <Phone1 xsi:nil="true" />
            <Phone2 xsi:nil="true" />
            <Fax xsi:nil="true" />
            <Country xsi:nil="true" />
            <CallerContact xsi:nil="true" />
            <UseUnknownEquipment xsi:nil="true" />
            <EquipmentNumber xsi:nil="true" />
            <Model xsi:nil="true" />
            <SerialNumber xsi:nil="true" />
            <AvgMonthlyVolume3Mo xsi:nil="true" />
            <EquipmentContact xsi:nil="true" />
            <EquipmentLocation xsi:nil="true" />
            <ContractNumber xsi:nil="true" />
            <UseContractInfo xsi:nil="true" />
            <Dispatched xsi:nil="true" />
            <Callback xsi:nil="true" />
            <User>string</User>
            <NoteCount>int</NoteCount>
            <NoteID>int</NoteID>
            <MaterialsUsed xsi:nil="true" />
            <MaterialsNeeded xsi:nil="true" />
            <ProblemCodes xsi:nil="true" />
            <RepairCodes xsi:nil="true" />
            <Labors xsi:nil="true" />
            <Meters xsi:nil="true" />
          </CallData>
          <CallData>
            <CallDate xsi:nil="true" />
            <ReqDate xsi:nil="true" />
            <EstStartDate xsi:nil="true" />
            <EstDuration xsi:nil="true" />
            <CallNumber xsi:nil="true" />
            <WorkOrderNumber xsi:nil="true" />
            <WorkOrderRemarks xsi:nil="true" />
            <StatusCode xsi:nil="true" />
            <HoldCode xsi:nil="true" />
            <BillCode xsi:nil="true" />
            <CallType xsi:nil="true" />
            <Caller xsi:nil="true" />
            <Description xsi:nil="true" />
            <TermCode xsi:nil="true" />
            <TerritoryCode xsi:nil="true" />
            <TechnicianNumber xsi:nil="true" />
            <Notes xsi:nil="true" />
            <PriorityCode xsi:nil="true" />
            <PONumber xsi:nil="true" />
            <PORequired xsi:nil="true" />
            <CloseDate xsi:nil="true" />
            <IncompleteDescription xsi:nil="true" />
            <IncompleteCode xsi:nil="true" />
            <IncompleteRequiredDate xsi:nil="true" />
            <IncompleteDeliveryMethod xsi:nil="true" />
            <Rank xsi:nil="true" />
            <WarrantyDate xsi:nil="true" />
            <PreventativeMaintenance xsi:nil="true" />
            <CancelCode xsi:nil="true" />
            <CancelDescription xsi:nil="true" />
            <MiscCharge xsi:nil="true" />
            <MiscDescription xsi:nil="true" />
            <StandardOffsetFromGMT xsi:nil="true" />
            <JobID xsi:nil="true" />
            <CustomerNumber xsi:nil="true" />
            <BillToNumber xsi:nil="true" />
            <CustomerName xsi:nil="true" />
            <Address xsi:nil="true" />
            <City xsi:nil="true" />
            <State xsi:nil="true" />
            <Zip xsi:nil="true" />
            <Phone1 xsi:nil="true" />
            <Phone2 xsi:nil="true" />
            <Fax xsi:nil="true" />
            <Country xsi:nil="true" />
            <CallerContact xsi:nil="true" />
            <UseUnknownEquipment xsi:nil="true" />
            <EquipmentNumber xsi:nil="true" />
            <Model xsi:nil="true" />
            <SerialNumber xsi:nil="true" />
            <AvgMonthlyVolume3Mo xsi:nil="true" />
            <EquipmentContact xsi:nil="true" />
            <EquipmentLocation xsi:nil="true" />
            <ContractNumber xsi:nil="true" />
            <UseContractInfo xsi:nil="true" />
            <Dispatched xsi:nil="true" />
            <Callback xsi:nil="true" />
            <User>string</User>
            <NoteCount>int</NoteCount>
            <NoteID>int</NoteID>
            <MaterialsUsed xsi:nil="true" />
            <MaterialsNeeded xsi:nil="true" />
            <ProblemCodes xsi:nil="true" />
            <RepairCodes xsi:nil="true" />
            <Labors xsi:nil="true" />
            <Meters xsi:nil="true" />
          </CallData>
        </Calls>
      </calls>
      <optOpenTimeOverride>
        <Value>dateTime</Value>
        <ValueAsString>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </ValueAsString>
        <Valid>boolean</Valid>
      </optOpenTimeOverride>
    </AddMultipleCalls>
  </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>
    <AddMultipleCallsResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <AddMultipleCallsResult>
        <ID>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </ID>
        <Code>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Code>
      </AddMultipleCallsResult>
    </AddMultipleCallsResponse>
  </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 /PIP/PublicAPIService.asmx HTTP/1.1
Host: einfo.lbm-sharp.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>
    <AddMultipleCalls xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <calls>
        <WorkOrder>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </WorkOrder>
        <Calls>
          <CallData>
            <CallDate xsi:nil="true" />
            <ReqDate xsi:nil="true" />
            <EstStartDate xsi:nil="true" />
            <EstDuration xsi:nil="true" />
            <CallNumber xsi:nil="true" />
            <WorkOrderNumber xsi:nil="true" />
            <WorkOrderRemarks xsi:nil="true" />
            <StatusCode xsi:nil="true" />
            <HoldCode xsi:nil="true" />
            <BillCode xsi:nil="true" />
            <CallType xsi:nil="true" />
            <Caller xsi:nil="true" />
            <Description xsi:nil="true" />
            <TermCode xsi:nil="true" />
            <TerritoryCode xsi:nil="true" />
            <TechnicianNumber xsi:nil="true" />
            <Notes xsi:nil="true" />
            <PriorityCode xsi:nil="true" />
            <PONumber xsi:nil="true" />
            <PORequired xsi:nil="true" />
            <CloseDate xsi:nil="true" />
            <IncompleteDescription xsi:nil="true" />
            <IncompleteCode xsi:nil="true" />
            <IncompleteRequiredDate xsi:nil="true" />
            <IncompleteDeliveryMethod xsi:nil="true" />
            <Rank xsi:nil="true" />
            <WarrantyDate xsi:nil="true" />
            <PreventativeMaintenance xsi:nil="true" />
            <CancelCode xsi:nil="true" />
            <CancelDescription xsi:nil="true" />
            <MiscCharge xsi:nil="true" />
            <MiscDescription xsi:nil="true" />
            <StandardOffsetFromGMT xsi:nil="true" />
            <JobID xsi:nil="true" />
            <CustomerNumber xsi:nil="true" />
            <BillToNumber xsi:nil="true" />
            <CustomerName xsi:nil="true" />
            <Address xsi:nil="true" />
            <City xsi:nil="true" />
            <State xsi:nil="true" />
            <Zip xsi:nil="true" />
            <Phone1 xsi:nil="true" />
            <Phone2 xsi:nil="true" />
            <Fax xsi:nil="true" />
            <Country xsi:nil="true" />
            <CallerContact xsi:nil="true" />
            <UseUnknownEquipment xsi:nil="true" />
            <EquipmentNumber xsi:nil="true" />
            <Model xsi:nil="true" />
            <SerialNumber xsi:nil="true" />
            <AvgMonthlyVolume3Mo xsi:nil="true" />
            <EquipmentContact xsi:nil="true" />
            <EquipmentLocation xsi:nil="true" />
            <ContractNumber xsi:nil="true" />
            <UseContractInfo xsi:nil="true" />
            <Dispatched xsi:nil="true" />
            <Callback xsi:nil="true" />
            <User>string</User>
            <NoteCount>int</NoteCount>
            <NoteID>int</NoteID>
            <MaterialsUsed xsi:nil="true" />
            <MaterialsNeeded xsi:nil="true" />
            <ProblemCodes xsi:nil="true" />
            <RepairCodes xsi:nil="true" />
            <Labors xsi:nil="true" />
            <Meters xsi:nil="true" />
          </CallData>
          <CallData>
            <CallDate xsi:nil="true" />
            <ReqDate xsi:nil="true" />
            <EstStartDate xsi:nil="true" />
            <EstDuration xsi:nil="true" />
            <CallNumber xsi:nil="true" />
            <WorkOrderNumber xsi:nil="true" />
            <WorkOrderRemarks xsi:nil="true" />
            <StatusCode xsi:nil="true" />
            <HoldCode xsi:nil="true" />
            <BillCode xsi:nil="true" />
            <CallType xsi:nil="true" />
            <Caller xsi:nil="true" />
            <Description xsi:nil="true" />
            <TermCode xsi:nil="true" />
            <TerritoryCode xsi:nil="true" />
            <TechnicianNumber xsi:nil="true" />
            <Notes xsi:nil="true" />
            <PriorityCode xsi:nil="true" />
            <PONumber xsi:nil="true" />
            <PORequired xsi:nil="true" />
            <CloseDate xsi:nil="true" />
            <IncompleteDescription xsi:nil="true" />
            <IncompleteCode xsi:nil="true" />
            <IncompleteRequiredDate xsi:nil="true" />
            <IncompleteDeliveryMethod xsi:nil="true" />
            <Rank xsi:nil="true" />
            <WarrantyDate xsi:nil="true" />
            <PreventativeMaintenance xsi:nil="true" />
            <CancelCode xsi:nil="true" />
            <CancelDescription xsi:nil="true" />
            <MiscCharge xsi:nil="true" />
            <MiscDescription xsi:nil="true" />
            <StandardOffsetFromGMT xsi:nil="true" />
            <JobID xsi:nil="true" />
            <CustomerNumber xsi:nil="true" />
            <BillToNumber xsi:nil="true" />
            <CustomerName xsi:nil="true" />
            <Address xsi:nil="true" />
            <City xsi:nil="true" />
            <State xsi:nil="true" />
            <Zip xsi:nil="true" />
            <Phone1 xsi:nil="true" />
            <Phone2 xsi:nil="true" />
            <Fax xsi:nil="true" />
            <Country xsi:nil="true" />
            <CallerContact xsi:nil="true" />
            <UseUnknownEquipment xsi:nil="true" />
            <EquipmentNumber xsi:nil="true" />
            <Model xsi:nil="true" />
            <SerialNumber xsi:nil="true" />
            <AvgMonthlyVolume3Mo xsi:nil="true" />
            <EquipmentContact xsi:nil="true" />
            <EquipmentLocation xsi:nil="true" />
            <ContractNumber xsi:nil="true" />
            <UseContractInfo xsi:nil="true" />
            <Dispatched xsi:nil="true" />
            <Callback xsi:nil="true" />
            <User>string</User>
            <NoteCount>int</NoteCount>
            <NoteID>int</NoteID>
            <MaterialsUsed xsi:nil="true" />
            <MaterialsNeeded xsi:nil="true" />
            <ProblemCodes xsi:nil="true" />
            <RepairCodes xsi:nil="true" />
            <Labors xsi:nil="true" />
            <Meters xsi:nil="true" />
          </CallData>
        </Calls>
      </calls>
      <optOpenTimeOverride>
        <Value>dateTime</Value>
        <ValueAsString>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </ValueAsString>
        <Valid>boolean</Valid>
      </optOpenTimeOverride>
    </AddMultipleCalls>
  </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>
    <AddMultipleCallsResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <AddMultipleCallsResult>
        <ID>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </ID>
        <Code>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Code>
      </AddMultipleCallsResult>
    </AddMultipleCallsResponse>
  </soap12:Body>
</soap12:Envelope>