POST clients/searchclient

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

Collection of ClientSearchResult

Name	Type	Additional information
CustCode	string	None.
Salutation	string	None.
PhysicalAddress	string	None.
Cell	string	None.
LandLine	string	None.
Presmises	string	None.
FirstNames	string	None.
Surname	string	None.
CustId	integer	None.
CustDesc	string	None.
CurrentLead	boolean	None.
ObjectId	integer	None.
Status	string	None.
Included	boolean	None.
SearchNo	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "CustCode": "sample string 1",
    "Salutation": "sample string 2",
    "PhysicalAddress": "sample string 3",
    "Cell": "sample string 4",
    "LandLine": "sample string 5",
    "Presmises": "sample string 6",
    "FirstNames": "sample string 7",
    "Surname": "sample string 8",
    "CustId": 9,
    "CustDesc": "sample string 10",
    "CurrentLead": true,
    "ObjectId": 12,
    "Status": "sample string 13",
    "Included": true,
    "SearchNo": 15
  },
  {
    "CustCode": "sample string 1",
    "Salutation": "sample string 2",
    "PhysicalAddress": "sample string 3",
    "Cell": "sample string 4",
    "LandLine": "sample string 5",
    "Presmises": "sample string 6",
    "FirstNames": "sample string 7",
    "Surname": "sample string 8",
    "CustId": 9,
    "CustDesc": "sample string 10",
    "CurrentLead": true,
    "ObjectId": 12,
    "Status": "sample string 13",
    "Included": true,
    "SearchNo": 15
  }
]

text/html

Sample:

[{"CustCode":"sample string 1","Salutation":"sample string 2","PhysicalAddress":"sample string 3","Cell":"sample string 4","LandLine":"sample string 5","Presmises":"sample string 6","FirstNames":"sample string 7","Surname":"sample string 8","CustId":9,"CustDesc":"sample string 10","CurrentLead":true,"ObjectId":12,"Status":"sample string 13","Included":true,"SearchNo":15},{"CustCode":"sample string 1","Salutation":"sample string 2","PhysicalAddress":"sample string 3","Cell":"sample string 4","LandLine":"sample string 5","Presmises":"sample string 6","FirstNames":"sample string 7","Surname":"sample string 8","CustId":9,"CustDesc":"sample string 10","CurrentLead":true,"ObjectId":12,"Status":"sample string 13","Included":true,"SearchNo":15}]

application/xml, text/xml

Sample:

<ArrayOfClientSearchResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ListenerOnline.BusinessEntities.Clients">
  <ClientSearchResult>
    <Cell>sample string 4</Cell>
    <CurrentLead>true</CurrentLead>
    <CustCode>sample string 1</CustCode>
    <CustDesc>sample string 10</CustDesc>
    <CustId>9</CustId>
    <FirstNames>sample string 7</FirstNames>
    <Included>true</Included>
    <LandLine>sample string 5</LandLine>
    <ObjectId>12</ObjectId>
    <PhysicalAddress>sample string 3</PhysicalAddress>
    <Presmises>sample string 6</Presmises>
    <Salutation>sample string 2</Salutation>
    <SearchNo>15</SearchNo>
    <Status>sample string 13</Status>
    <Surname>sample string 8</Surname>
  </ClientSearchResult>
  <ClientSearchResult>
    <Cell>sample string 4</Cell>
    <CurrentLead>true</CurrentLead>
    <CustCode>sample string 1</CustCode>
    <CustDesc>sample string 10</CustDesc>
    <CustId>9</CustId>
    <FirstNames>sample string 7</FirstNames>
    <Included>true</Included>
    <LandLine>sample string 5</LandLine>
    <ObjectId>12</ObjectId>
    <PhysicalAddress>sample string 3</PhysicalAddress>
    <Presmises>sample string 6</Presmises>
    <Salutation>sample string 2</Salutation>
    <SearchNo>15</SearchNo>
    <Status>sample string 13</Status>
    <Surname>sample string 8</Surname>
  </ClientSearchResult>
</ArrayOfClientSearchResult>