Home / API / ASP.NET Web API Details

GET api/v1/WorkOrder/GetContractListByStartDateRange?from={from}&to={to}&companyid={companyid}

Description

Get Contract List By Start DateRange

Request Information

Parameters

NameDescriptionAdditional information
from
From Date

Define this parameter in the request URI.

to
To Date

Define this parameter in the request URI.

companyid
CompanyID

Define this parameter in the request URI.

Response Information

List of Contracts by DateRange

Response body formats

application/json, text/json

Sample:
[
  {
    "account": {
      "accountnumber": "sample string 1",
      "mainaccountnumber": "sample string 2",
      "accounttype": 3
    },
    "servicecustomer": {
      "id": 1,
      "businessname": "sample string 2",
      "salutation": "sample string 3",
      "firstname": "sample string 4",
      "lastname": "sample string 5",
      "contactdescription": "sample string 6",
      "contactphonenumber": "sample string 7",
      "phonenumber1": "sample string 8",
      "phonenumber2": "sample string 9"
    },
    "serviceaddress": {
      "id": 1,
      "streetnumber": "sample string 1",
      "predirection": "sample string 2",
      "streetname": "sample string 3",
      "streetsuffix": "sample string 4",
      "postdirection": "sample string 5",
      "secondaryaddress": "sample string 6",
      "city": "sample string 7",
      "state": "sample string 8",
      "postalcode": "sample string 9",
      "postalcodeex": "sample string 10",
      "deliverypoint": "sample string 11",
      "checkdigit": "sample string 12",
      "instructions": "sample string 13",
      "directions": "sample string 14"
    },
    "billingcustomer": {
      "id": 1,
      "businessname": "sample string 2",
      "salutation": "sample string 3",
      "firstname": "sample string 4",
      "lastname": "sample string 5",
      "contactdescription": "sample string 6",
      "contactphonenumber": "sample string 7",
      "emailaddress": "sample string 8"
    },
    "billingaddress": {
      "id": 1,
      "streetnumber": "sample string 1",
      "predirection": "sample string 2",
      "streetname": "sample string 3",
      "streetsuffix": "sample string 4",
      "postdirection": "sample string 5",
      "secondaryaddress": "sample string 6",
      "city": "sample string 7",
      "state": "sample string 8",
      "postalcode": "sample string 9",
      "postalcodeex": "sample string 10",
      "deliverypoint": "sample string 11",
      "checkdigit": "sample string 12"
    },
    "program": {
      "name": "sample string 1",
      "type": 2,
      "id": 3,
      "startdate": "2025-02-23T06:32:10.9811756+00:00",
      "notes": "sample string 4",
      "price": 1.0,
      "renewalamount": 1.0,
      "foundationtype": "sample string 5",
      "salesperson": "sample string 6",
      "salespersonnumber": "sample string 7",
      "source": "sample string 8",
      "material": "sample string 9"
    },
    "workorder": {
      "id": 1,
      "scheduleddate": "2025-02-23T06:32:10.9968213+00:00",
      "eventname": "sample string 2",
      "emloyeeid": 1,
      "employeename": "sample string 3",
      "employeenumber": "sample string 4",
      "certificationnum": "sample string 5",
      "jobinstructions": "sample string 6",
      "targetpest": "sample string 7"
    }
  },
  {
    "account": {
      "accountnumber": "sample string 1",
      "mainaccountnumber": "sample string 2",
      "accounttype": 3
    },
    "servicecustomer": {
      "id": 1,
      "businessname": "sample string 2",
      "salutation": "sample string 3",
      "firstname": "sample string 4",
      "lastname": "sample string 5",
      "contactdescription": "sample string 6",
      "contactphonenumber": "sample string 7",
      "phonenumber1": "sample string 8",
      "phonenumber2": "sample string 9"
    },
    "serviceaddress": {
      "id": 1,
      "streetnumber": "sample string 1",
      "predirection": "sample string 2",
      "streetname": "sample string 3",
      "streetsuffix": "sample string 4",
      "postdirection": "sample string 5",
      "secondaryaddress": "sample string 6",
      "city": "sample string 7",
      "state": "sample string 8",
      "postalcode": "sample string 9",
      "postalcodeex": "sample string 10",
      "deliverypoint": "sample string 11",
      "checkdigit": "sample string 12",
      "instructions": "sample string 13",
      "directions": "sample string 14"
    },
    "billingcustomer": {
      "id": 1,
      "businessname": "sample string 2",
      "salutation": "sample string 3",
      "firstname": "sample string 4",
      "lastname": "sample string 5",
      "contactdescription": "sample string 6",
      "contactphonenumber": "sample string 7",
      "emailaddress": "sample string 8"
    },
    "billingaddress": {
      "id": 1,
      "streetnumber": "sample string 1",
      "predirection": "sample string 2",
      "streetname": "sample string 3",
      "streetsuffix": "sample string 4",
      "postdirection": "sample string 5",
      "secondaryaddress": "sample string 6",
      "city": "sample string 7",
      "state": "sample string 8",
      "postalcode": "sample string 9",
      "postalcodeex": "sample string 10",
      "deliverypoint": "sample string 11",
      "checkdigit": "sample string 12"
    },
    "program": {
      "name": "sample string 1",
      "type": 2,
      "id": 3,
      "startdate": "2025-02-23T06:32:10.9811756+00:00",
      "notes": "sample string 4",
      "price": 1.0,
      "renewalamount": 1.0,
      "foundationtype": "sample string 5",
      "salesperson": "sample string 6",
      "salespersonnumber": "sample string 7",
      "source": "sample string 8",
      "material": "sample string 9"
    },
    "workorder": {
      "id": 1,
      "scheduleddate": "2025-02-23T06:32:10.9968213+00:00",
      "eventname": "sample string 2",
      "emloyeeid": 1,
      "employeename": "sample string 3",
      "employeenumber": "sample string 4",
      "certificationnum": "sample string 5",
      "jobinstructions": "sample string 6",
      "targetpest": "sample string 7"
    }
  }
]

