POST public-api/sites/getsitesbyname

This method returns existing sites by name, including each site's location count, site notes and custom field values. It requires the Allow Site permission and enforces Role Site restriction. Note: This is a Post API to avoid limitations inherent to passing parameters on the URL.

Request Information

URI Parameters

None.

Body Parameters

Collection of string

Request Formats

application/json

Sample:

[
  "sample string 1",
  "sample string 2"
]

Response Information

Resource Description

WaspResultOfListOfWaspResultOfSiteModelInfo

Name	Type	Additional information
Data	Collection of WaspResultOfSiteModelInfo	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": [
    {
      "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-09-15T18:17:08.165334+00:00",
            "UserLogon": "sample string 2"
          },
          {
            "NoteText": "sample string 1",
            "NoteDate": "2026-09-15T18:17:08.165334+00:00",
            "UserLogon": "sample string 2"
          }
        ],
        "CustomFields": [
          {
            "ImportRowNumber": 1,
            "DcfLabel": "sample string 2",
            "DCFDataType": 1,
            "DcfTextValue": "sample string 3",
            "DcfNumberValue": 1.0,
            "DcfDateValue": "2026-09-15T18:17:08.165334+00:00",
            "DcfValueRecordStatus": 0
          },
          {
            "ImportRowNumber": 1,
            "DcfLabel": "sample string 2",
            "DCFDataType": 1,
            "DcfTextValue": "sample string 3",
            "DcfNumberValue": 1.0,
            "DcfDateValue": "2026-09-15T18:17:08.165334+00:00",
            "DcfValueRecordStatus": 0
          }
        ],
        "AllowedCategories": [
          "sample string 1",
          "sample string 2"
        ],
        "LastUpdated": "2026-09-15T18:17:08.165334+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
    },
    {
      "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-09-15T18:17:08.165334+00:00",
            "UserLogon": "sample string 2"
          },
          {
            "NoteText": "sample string 1",
            "NoteDate": "2026-09-15T18:17:08.165334+00:00",
            "UserLogon": "sample string 2"
          }
        ],
        "CustomFields": [
          {
            "ImportRowNumber": 1,
            "DcfLabel": "sample string 2",
            "DCFDataType": 1,
            "DcfTextValue": "sample string 3",
            "DcfNumberValue": 1.0,
            "DcfDateValue": "2026-09-15T18:17:08.165334+00:00",
            "DcfValueRecordStatus": 0
          },
          {
            "ImportRowNumber": 1,
            "DcfLabel": "sample string 2",
            "DCFDataType": 1,
            "DcfTextValue": "sample string 3",
            "DcfNumberValue": 1.0,
            "DcfDateValue": "2026-09-15T18:17:08.165334+00:00",
            "DcfValueRecordStatus": 0
          }
        ],
        "AllowedCategories": [
          "sample string 1",
          "sample string 2"
        ],
        "LastUpdated": "2026-09-15T18:17:08.165334+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
    }
  ],
  "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
}