GET api/Client/Worksite?clientId={clientId}&pageNumber={pageNumber}&pageSize={pageSize}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
clientId

integer

Default value is 0

pageNumber

integer

Default value is 1

pageSize

integer

Default value is 100

Body Parameters

None.

Response Information

Resource Description

Collection of ClWorksiteAddressDTO
NameDescriptionTypeAdditional information
ClWorksiteAddressId

integer

None.

DefaultWorksiteAddressId

integer

None.

ClientId

integer

None.

AgClientId

integer

None.

LocationName

string

None.

Notes

string

None.

IsActive

boolean

None.

IsDefault

boolean

None.

TimezoneId

integer

None.

MailAddress1

string

None.

MailAddress2

string

None.

MailZip

string

None.

MailCity

string

None.

MailStateName

string

None.

MailStateId

integer

None.

MailLatitude

decimal number

None.

MailLongitude

decimal number

None.

IsShipSameAsMail

boolean

None.

ShipAddress1

string

None.

ShipAddress2

string

None.

ShipZip

string

None.

ShipCity

string

None.

ShipStateId

integer

None.

IsBillSameAsMail

boolean

None.

BillAddress1

string

None.

BillAddress2

string

None.

BillZip

string

None.

BillCity

string

None.

BillStateId

integer

None.

Address

string

None.

AgRetailerId

integer

None.

RetailerName

string

None.

IsRetailerActive

boolean

None.

IsGeoFenceAddress

boolean

None.

GeoFenceRadius

integer

None.

GeoFenceLocationId

integer

None.

WorksiteAddressType

integer

None.

IsVMSAddress

boolean

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "ClWorksiteAddressId": 1,
    "DefaultWorksiteAddressId": 2,
    "ClientId": 1,
    "AgClientId": 3,
    "LocationName": "sample string 4",
    "Notes": "sample string 5",
    "IsActive": true,
    "IsDefault": true,
    "TimezoneId": 8,
    "MailAddress1": "sample string 9",
    "MailAddress2": "sample string 10",
    "MailZip": "sample string 11",
    "MailCity": "sample string 12",
    "MailStateName": "sample string 13",
    "MailStateId": 1,
    "MailLatitude": 1.0,
    "MailLongitude": 1.0,
    "IsShipSameAsMail": true,
    "ShipAddress1": "sample string 15",
    "ShipAddress2": "sample string 16",
    "ShipZip": "sample string 17",
    "ShipCity": "sample string 18",
    "ShipStateId": 1,
    "IsBillSameAsMail": true,
    "BillAddress1": "sample string 20",
    "BillAddress2": "sample string 21",
    "BillZip": "sample string 22",
    "BillCity": "sample string 23",
    "BillStateId": 1,
    "Address": "sample string 24",
    "AgRetailerId": 1,
    "RetailerName": "sample string 25",
    "IsRetailerActive": true,
    "IsGeoFenceAddress": true,
    "GeoFenceRadius": 1,
    "GeoFenceLocationId": 1,
    "WorksiteAddressType": 28,
    "IsVMSAddress": true
  },
  {
    "ClWorksiteAddressId": 1,
    "DefaultWorksiteAddressId": 2,
    "ClientId": 1,
    "AgClientId": 3,
    "LocationName": "sample string 4",
    "Notes": "sample string 5",
    "IsActive": true,
    "IsDefault": true,
    "TimezoneId": 8,
    "MailAddress1": "sample string 9",
    "MailAddress2": "sample string 10",
    "MailZip": "sample string 11",
    "MailCity": "sample string 12",
    "MailStateName": "sample string 13",
    "MailStateId": 1,
    "MailLatitude": 1.0,
    "MailLongitude": 1.0,
    "IsShipSameAsMail": true,
    "ShipAddress1": "sample string 15",
    "ShipAddress2": "sample string 16",
    "ShipZip": "sample string 17",
    "ShipCity": "sample string 18",
    "ShipStateId": 1,
    "IsBillSameAsMail": true,
    "BillAddress1": "sample string 20",
    "BillAddress2": "sample string 21",
    "BillZip": "sample string 22",
    "BillCity": "sample string 23",
    "BillStateId": 1,
    "Address": "sample string 24",
    "AgRetailerId": 1,
    "RetailerName": "sample string 25",
    "IsRetailerActive": true,
    "IsGeoFenceAddress": true,
    "GeoFenceRadius": 1,
    "GeoFenceLocationId": 1,
    "WorksiteAddressType": 28,
    "IsVMSAddress": true
  }
]