application/xml, text/xml

Sample:
<ArrayOfcontractlistbydaterangemodels xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APICOMMON">
  <contractlistbydaterangemodels>
    <account>
      <accountnumber>sample string 1</accountnumber>
      <accounttype>3</accounttype>
      <mainaccountnumber>sample string 2</mainaccountnumber>
    </account>
    <billingaddress>
      <checkdigit>sample string 12</checkdigit>
      <city>sample string 7</city>
      <deliverypoint>sample string 11</deliverypoint>
      <id>1</id>
      <postalcode>sample string 9</postalcode>
      <postalcodeex>sample string 10</postalcodeex>
      <postdirection>sample string 5</postdirection>
      <predirection>sample string 2</predirection>
      <secondaryaddress>sample string 6</secondaryaddress>
      <state>sample string 8</state>
      <streetname>sample string 3</streetname>
      <streetnumber>sample string 1</streetnumber>
      <streetsuffix>sample string 4</streetsuffix>
    </billingaddress>
    <billingcustomer>
      <businessname>sample string 2</businessname>
      <contactdescription>sample string 6</contactdescription>
      <contactphonenumber>sample string 7</contactphonenumber>
      <emailaddress>sample string 8</emailaddress>
      <firstname>sample string 4</firstname>
      <id>1</id>
      <lastname>sample string 5</lastname>
      <salutation>sample string 3</salutation>
    </billingcustomer>
    <program>
      <foundationtype>sample string 5</foundationtype>
      <id>3</id>
      <material>sample string 9</material>
      <name>sample string 1</name>
      <notes>sample string 4</notes>
      <price>1</price>
      <renewalamount>1</renewalamount>
      <salesperson>sample string 6</salesperson>
      <salespersonnumber>sample string 7</salespersonnumber>
      <source>sample string 8</source>
      <startdate>2025-02-23T06:32:10.9811756+00:00</startdate>
      <type>2</type>
    </program>
    <serviceaddress>
      <checkdigit>sample string 12</checkdigit>
      <city>sample string 7</city>
      <deliverypoint>sample string 11</deliverypoint>
      <directions>sample string 14</directions>
      <id>1</id>
      <instructions>sample string 13</instructions>
      <postalcode>sample string 9</postalcode>
      <postalcodeex>sample string 10</postalcodeex>
      <postdirection>sample string 5</postdirection>
      <predirection>sample string 2</predirection>
      <secondaryaddress>sample string 6</secondaryaddress>
      <state>sample string 8</state>
      <streetname>sample string 3</streetname>
      <streetnumber>sample string 1</streetnumber>
      <streetsuffix>sample string 4</streetsuffix>
    </serviceaddress>
    <servicecustomer>
      <businessname>sample string 2</businessname>
      <contactdescription>sample string 6</contactdescription>
      <contactphonenumber>sample string 7</contactphonenumber>
      <firstname>sample string 4</firstname>
      <id>1</id>
      <lastname>sample string 5</lastname>
      <phonenumber1>sample string 8</phonenumber1>
      <phonenumber2>sample string 9</phonenumber2>
      <salutation>sample string 3</salutation>
    </servicecustomer>
    <workorder>
      <certificationnum>sample string 5</certificationnum>
      <emloyeeid>1</emloyeeid>
      <employeename>sample string 3</employeename>
      <employeenumber>sample string 4</employeenumber>
      <eventname>sample string 2</eventname>
      <id>1</id>
      <jobinstructions>sample string 6</jobinstructions>
      <scheduleddate>2025-02-23T06:32:10.9968213+00:00</scheduleddate>
      <targetpest>sample string 7</targetpest>
    </workorder>
  </contractlistbydaterangemodels>
  <contractlistbydaterangemodels>
    <account>
      <accountnumber>sample string 1</accountnumber>
      <accounttype>3</accounttype>
      <mainaccountnumber>sample string 2</mainaccountnumber>
    </account>
    <billingaddress>
      <checkdigit>sample string 12</checkdigit>
      <city>sample string 7</city>
      <deliverypoint>sample string 11</deliverypoint>
      <id>1</id>
      <postalcode>sample string 9</postalcode>
      <postalcodeex>sample string 10</postalcodeex>
      <postdirection>sample string 5</postdirection>
      <predirection>sample string 2</predirection>
      <secondaryaddress>sample string 6</secondaryaddress>
      <state>sample string 8</state>
      <streetname>sample string 3</streetname>
      <streetnumber>sample string 1</streetnumber>
      <streetsuffix>sample string 4</streetsuffix>
    </billingaddress>
    <billingcustomer>
      <businessname>sample string 2</businessname>
      <contactdescription>sample string 6</contactdescription>
      <contactphonenumber>sample string 7</contactphonenumber>
      <emailaddress>sample string 8</emailaddress>
      <firstname>sample string 4</firstname>
      <id>1</id>
      <lastname>sample string 5</lastname>
      <salutation>sample string 3</salutation>
    </billingcustomer>
    <program>
      <foundationtype>sample string 5</foundationtype>
      <id>3</id>
      <material>sample string 9</material>
      <name>sample string 1</name>
      <notes>sample string 4</notes>
      <price>1</price>
      <renewalamount>1</renewalamount>
      <salesperson>sample string 6</salesperson>
      <salespersonnumber>sample string 7</salespersonnumber>
      <source>sample string 8</source>
      <startdate>2025-02-23T06:32:10.9811756+00:00</startdate>
      <type>2</type>
    </program>
    <serviceaddress>
      <checkdigit>sample string 12</checkdigit>
      <city>sample string 7</city>
      <deliverypoint>sample string 11</deliverypoint>
      <directions>sample string 14</directions>
      <id>1</id>
      <instructions>sample string 13</instructions>
      <postalcode>sample string 9</postalcode>
      <postalcodeex>sample string 10</postalcodeex>
      <postdirection>sample string 5</postdirection>
      <predirection>sample string 2</predirection>
      <secondaryaddress>sample string 6</secondaryaddress>
      <state>sample string 8</state>
      <streetname>sample string 3</streetname>
      <streetnumber>sample string 1</streetnumber>
      <streetsuffix>sample string 4</streetsuffix>
    </serviceaddress>
    <servicecustomer>
      <businessname>sample string 2</businessname>
      <contactdescription>sample string 6</contactdescription>
      <contactphonenumber>sample string 7</contactphonenumber>
      <firstname>sample string 4</firstname>
      <id>1</id>
      <lastname>sample string 5</lastname>
      <phonenumber1>sample string 8</phonenumber1>
      <phonenumber2>sample string 9</phonenumber2>
      <salutation>sample string 3</salutation>
    </servicecustomer>
    <workorder>
      <certificationnum>sample string 5</certificationnum>
      <emloyeeid>1</emloyeeid>
      <employeename>sample string 3</employeename>
      <employeenumber>sample string 4</employeenumber>
      <eventname>sample string 2</eventname>
      <id>1</id>
      <jobinstructions>sample string 6</jobinstructions>
      <scheduleddate>2025-02-23T06:32:10.9968213+00:00</scheduleddate>
      <targetpest>sample string 7</targetpest>
    </workorder>
  </contractlistbydaterangemodels>
</ArrayOfcontractlistbydaterangemodels>