POST clients/SearchClientByPhone

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
DivisionID	integer	None.
SearchType	string	None.
SearchOptions	Collection of string	None.
PhoneNumber	string	None.
ContactName	string	None.
CpContactUsername	string	None.
CapCode	string	None.
PagerLastName	string	None.
PagerFirstName	string	None.
StandardQueryOptions	StandardQueryOptions	None.
PageNo	integer	None.
TenantId	integer	None.
IsPortalClient	boolean	None.
IsActiveCpUser	boolean	None.
IsRegisteredCpUser	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "DivisionID": 1,
  "SearchType": "sample string 2",
  "SearchOptions": [
    "sample string 1",
    "sample string 2"
  ],
  "PhoneNumber": "sample string 3",
  "ContactName": "sample string 4",
  "CpContactUsername": "sample string 5",
  "CapCode": "sample string 6",
  "PagerLastName": "sample string 7",
  "PagerFirstName": "sample string 8",
  "StandardQueryOptions": {
    "IncludeUnknownRadios": true,
    "ExcludeLostRadioFile": true,
    "ExcludeRepairRadioFile": true,
    "ExcludeStockRadioFile": true,
    "SearchforRadiosWithTransmittersX": true,
    "UseExactMatchWhenSearching": true,
    "UseAllSearchCriteriaWhenSelecting": true,
    "SiteType": 8
  },
  "PageNo": 1,
  "TenantId": 9,
  "IsPortalClient": true,
  "IsActiveCpUser": true,
  "IsRegisteredCpUser": true
}

text/html

Sample:

{"DivisionID":1,"SearchType":"sample string 2","SearchOptions":["sample string 1","sample string 2"],"PhoneNumber":"sample string 3","ContactName":"sample string 4","CpContactUsername":"sample string 5","CapCode":"sample string 6","PagerLastName":"sample string 7","PagerFirstName":"sample string 8","StandardQueryOptions":{"IncludeUnknownRadios":true,"ExcludeLostRadioFile":true,"ExcludeRepairRadioFile":true,"ExcludeStockRadioFile":true,"SearchforRadiosWithTransmittersX":true,"UseExactMatchWhenSearching":true,"UseAllSearchCriteriaWhenSelecting":true,"SiteType":8},"PageNo":1,"TenantId":9,"IsPortalClient":true,"IsActiveCpUser":true,"IsRegisteredCpUser":true}

application/xml, text/xml

Sample:

<PhoneSearch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ListenerOnline.BusinessEntities.PhoneNumbers">
  <CapCode>sample string 6</CapCode>
  <ContactName>sample string 4</ContactName>
  <CpContactUsername>sample string 5</CpContactUsername>
  <DivisionID>1</DivisionID>
  <IsActiveCpUser>true</IsActiveCpUser>
  <IsPortalClient>true</IsPortalClient>
  <IsRegisteredCpUser>true</IsRegisteredCpUser>
  <PageNo>1</PageNo>
  <PagerFirstName>sample string 8</PagerFirstName>
  <PagerLastName>sample string 7</PagerLastName>
  <PhoneNumber>sample string 3</PhoneNumber>
  <SearchOptions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </SearchOptions>
  <SearchType>sample string 2</SearchType>
  <StandardQueryOptions xmlns:d2p1="http://schemas.datacontract.org/2004/07/ListenerOnline.BusinessEntities.Common">
    <d2p1:ExcludeLostRadioFile>true</d2p1:ExcludeLostRadioFile>
    <d2p1:ExcludeRepairRadioFile>true</d2p1:ExcludeRepairRadioFile>
    <d2p1:ExcludeStockRadioFile>true</d2p1:ExcludeStockRadioFile>
    <d2p1:IncludeUnknownRadios>true</d2p1:IncludeUnknownRadios>
    <d2p1:SearchforRadiosWithTransmittersX>true</d2p1:SearchforRadiosWithTransmittersX>
    <d2p1:SiteType>8</d2p1:SiteType>
    <d2p1:UseAllSearchCriteriaWhenSelecting>true</d2p1:UseAllSearchCriteriaWhenSelecting>
    <d2p1:UseExactMatchWhenSearching>true</d2p1:UseExactMatchWhenSearching>
  </StandardQueryOptions>
  <TenantId>9</TenantId>
</PhoneSearch>

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 'PhoneSearch'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, text/html, application/xml, text/xml

Sample:

Sample not available.