POST clients/getclient

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Username	string	Required
SearchWord	string	Required
DivisionID	integer	Required
TenantId	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "Username": "sample string 1",
  "SearchWord": "sample string 2",
  "DivisionID": 3,
  "TenantId": 4
}

text/html

Sample:

{"Username":"sample string 1","SearchWord":"sample string 2","DivisionID":3,"TenantId":4}

application/xml, text/xml

Sample:

<ClientSearchModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ListenerOnline.ListenerWebAPI.Models">
  <DivisionID>3</DivisionID>
  <SearchWord>sample string 2</SearchWord>
  <TenantId>4</TenantId>
  <Username>sample string 1</Username>
</ClientSearchModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ClientSearchModel'.

Response Information

Resource Description

ClientViewModel

Name	Type	Additional information
CustID	integer	None.
ContractType	string	None.
CustDesc	string	None.
CustCode	string	None.
Title	string	None.
FirstNames	string	None.
Surname	string	None.
BusinessName	string	None.
IsActive	boolean	None.
ClientType	integer	None.
PremisesType	integer	None.
TenantID	integer	None.
PasswordEnc	string	None.
IDNumber	string	None.
IDType	string	None.
MarketingPreferenceId	integer	None.
Salutation	string	None.
ClientSubType	integer	None.
AddressAllocationDivision	integer	None.
VATnumber	string	None.
AddressId	integer	None.
BuildingNo	string	None.
BuildingName	string	None.
StreetNo	string	None.
StreetName	string	None.
StreetType	integer	None.
Suburb	integer	None.
SuburbName	string	None.
Town	string	None.
PostalCode	string	None.
AreaPostalCode	string	None.
Province	integer	None.
Country	integer	None.
StandNo	string	None.
Division	integer	None.
SubDivision	integer	None.
MainArea	integer	None.
SubArea	integer	None.
Latitude	decimal number	None.
Longitude	decimal number	None.
GPSDate	date	None.
isAuthenticated	boolean	None.
GPS_Confirmed	boolean	None.
TecArea	integer	None.
AEFlag	boolean	None.
AEType	integer	None.
AENumber	string	None.
AEStreet	string	None.
AEBuildingName	string	None.
PhysicalAddress	string	None.
Directions	string	None.
RovingAddress	boolean	None.
AEDescription	string	None.
Fire	string	None.
Police	string	None.
Medical	string	None.
Matrix	Collection of RxGisArea	None.
InstallationDate	string	None.
InstalledBy	integer	None.
ServicedBy	integer	None.
PanelId	integer	None.
GuaranteePeriod	integer	None.
GuaranteeEnd	date	None.
ContactId	integer	None.
ContactType	integer	None.
Cell	string	None.
PremisesPh	string	None.
ContactPh	string	None.
Email	string	None.
FaxNo	string	None.
isSMSNo	boolean	None.
SMSNo	string	None.
LanguageId	integer	None.
ControlPassword	string	None.
PostalAddress1	string	None.
PostalAddress2	string	None.
PostalAddress3	string	None.
PostalAddress4	string	None.
LinkOnlyClient	boolean	None.
NotepadFlag	boolean	None.
HolidayInstFlag	string	None.
OperatorInstFlag	boolean	None.
ResponseInstFlag	boolean	None.
EventMemoFlag	boolean	None.
DirectionsFlag	boolean	None.
SMSNoEnabled	boolean	None.
CancelDate	date	None.
SuspendMode	boolean	None.
SuspendReason	string	None.
PostalSameAsPhysical	boolean	None.
ClientTypeId	integer	None.
ResponseInstructions	string	None.
OperatorInstructions	string	None.
HolidayInstructions	string	None.
MedicalInstructions	string	None.
NormalisedInstructions	boolean	None.
smyClientType	string	None.
smyClientSubType	string	None.
smyClientStatus	string	None.
RequestId	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "CustID": 1,
  "ContractType": "sample string 2",
  "CustDesc": "sample string 3",
  "CustCode": "sample string 4",
  "Title": "sample string 5",
  "FirstNames": "sample string 6",
  "Surname": "sample string 7",
  "BusinessName": "sample string 8",
  "IsActive": true,
  "ClientType": 10,
  "PremisesType": 11,
  "TenantID": 12,
  "PasswordEnc": "sample string 13",
  "IDNumber": "sample string 14",
  "IDType": "sample string 15",
  "MarketingPreferenceId": 1,
  "Salutation": "sample string 16",
  "ClientSubType": 1,
  "AddressAllocationDivision": 17,
  "VATnumber": "sample string 18",
  "AddressId": 19,
  "BuildingNo": "sample string 20",
  "BuildingName": "sample string 21",
  "StreetNo": "sample string 22",
  "StreetName": "sample string 23",
  "StreetType": 1,
  "Suburb": 1,
  "SuburbName": "sample string 24",
  "Town": "sample string 25",
  "PostalCode": "sample string 26",
  "AreaPostalCode": "sample string 27",
  "Province": 1,
  "Country": 1,
  "StandNo": "sample string 28",
  "Division": 29,
  "SubDivision": 30,
  "MainArea": 31,
  "SubArea": 32,
  "Latitude": 1.0,
  "Longitude": 1.0,
  "GPSDate": "2026-04-17T11:35:32.6215566+00:00",
  "isAuthenticated": true,
  "GPS_Confirmed": true,
  "TecArea": 34,
  "AEFlag": true,
  "AEType": 1,
  "AENumber": "sample string 36",
  "AEStreet": "sample string 37",
  "AEBuildingName": "sample string 38",
  "PhysicalAddress": "sample string 39",
  "Directions": "sample string 40",
  "RovingAddress": true,
  "AEDescription": "sample string 41",
  "Fire": "sample string 42",
  "Police": "sample string 43",
  "Medical": "sample string 44",
  "Matrix": [
    {
      "AreaId": 1,
      "AreaName": "sample string 2",
      "GroupId": 3,
      "AreaType": "sample string 4",
      "GroupName": "sample string 5",
      "AreaTypeId": 6
    },
    {
      "AreaId": 1,
      "AreaName": "sample string 2",
      "GroupId": 3,
      "AreaType": "sample string 4",
      "GroupName": "sample string 5",
      "AreaTypeId": 6
    }
  ],
  "InstallationDate": "sample string 45",
  "InstalledBy": 1,
  "ServicedBy": 1,
  "PanelId": 1,
  "GuaranteePeriod": 1,
  "GuaranteeEnd": "2026-04-17T11:35:32.6215566+00:00",
  "ContactId": 46,
  "ContactType": 47,
  "Cell": "sample string 48",
  "PremisesPh": "sample string 49",
  "ContactPh": "sample string 50",
  "Email": "sample string 51",
  "FaxNo": "sample string 52",
  "isSMSNo": true,
  "SMSNo": "sample string 54",
  "LanguageId": 1,
  "ControlPassword": "sample string 55",
  "PostalAddress1": "sample string 56",
  "PostalAddress2": "sample string 57",
  "PostalAddress3": "sample string 58",
  "PostalAddress4": "sample string 59",
  "LinkOnlyClient": true,
  "NotepadFlag": true,
  "HolidayInstFlag": "sample string 60",
  "OperatorInstFlag": true,
  "ResponseInstFlag": true,
  "EventMemoFlag": true,
  "DirectionsFlag": true,
  "SMSNoEnabled": true,
  "CancelDate": "2026-04-17T11:35:32.6215566+00:00",
  "SuspendMode": true,
  "SuspendReason": "sample string 61",
  "PostalSameAsPhysical": true,
  "ClientTypeId": 1,
  "ResponseInstructions": "sample string 62",
  "OperatorInstructions": "sample string 63",
  "HolidayInstructions": "sample string 64",
  "MedicalInstructions": "sample string 65",
  "NormalisedInstructions": true,
  "smyClientType": "sample string 67",
  "smyClientSubType": "sample string 68",
  "smyClientStatus": "sample string 69",
  "RequestId": 1
}

