POST public-api/sites/infosearch
This method returns all active sites whose site name or site description contains the specified texts that are entered on the combo box. It only returns the site name and site description similar to the site drop down controls on the web. It requires the Allow Site permission and enforces Role Site restriction. This method does not provide List of Messages on response information. Note: This is a Post API to avoid limitations inherent to passing parameters on the URL.
Request Information
URI Parameters
None.
Body Parameters
SiteContainsSearchParameters| Name | Description | Type | Additional information |
|---|---|---|---|
| SearchPattern | string |
None. |
Request Formats
application/json
Sample:
{
"SearchPattern": "sample string 1"
}
Response Information
Resource Description
WaspResultOfListOfSiteModelInfo| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | Collection of SiteModelInfo |
None. |
|
| Messages | Collection of WtResult |
None. |
|
| BatchNumber | integer |
None. |
|
| HasError | boolean |
None. |
|
| HasHttpError | boolean |
None. |
|
| HasMessage | boolean |
None. |
|
| HasSuccessWithMoreDataRemaining | boolean |
None. |
|
| TotalRecordsLongCount | integer |
None. |
Response Formats
application/json
Sample:
{
"Data": [
{
"RowNumber": 1,
"SiteName": "sample string 2",
"SiteDescription": "sample string 3",
"LocationCount": 4,
"SiteRecordStatus": 0,
"SiteNotes": "sample string 5",
"AccessAllCatgories": true,
"AllSiteNotes": [
{
"NoteText": "sample string 1",
"NoteDate": "2026-02-17T10:22:00.7623704+00:00",
"UserLogon": "sample string 2"
},
{
"NoteText": "sample string 1",
"NoteDate": "2026-02-17T10:22:00.7623704+00:00",
"UserLogon": "sample string 2"
}
],
"CustomFields": [
{
"ImportRowNumber": 1,
"DcfLabel": "sample string 2",
"DCFDataType": 1,
"DcfTextValue": "sample string 3",
"DcfNumberValue": 1.0,
"DcfDateValue": "2026-02-17T10:22:00.7623704+00:00",
"DcfValueRecordStatus": 0
},
{
"ImportRowNumber": 1,
"DcfLabel": "sample string 2",
"DCFDataType": 1,
"DcfTextValue": "sample string 3",
"DcfNumberValue": 1.0,
"DcfDateValue": "2026-02-17T10:22:00.7623704+00:00",
"DcfValueRecordStatus": 0
}
],
"AllowedCategories": [
"sample string 1",
"sample string 2"
],
"LastUpdated": "2026-02-17T10:22:00.7623704+00:00"
},
{
"RowNumber": 1,
"SiteName": "sample string 2",
"SiteDescription": "sample string 3",
"LocationCount": 4,
"SiteRecordStatus": 0,
"SiteNotes": "sample string 5",
"AccessAllCatgories": true,
"AllSiteNotes": [
{
"NoteText": "sample string 1",
"NoteDate": "2026-02-17T10:22:00.7623704+00:00",
"UserLogon": "sample string 2"
},
{
"NoteText": "sample string 1",
"NoteDate": "2026-02-17T10:22:00.7623704+00:00",
"UserLogon": "sample string 2"
}
],
"CustomFields": [
{
"ImportRowNumber": 1,
"DcfLabel": "sample string 2",
"DCFDataType": 1,
"DcfTextValue": "sample string 3",
"DcfNumberValue": 1.0,
"DcfDateValue": "2026-02-17T10:22:00.7623704+00:00",
"DcfValueRecordStatus": 0
},
{
"ImportRowNumber": 1,
"DcfLabel": "sample string 2",
"DCFDataType": 1,
"DcfTextValue": "sample string 3",
"DcfNumberValue": 1.0,
"DcfDateValue": "2026-02-17T10:22:00.7623704+00:00",
"DcfValueRecordStatus": 0
}
],
"AllowedCategories": [
"sample string 1",
"sample string 2"
],
"LastUpdated": "2026-02-17T10:22:00.7623704+00:00"
}
],
"Messages": [
{
"ResultCode": 0,
"Message": "sample string 1",
"HttpStatusCode": 200,
"FieldName": "sample string 2"
},
{
"ResultCode": 0,
"Message": "sample string 1",
"HttpStatusCode": 200,
"FieldName": "sample string 2"
}
],
"BatchNumber": 1,
"HasError": false,
"HasHttpError": false,
"HasMessage": true,
"HasSuccessWithMoreDataRemaining": false,
"TotalRecordsLongCount": 1
}