WorkOrder

Click here for a complete list of operations.

GetDetail

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 /SOAP/WorkOrder.asmx HTTP/1.1
Host: api.oneguard.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.oneguard.net/workOrder/GetDetail"

<?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>
    <GetDetail xmlns="http://api.oneguard.net/workOrder">
      <number>int</number>
    </GetDetail>
  </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>
    <GetDetailResponse xmlns="http://api.oneguard.net/workOrder">
      <GetDetailResult>
        <Id>guid</Id>
        <PolicyId>guid</PolicyId>
        <CreatedDate>dateTime</CreatedDate>
        <Number>int</Number>
        <Type>string</Type>
        <Item>string</Item>
        <Trade>string</Trade>
        <Property>
          <Id>guid</Id>
          <StreetAddress>string</StreetAddress>
          <Unit>string</Unit>
          <City>string</City>
          <State>string</State>
          <ZipCode>string</ZipCode>
          <AgeOfHome>int</AgeOfHome>
          <Zone>string</Zone>
          <Market>string</Market>
        </Property>
        <Contact>
          <Id>guid</Id>
          <Name>string</Name>
          <Company>string</Company>
          <Email>string</Email>
          <Phone>string</Phone>
          <Phone2>string</Phone2>
          <Notes>string</Notes>
          <PreferredContactMethod>string</PreferredContactMethod>
          <ContactType>string</ContactType>
        </Contact>
        <PropertyOwner>
          <Id>guid</Id>
          <Name>string</Name>
          <Company>string</Company>
          <Email>string</Email>
          <Phone>string</Phone>
          <Phone2>string</Phone2>
          <Notes>string</Notes>
          <PreferredContactMethod>string</PreferredContactMethod>
          <ContactType>string</ContactType>
        </PropertyOwner>
        <PropertyManager>
          <Id>guid</Id>
          <Name>string</Name>
          <Company>string</Company>
          <Email>string</Email>
          <Phone>string</Phone>
          <Phone2>string</Phone2>
          <Notes>string</Notes>
          <PreferredContactMethod>string</PreferredContactMethod>
          <ContactType>string</ContactType>
        </PropertyManager>
        <Upgrades>
          <ContractDetail>
            <Name>string</Name>
            <Covered>string</Covered>
            <NotCovered>string</NotCovered>
            <Limits>string</Limits>
          </ContractDetail>
          <ContractDetail>
            <Name>string</Name>
            <Covered>string</Covered>
            <NotCovered>string</NotCovered>
            <Limits>string</Limits>
          </ContractDetail>
        </Upgrades>
        <Options>
          <ContractDetail>
            <Name>string</Name>
            <Covered>string</Covered>
            <NotCovered>string</NotCovered>
            <Limits>string</Limits>
          </ContractDetail>
          <ContractDetail>
            <Name>string</Name>
            <Covered>string</Covered>
            <NotCovered>string</NotCovered>
            <Limits>string</Limits>
          </ContractDetail>
        </Options>
        <FirstYearPolicy>boolean</FirstYearPolicy>
        <CollectServiceFee>boolean</CollectServiceFee>
        <ServiceFee>decimal</ServiceFee>
        <Appointment>
          <Status>string</Status>
          <ScheduledDate>dateTime</ScheduledDate>
          <StartWindow>string</StartWindow>
          <EndWindow>string</EndWindow>
          <TechnicianName>string</TechnicianName>
          <TechnicianEmail>string</TechnicianEmail>
          <TechnicianPhone>string</TechnicianPhone>
        </Appointment>
        <QuestionsAndAnswers>
          <QuestionAndAnswer>
            <Q>string</Q>
            <A>string</A>
          </QuestionAndAnswer>
          <QuestionAndAnswer>
            <Q>string</Q>
            <A>string</A>
          </QuestionAndAnswer>
        </QuestionsAndAnswers>
        <ItemContract>
          <Name>string</Name>
          <Covered>string</Covered>
          <NotCovered>string</NotCovered>
          <Limits>string</Limits>
        </ItemContract>
        <CustomerR22Rate>decimal</CustomerR22Rate>
        <OneGuardR22Rate>decimal</OneGuardR22Rate>
        <CustomerR410ARate>decimal</CustomerR410ARate>
        <OneGuardR410ARate>decimal</OneGuardR410ARate>
        <AdditionalNotes>string</AdditionalNotes>
      </GetDetailResult>
    </GetDetailResponse>
  </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 /SOAP/WorkOrder.asmx HTTP/1.1