application/xml, text/xml

Sample:
<ArrayOfClWorksiteAddressDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WurkNowDTO">
  <ClWorksiteAddressDTO>
    <Address>sample string 24</Address>
    <AgClientId>3</AgClientId>
    <AgRetailerId>1</AgRetailerId>
    <BillAddress1>sample string 20</BillAddress1>
    <BillAddress2>sample string 21</BillAddress2>
    <BillCity>sample string 23</BillCity>
    <BillStateId>1</BillStateId>
    <BillZip>sample string 22</BillZip>
    <ClWorksiteAddressId>1</ClWorksiteAddressId>
    <ClientId>1</ClientId>
    <DefaultWorksiteAddressId>2</DefaultWorksiteAddressId>
    <GeoFenceLocationId>1</GeoFenceLocationId>
    <GeoFenceRadius>1</GeoFenceRadius>
    <IsActive>true</IsActive>
    <IsBillSameAsMail>true</IsBillSameAsMail>
    <IsDefault>true</IsDefault>
    <IsGeoFenceAddress>true</IsGeoFenceAddress>
    <IsRetailerActive>true</IsRetailerActive>
    <IsShipSameAsMail>true</IsShipSameAsMail>
    <IsVMSAddress>true</IsVMSAddress>
    <LocationName>sample string 4</LocationName>
    <MailAddress1>sample string 9</MailAddress1>
    <MailAddress2>sample string 10</MailAddress2>
    <MailCity>sample string 12</MailCity>
    <MailLatitude>1</MailLatitude>
    <MailLongitude>1</MailLongitude>
    <MailStateId>1</MailStateId>
    <MailStateName>sample string 13</MailStateName>
    <MailZip>sample string 11</MailZip>
    <Notes>sample string 5</Notes>
    <RetailerName>sample string 25</RetailerName>
    <ShipAddress1>sample string 15</ShipAddress1>
    <ShipAddress2>sample string 16</ShipAddress2>
    <ShipCity>sample string 18</ShipCity>
    <ShipStateId>1</ShipStateId>
    <ShipZip>sample string 17</ShipZip>
    <TimezoneId>8</TimezoneId>
    <WorksiteAddressType>28</WorksiteAddressType>
  </ClWorksiteAddressDTO>
  <ClWorksiteAddressDTO>
    <Address>sample string 24</Address>
    <AgClientId>3</AgClientId>
    <AgRetailerId>1</AgRetailerId>
    <BillAddress1>sample string 20</BillAddress1>
    <BillAddress2>sample string 21</BillAddress2>
    <BillCity>sample string 23</BillCity>
    <BillStateId>1</BillStateId>
    <BillZip>sample string 22</BillZip>
    <ClWorksiteAddressId>1</ClWorksiteAddressId>
    <ClientId>1</ClientId>
    <DefaultWorksiteAddressId>2</DefaultWorksiteAddressId>
    <GeoFenceLocationId>1</GeoFenceLocationId>
    <GeoFenceRadius>1</GeoFenceRadius>
    <IsActive>true</IsActive>
    <IsBillSameAsMail>true</IsBillSameAsMail>
    <IsDefault>true</IsDefault>
    <IsGeoFenceAddress>true</IsGeoFenceAddress>
    <IsRetailerActive>true</IsRetailerActive>
    <IsShipSameAsMail>true</IsShipSameAsMail>
    <IsVMSAddress>true</IsVMSAddress>
    <LocationName>sample string 4</LocationName>
    <MailAddress1>sample string 9</MailAddress1>
    <MailAddress2>sample string 10</MailAddress2>
    <MailCity>sample string 12</MailCity>
    <MailLatitude>1</MailLatitude>
    <MailLongitude>1</MailLongitude>
    <MailStateId>1</MailStateId>
    <MailStateName>sample string 13</MailStateName>
    <MailZip>sample string 11</MailZip>
    <Notes>sample string 5</Notes>
    <RetailerName>sample string 25</RetailerName>
    <ShipAddress1>sample string 15</ShipAddress1>
    <ShipAddress2>sample string 16</ShipAddress2>
    <ShipCity>sample string 18</ShipCity>
    <ShipStateId>1</ShipStateId>
    <ShipZip>sample string 17</ShipZip>
    <TimezoneId>8</TimezoneId>
    <WorksiteAddressType>28</WorksiteAddressType>
  </ClWorksiteAddressDTO>
</ArrayOfClWorksiteAddressDTO>