POST datanorm/DataNormClientSearch

Request Information

URI Parameters

None.

Body Parameters

SimpleClientSearchParams
NameDescriptionTypeAdditional information
SearchWord

string

None.

DivisionID

integer

None.

CurrentPage

integer

None.

TenantId

integer

None.

UserId

integer

None.

NormalisationId

integer

None.

SearchOptions

SearchOption

None.

ExcludeNormalisedProjectTypeID

integer

None.

IsYapYap

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "SearchWord": "sample string 1",
  "DivisionID": 2,
  "CurrentPage": 3,
  "TenantId": 4,
  "UserId": 5,
  "NormalisationId": 1,
  "SearchOptions": {
    "PremisesTypeId": 1,
    "ExcludeLostRadioFile": true,
    "ExcludeRepairRadioFile": true,
    "ExcludeStockRadioFile": true,
    "IncludeUnknownRadios": true,
    "SearchforRadiosWithTransmittersX": true
  },
  "ExcludeNormalisedProjectTypeID": 1,
  "IsYapYap": true
}

text/html

Sample:
{"SearchWord":"sample string 1","DivisionID":2,"CurrentPage":3,"TenantId":4,"UserId":5,"NormalisationId":1,"SearchOptions":{"PremisesTypeId":1,"ExcludeLostRadioFile":true,"ExcludeRepairRadioFile":true,"ExcludeStockRadioFile":true,"IncludeUnknownRadios":true,"SearchforRadiosWithTransmittersX":true},"ExcludeNormalisedProjectTypeID":1,"IsYapYap":true}

application/xml, text/xml

Sample:
<SimpleClientSearchParams xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ListenerOnline.BusinessEntities.Clients">
  <CurrentPage>3</CurrentPage>
  <DivisionID>2</DivisionID>
  <ExcludeNormalisedProjectTypeID>1</ExcludeNormalisedProjectTypeID>
  <IsYapYap>true</IsYapYap>
  <NormalisationId>1</NormalisationId>
  <SearchOptions>
    <ExcludeLostRadioFile>true</ExcludeLostRadioFile>
    <ExcludeRepairRadioFile>true</ExcludeRepairRadioFile>
    <ExcludeStockRadioFile>true</ExcludeStockRadioFile>
    <IncludeUnknownRadios>true</IncludeUnknownRadios>
    <PremisesTypeId>1</PremisesTypeId>
    <SearchforRadiosWithTransmittersX>true</SearchforRadiosWithTransmittersX>
  </SearchOptions>
  <SearchWord>sample string 1</SearchWord>
  <TenantId>4</TenantId>
  <UserId>5</UserId>
</SimpleClientSearchParams>

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

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.