Host: api.oneguard.net
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>
    <GetDetail xmlns="http://api.oneguard.net/workOrder">
      <number>int</number>
    </GetDetail>
  </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>
    <GetDetailResponse xmlns="http://api.oneguard.net/workOrder">
      <GetDetailResult>
        <Id>guid</Id>
        <PolicyId>guid</PolicyId>
        <CreatedDate>dateTime</CreatedDate>
        <Number>int</Number>
        <Type>string</Type>
        <Item>string</Item>
        <Trade>string</Trade>
        <Property>
          <Id>guid</Id>
          <StreetAddress>string</StreetAddress>
          <Unit>string</Unit>
          <City>string</City>
          <State>string</State>
          <ZipCode>string</ZipCode>
          <AgeOfHome>int</AgeOfHome>
          <Zone>string</Zone>
          <Market>string</Market>
        </Property>
        <Contact>
          <Id>guid</Id>
          <Name>string</Name>
          <Company>string</Company>
          <Email>string</Email>
          <Phone>string</Phone>
          <Phone2>string</Phone2>
          <Notes>string</Notes>
          <PreferredContactMethod>string</PreferredContactMethod>
          <ContactType>string</ContactType>
        </Contact>
        <PropertyOwner>
          <Id>guid</Id>
          <Name>string</Name>
          <Company>string</Company>
          <Email>string</Email>
          <Phone>string</Phone>
          <Phone2>string</Phone2>
          <Notes>string</Notes>
          <PreferredContactMethod>string</PreferredContactMethod>
          <ContactType>string</ContactType>
        </PropertyOwner>
        <PropertyManager>
          <Id>guid</Id>
          <Name>string</Name>
          <Company>string</Company>
          <Email>string</Email>
          <Phone>string</Phone>
          <Phone2>string</Phone2>
          <Notes>string</Notes>
          <PreferredContactMethod>string</PreferredContactMethod>
          <ContactType>string</ContactType>
        </PropertyManager>
        <Upgrades>
          <ContractDetail>
            <Name>string</Name>
            <Covered>string</Covered>
            <NotCovered>string</NotCovered>
            <Limits>string</Limits>
          </ContractDetail>
          <ContractDetail>
            <Name>string</Name>
            <Covered>string</Covered>
            <NotCovered>string</NotCovered>
            <Limits>string</Limits>
          </ContractDetail>
        </Upgrades>
        <Options>
          <ContractDetail>
            <Name>string</Name>
            <Covered>string</Covered>
            <NotCovered>string</NotCovered>
            <Limits>string</Limits>
          </ContractDetail>
          <ContractDetail>
            <Name>string</Name>
            <Covered>string</Covered>
            <NotCovered>string</NotCovered>
            <Limits>string</Limits>
          </ContractDetail>
        </Options>
        <FirstYearPolicy>boolean</FirstYearPolicy>
        <CollectServiceFee>boolean</CollectServiceFee>
        <ServiceFee>decimal</ServiceFee>
        <Appointment>
          <Status>string</Status>
          <ScheduledDate>dateTime</ScheduledDate>
          <StartWindow>string</StartWindow>
          <EndWindow>string</EndWindow>
          <TechnicianName>string</TechnicianName>
          <TechnicianEmail>string</TechnicianEmail>
          <TechnicianPhone>string</TechnicianPhone>
        </Appointment>
        <QuestionsAndAnswers>
          <QuestionAndAnswer>
            <Q>string</Q>
            <A>string</A>
          </QuestionAndAnswer>
          <QuestionAndAnswer>
            <Q>string</Q>
            <A>string</A>
          </QuestionAndAnswer>
        </QuestionsAndAnswers>
        <ItemContract>
          <Name>string</Name>
          <Covered>string</Covered>
          <NotCovered>string</NotCovered>
          <Limits>string</Limits>
        </ItemContract>
        <CustomerR22Rate>decimal</CustomerR22Rate>
        <OneGuardR22Rate>decimal</OneGuardR22Rate>
        <CustomerR410ARate>decimal</CustomerR410ARate>
        <OneGuardR410ARate>decimal</OneGuardR410ARate>
        <AdditionalNotes>string</AdditionalNotes>
      </GetDetailResult>
    </GetDetailResponse>
  </soap12:Body>
</soap12:Envelope>