text/html

Sample:

{"CustID":1,"ContractType":"sample string 2","CustDesc":"sample string 3","CustCode":"sample string 4","Title":"sample string 5","FirstNames":"sample string 6","Surname":"sample string 7","BusinessName":"sample string 8","IsActive":true,"ClientType":10,"PremisesType":11,"TenantID":12,"PasswordEnc":"sample string 13","IDNumber":"sample string 14","IDType":"sample string 15","MarketingPreferenceId":1,"Salutation":"sample string 16","ClientSubType":1,"AddressAllocationDivision":17,"VATnumber":"sample string 18","AddressId":19,"BuildingNo":"sample string 20","BuildingName":"sample string 21","StreetNo":"sample string 22","StreetName":"sample string 23","StreetType":1,"Suburb":1,"SuburbName":"sample string 24","Town":"sample string 25","PostalCode":"sample string 26","AreaPostalCode":"sample string 27","Province":1,"Country":1,"StandNo":"sample string 28","Division":29,"SubDivision":30,"MainArea":31,"SubArea":32,"Latitude":1.0,"Longitude":1.0,"GPSDate":"2026-04-17T11:35:32.6215566+00:00","isAuthenticated":true,"GPS_Confirmed":true,"TecArea":34,"AEFlag":true,"AEType":1,"AENumber":"sample string 36","AEStreet":"sample string 37","AEBuildingName":"sample string 38","PhysicalAddress":"sample string 39","Directions":"sample string 40","RovingAddress":true,"AEDescription":"sample string 41","Fire":"sample string 42","Police":"sample string 43","Medical":"sample string 44","Matrix":[{"AreaId":1,"AreaName":"sample string 2","GroupId":3,"AreaType":"sample string 4","GroupName":"sample string 5","AreaTypeId":6},{"AreaId":1,"AreaName":"sample string 2","GroupId":3,"AreaType":"sample string 4","GroupName":"sample string 5","AreaTypeId":6}],"InstallationDate":"sample string 45","InstalledBy":1,"ServicedBy":1,"PanelId":1,"GuaranteePeriod":1,"GuaranteeEnd":"2026-04-17T11:35:32.6215566+00:00","ContactId":46,"ContactType":47,"Cell":"sample string 48","PremisesPh":"sample string 49","ContactPh":"sample string 50","Email":"sample string 51","FaxNo":"sample string 52","isSMSNo":true,"SMSNo":"sample string 54","LanguageId":1,"ControlPassword":"sample string 55","PostalAddress1":"sample string 56","PostalAddress2":"sample string 57","PostalAddress3":"sample string 58","PostalAddress4":"sample string 59","LinkOnlyClient":true,"NotepadFlag":true,"HolidayInstFlag":"sample string 60","OperatorInstFlag":true,"ResponseInstFlag":true,"EventMemoFlag":true,"DirectionsFlag":true,"SMSNoEnabled":true,"CancelDate":"2026-04-17T11:35:32.6215566+00:00","SuspendMode":true,"SuspendReason":"sample string 61","PostalSameAsPhysical":true,"ClientTypeId":1,"ResponseInstructions":"sample string 62","OperatorInstructions":"sample string 63","HolidayInstructions":"sample string 64","MedicalInstructions":"sample string 65","NormalisedInstructions":true,"smyClientType":"sample string 67","smyClientSubType":"sample string 68","smyClientStatus":"sample string 69","RequestId":1}

