POST public-api/sites/search/exact/v2
This method gets the active site that exactly matches the search string. It is the version 2 form of the search/exact API: it reports the site's category restrictions in full - a flag indicating whether the site can access all categories, plus the list of allowed category descriptions - in place of the single has-restrictions flag returned by search/exact. It requires the Allow Site permission and enforces Role Site restriction. If no site matches, the response contains an empty site and no messages.
Request Information
URI Parameters
None.
Body Parameters
SearchStringClass| Name | Description | Type | Additional information |
|---|---|---|---|
| SearchString | string |
None. |
Request Formats
application/json
Sample:
{
"SearchString": "sample string 1"
}
Response Information
Resource Description
WaspResultOfSiteModelSimplev2| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | SiteModelSimplev2 |
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": {
"AccessAllCategories": true,
"AllowedCategories": [
"sample string 1",
"sample string 2"
],
"SiteName": "sample string 2",
"SiteDescription": "sample string 3",
"HasCategoryRestrictions": true
},
"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
}