POST datanorm/DataNormAdvancedSearch
Request Information
URI Parameters
None.
Body Parameters
AdvancedClientSearchParameters| Name | Description | Type | Additional information |
|---|---|---|---|
| CustCode | string |
None. |
|
| CustDesc | string |
None. |
|
| Surname | string |
None. |
|
| FirstNames | string |
None. |
|
| ClientStatus | integer |
None. |
|
| ContactNumber | string |
None. |
|
| ContactName | string |
None. |
|
| string |
None. |
||
| IdNumber | string |
None. |
|
| QuoteNumber | string |
None. |
|
| PhysicalAddress | string |
None. |
|
| StreetNo | string |
None. |
|
| StreetName | string |
None. |
|
| StreetType | integer |
None. |
|
| DivisionID | integer |
None. |
|
| SubDivision | integer |
None. |
|
| MainArea | integer |
None. |
|
| SubArea | integer |
None. |
|
| Suburb | integer |
None. |
|
| LeadId | integer |
None. |
|
| BuildingNo | string |
None. |
|
| BuildingName | string |
None. |
|
| CurrentPage | integer |
None. |
|
| TenantId | integer |
None. |
|
| UserId | integer |
None. |
|
| NormalisationId | integer |
None. |
|
| ExcludeNormalisedProjectTypeID | integer |
None. |
|
| SearchOptions | SearchOption |
None. |
|
| ClientGroupId | integer |
None. |
|
| GroupTypeId | integer |
None. |
|
| SubGroupId | integer |
None. |
|
| AreaIds | Collection of integer |
None. |
|
| AreaTypeId | integer |
None. |
|
| qASearches | Collection of ClientQASearch |
None. |
|
| IsPortalClient | boolean |
None. |
|
| IsActiveCpUser | boolean |
None. |
|
| IsRegisteredCpUser | boolean |
None. |
|
| ClientTypeId | integer |
None. |
|
| ClientSubTypeId | integer |
None. |
|
| IsYapYap | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"CustCode": "sample string 1",
"CustDesc": "sample string 2",
"Surname": "sample string 3",
"FirstNames": "sample string 4",
"ClientStatus": 1,
"ContactNumber": "sample string 5",
"ContactName": "sample string 6",
"Email": "sample string 7",
"IdNumber": "sample string 8",
"QuoteNumber": "sample string 9",
"PhysicalAddress": "sample string 10",
"StreetNo": "sample string 11",
"StreetName": "sample string 12",
"StreetType": 1,
"DivisionID": 13,
"SubDivision": 1,
"MainArea": 1,
"SubArea": 1,
"Suburb": 1,
"LeadId": 1,
"BuildingNo": "sample string 14",
"BuildingName": "sample string 15",
"CurrentPage": 16,
"TenantId": 17,
"UserId": 18,
"NormalisationId": 1,
"ExcludeNormalisedProjectTypeID": 1,
"SearchOptions": {
"PremisesTypeId": 1,
"ExcludeLostRadioFile": true,
"ExcludeRepairRadioFile": true,
"ExcludeStockRadioFile": true,
"IncludeUnknownRadios": true,
"SearchforRadiosWithTransmittersX": true
},
"ClientGroupId": 1,
"GroupTypeId": 1,
"SubGroupId": 1,
"AreaIds": [
1,
2
],
"AreaTypeId": 1,
"qASearches": [
{
"id": 1,
"value": "sample string 2"
},
{
"id": 1,
"value": "sample string 2"
}
],
"IsPortalClient": true,
"IsActiveCpUser": true,
"IsRegisteredCpUser": true,
"ClientTypeId": 1,
"ClientSubTypeId": 1,
"IsYapYap": true
}
text/html
Sample:
{"CustCode":"sample string 1","CustDesc":"sample string 2","Surname":"sample string 3","FirstNames":"sample string 4","ClientStatus":1,"ContactNumber":"sample string 5","ContactName":"sample string 6","Email":"sample string 7","IdNumber":"sample string 8","QuoteNumber":"sample string 9","PhysicalAddress":"sample string 10","StreetNo":"sample string 11","StreetName":"sample string 12","StreetType":1,"DivisionID":13,"SubDivision":1,"MainArea":1,"SubArea":1,"Suburb":1,"LeadId":1,"BuildingNo":"sample string 14","BuildingName":"sample string 15","CurrentPage":16,"TenantId":17,"UserId":18,"NormalisationId":1,"ExcludeNormalisedProjectTypeID":1,"SearchOptions":{"PremisesTypeId":1,"ExcludeLostRadioFile":true,"ExcludeRepairRadioFile":true,"ExcludeStockRadioFile":true,"IncludeUnknownRadios":true,"SearchforRadiosWithTransmittersX":true},"ClientGroupId":1,"GroupTypeId":1,"SubGroupId":1,"AreaIds":[1,2],"AreaTypeId":1,"qASearches":[{"id":1,"value":"sample string 2"},{"id":1,"value":"sample string 2"}],"IsPortalClient":true,"IsActiveCpUser":true,"IsRegisteredCpUser":true,"ClientTypeId":1,"ClientSubTypeId":1,"IsYapYap":true}
application/xml, text/xml
Sample:
<AdvancedClientSearchParameters xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ListenerOnline.BusinessEntities.Clients">
<AreaIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
</AreaIds>
<AreaTypeId>1</AreaTypeId>
<BuildingName>sample string 15</BuildingName>
<BuildingNo>sample string 14</BuildingNo>
<ClientGroupId>1</ClientGroupId>
<ClientStatus>1</ClientStatus>
<ClientSubTypeId>1</ClientSubTypeId>
<ClientTypeId>1</ClientTypeId>
<ContactName>sample string 6</ContactName>
<ContactNumber>sample string 5</ContactNumber>
<CurrentPage>16</CurrentPage>
<CustCode>sample string 1</CustCode>
<CustDesc>sample string 2</CustDesc>
<DivisionID>13</DivisionID>
<Email>sample string 7</Email>
<ExcludeNormalisedProjectTypeID>1</ExcludeNormalisedProjectTypeID>
<FirstNames>sample string 4</FirstNames>
<GroupTypeId>1</GroupTypeId>
<IdNumber>sample string 8</IdNumber>
<IsActiveCpUser>true</IsActiveCpUser>
<IsPortalClient>true</IsPortalClient>
<IsRegisteredCpUser>true</IsRegisteredCpUser>
<IsYapYap>true</IsYapYap>
<LeadId>1</LeadId>
<MainArea>1</MainArea>
<NormalisationId>1</NormalisationId>
<PhysicalAddress>sample string 10</PhysicalAddress>
<QuoteNumber>sample string 9</QuoteNumber>
<SearchOptions>
<ExcludeLostRadioFile>true</ExcludeLostRadioFile>
<ExcludeRepairRadioFile>true</ExcludeRepairRadioFile>
<ExcludeStockRadioFile>true</ExcludeStockRadioFile>
<IncludeUnknownRadios>true</IncludeUnknownRadios>
<PremisesTypeId>1</PremisesTypeId>
<SearchforRadiosWithTransmittersX>true</SearchforRadiosWithTransmittersX>
</SearchOptions>
<StreetName>sample string 12</StreetName>
<StreetNo>sample string 11</StreetNo>
<StreetType>1</StreetType>
<SubArea>1</SubArea>
<SubDivision>1</SubDivision>
<SubGroupId>1</SubGroupId>
<Suburb>1</Suburb>
<Surname>sample string 3</Surname>
<TenantId>17</TenantId>
<UserId>18</UserId>
<qASearches>
<ClientQASearch>
<id>1</id>
<value>sample string 2</value>
</ClientQASearch>
<ClientQASearch>
<id>1</id>
<value>sample string 2</value>
</ClientQASearch>
</qASearches>
</AdvancedClientSearchParameters>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, text/html, application/xml, text/xml
Sample:
Sample not available.