POST public-api/locations/infosearch

This method returns the active locations whose location code or location description contains the location code that is passed in. The site name parameter is optional; when it is supplied the search is restricted to that site. It requires the Allow Location permission and access to the Site where the Location is located. The number of records returned is capped by the tenant's configured maximum page size (500 by default). Note: This is a Post API to avoid limitations inherent to passing parameters on the URL.



Request Information

URI Parameters

None.

Body Parameters

LocationCodeWithSiteName
NameDescriptionTypeAdditional information
LocationCode

string

None.

SiteName

string

None.

Request Formats

application/json

Sample:
{
  "LocationCode": "sample string 1",
  "SiteName": "sample string 2"
}



Response Information

Resource Description

WaspResultOfListOfLocationModelInfo
NameDescriptionTypeAdditional information
Data

Collection of LocationModelInfo

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,
      "LocationId": 2,
      "SiteName": "sample string 3",
      "ZoneName": "sample string 4",
      "LocationCode": "sample string 5",
      "LocationDescription": "sample string 6",
      "UsageTypeName": "sample string 7",
      "LocationSaleable": 1,
      "DefaultLocation": true,
      "LocationRecordStatus": 0,
      "LocationNotes": "sample string 8",
      "AllLocationNotes": [
        {
          "NoteText": "sample string 1",
          "NoteDate": "2026-09-15T18:16:31.9122854+00:00",
          "UserLogon": "sample string 2"
        },
        {
          "NoteText": "sample string 1",
          "NoteDate": "2026-09-15T18:16:31.9122854+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:16:31.9122854+00:00",
          "DcfValueRecordStatus": 0
        },
        {
          "ImportRowNumber": 1,
          "DcfLabel": "sample string 2",
          "DCFDataType": 1,
          "DcfTextValue": "sample string 3",
          "DcfNumberValue": 1.0,
          "DcfDateValue": "2026-09-15T18:16:31.9122854+00:00",
          "DcfValueRecordStatus": 0
        }
      ],
      "LocationSequence": 1.0,
      "LocationWidth": 1.0,
      "LocationHeight": 1.0,
      "LocationDepth": 1.0,
      "DimensionUnit": "sample string 9",
      "LocationVolume": 1.0,
      "LocationMaxWeight": 1.0,
      "WeightUnit": "sample string 10",
      "LocationMaxVolume": 1.0,
      "VolumeUnit": "sample string 11",
      "ParentLocation": "sample string 12",
      "ChildrenLocations": 13,
      "LastUpdated": "2026-09-15T18:16:31.9122854+00:00"
    },
    {
      "RowNumber": 1,
      "LocationId": 2,
      "SiteName": "sample string 3",
      "ZoneName": "sample string 4",
      "LocationCode": "sample string 5",
      "LocationDescription": "sample string 6",
      "UsageTypeName": "sample string 7",
      "LocationSaleable": 1,
      "DefaultLocation": true,
      "LocationRecordStatus": 0,
      "LocationNotes": "sample string 8",
      "AllLocationNotes": [
        {
          "NoteText": "sample string 1",
          "NoteDate": "2026-09-15T18:16:31.9122854+00:00",
          "UserLogon": "sample string 2"
        },
        {
          "NoteText": "sample string 1",
          "NoteDate": "2026-09-15T18:16:31.9122854+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:16:31.9122854+00:00",
          "DcfValueRecordStatus": 0
        },
        {
          "ImportRowNumber": 1,
          "DcfLabel": "sample string 2",
          "DCFDataType": 1,
          "DcfTextValue": "sample string 3",
          "DcfNumberValue": 1.0,
          "DcfDateValue": "2026-09-15T18:16:31.9122854+00:00",
          "DcfValueRecordStatus": 0
        }
      ],
      "LocationSequence": 1.0,
      "LocationWidth": 1.0,
      "LocationHeight": 1.0,
      "LocationDepth": 1.0,
      "DimensionUnit": "sample string 9",
      "LocationVolume": 1.0,
      "LocationMaxWeight": 1.0,
      "WeightUnit": "sample string 10",
      "LocationMaxVolume": 1.0,
      "VolumeUnit": "sample string 11",
      "ParentLocation": "sample string 12",
      "ChildrenLocations": 13,
      "LastUpdated": "2026-09-15T18:16:31.9122854+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
}