application/xml, text/xml

Sample:

<ClientViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ListenerOnline.BusinessEntities.Clients">
  <AEBuildingName>sample string 38</AEBuildingName>
  <AEDescription>sample string 41</AEDescription>
  <AEFlag>true</AEFlag>
  <AENumber>sample string 36</AENumber>
  <AEStreet>sample string 37</AEStreet>
  <AEType>1</AEType>
  <AddressAllocationDivision>17</AddressAllocationDivision>
  <AddressId>19</AddressId>
  <AreaPostalCode>sample string 27</AreaPostalCode>
  <BuildingName>sample string 21</BuildingName>
  <BuildingNo>sample string 20</BuildingNo>
  <BusinessName>sample string 8</BusinessName>
  <CancelDate>2026-04-17T11:35:32.6215566+00:00</CancelDate>
  <Cell>sample string 48</Cell>
  <ClientSubType>1</ClientSubType>
  <ClientType>10</ClientType>
  <ClientTypeId>1</ClientTypeId>
  <ContactId>46</ContactId>
  <ContactPh>sample string 50</ContactPh>
  <ContactType>47</ContactType>
  <ContractType>sample string 2</ContractType>
  <ControlPassword>sample string 55</ControlPassword>
  <Country>1</Country>
  <CustCode>sample string 4</CustCode>
  <CustDesc>sample string 3</CustDesc>
  <CustID>1</CustID>
  <Directions>sample string 40</Directions>
  <DirectionsFlag>true</DirectionsFlag>
  <Division>29</Division>
  <Email>sample string 51</Email>
  <EventMemoFlag>true</EventMemoFlag>
  <FaxNo>sample string 52</FaxNo>
  <Fire>sample string 42</Fire>
  <FirstNames>sample string 6</FirstNames>
  <GPSDate>2026-04-17T11:35:32.6215566+00:00</GPSDate>
  <GPS_Confirmed>true</GPS_Confirmed>
  <GuaranteeEnd>2026-04-17T11:35:32.6215566+00:00</GuaranteeEnd>
  <GuaranteePeriod>1</GuaranteePeriod>
  <HolidayInstFlag>sample string 60</HolidayInstFlag>
  <HolidayInstructions>sample string 64</HolidayInstructions>
  <IDNumber>sample string 14</IDNumber>
  <IDType>sample string 15</IDType>
  <InstallationDate>sample string 45</InstallationDate>
  <InstalledBy>1</InstalledBy>
  <IsActive>true</IsActive>
  <LanguageId>1</LanguageId>
  <Latitude>1</Latitude>
  <LinkOnlyClient>true</LinkOnlyClient>
  <Longitude>1</Longitude>
  <MainArea>31</MainArea>
  <MarketingPreferenceId>1</MarketingPreferenceId>
  <Matrix xmlns:d2p1="http://schemas.datacontract.org/2004/07/ListenerOnline.BusinessEntities.Areas">
    <d2p1:RxGisArea>
      <d2p1:AreaId>1</d2p1:AreaId>
      <d2p1:AreaName>sample string 2</d2p1:AreaName>
      <d2p1:AreaType>sample string 4</d2p1:AreaType>
      <d2p1:AreaTypeId>6</d2p1:AreaTypeId>
      <d2p1:GroupId>3</d2p1:GroupId>
      <d2p1:GroupName>sample string 5</d2p1:GroupName>
    </d2p1:RxGisArea>
    <d2p1:RxGisArea>
      <d2p1:AreaId>1</d2p1:AreaId>
      <d2p1:AreaName>sample string 2</d2p1:AreaName>
      <d2p1:AreaType>sample string 4</d2p1:AreaType>
      <d2p1:AreaTypeId>6</d2p1:AreaTypeId>
      <d2p1:GroupId>3</d2p1:GroupId>
      <d2p1:GroupName>sample string 5</d2p1:GroupName>
    </d2p1:RxGisArea>
  </Matrix>
  <Medical>sample string 44</Medical>
  <MedicalInstructions>sample string 65</MedicalInstructions>
  <NormalisedInstructions>true</NormalisedInstructions>
  <NotepadFlag>true</NotepadFlag>
  <OperatorInstFlag>true</OperatorInstFlag>
  <OperatorInstructions>sample string 63</OperatorInstructions>
  <PanelId>1</PanelId>
  <PasswordEnc>sample string 13</PasswordEnc>
  <PhysicalAddress>sample string 39</PhysicalAddress>
  <Police>sample string 43</Police>
  <PostalAddress1>sample string 56</PostalAddress1>
  <PostalAddress2>sample string 57</PostalAddress2>
  <PostalAddress3>sample string 58</PostalAddress3>
  <PostalAddress4>sample string 59</PostalAddress4>
  <PostalCode>sample string 26</PostalCode>
  <PostalSameAsPhysical>true</PostalSameAsPhysical>
  <PremisesPh>sample string 49</PremisesPh>
  <PremisesType>11</PremisesType>
  <Province>1</Province>
  <RequestId>1</RequestId>
  <ResponseInstFlag>true</ResponseInstFlag>
  <ResponseInstructions>sample string 62</ResponseInstructions>
  <RovingAddress>true</RovingAddress>
  <SMSNo>sample string 54</SMSNo>
  <SMSNoEnabled>true</SMSNoEnabled>
  <Salutation>sample string 16</Salutation>
  <ServicedBy>1</ServicedBy>
  <StandNo>sample string 28</StandNo>
  <StreetName>sample string 23</StreetName>
  <StreetNo>sample string 22</StreetNo>
  <StreetType>1</StreetType>
  <SubArea>32</SubArea>
  <SubDivision>30</SubDivision>
  <Suburb>1</Suburb>
  <SuburbName>sample string 24</SuburbName>
  <Surname>sample string 7</Surname>
  <SuspendMode>true</SuspendMode>
  <SuspendReason>sample string 61</SuspendReason>
  <TecArea>34</TecArea>
  <TenantID>12</TenantID>
  <Title>sample string 5</Title>
  <Town>sample string 25</Town>
  <VATnumber>sample string 18</VATnumber>
  <isAuthenticated>true</isAuthenticated>
  <isSMSNo>true</isSMSNo>
  <smyClientStatus>sample string 69</smyClientStatus>
  <smyClientSubType>sample string 68</smyClientSubType>
  <smyClientType>sample string 67</smyClientType>
</ClientViewModel>