---
agentTools:
  projectIndex: https://noiseaware.readme.io/llms.txt
---

# listCount Properties

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "description": "Entry to NoiseAware Services",
    "title": "NoiseAware API Gateway",
    "version": ""
  },
  "paths": {
    "/properties/list/count": {
      "post": {
        "operationId": "Properties#listCount",
        "requestBody": {
          "$ref": "#/components/requestBodies/listVars"
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/vnd.properties.list.count.response+json": {
                "schema": {
                  "$ref": "#/components/schemas/PropertiesListCountResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/vnd.properties.list.count.response+json": {
                "schema": {
                  "$ref": "#/components/schemas/PropertiesListCountResponse"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/vnd.properties.list.count.response+json": {
                "schema": {
                  "$ref": "#/components/schemas/PropertiesListCountResponse"
                }
              }
            }
          }
        },
        "security": [
          {
            "jwt": []
          }
        ],
        "summary": "listCount Properties",
        "tags": [
          "Properties"
        ]
      }
    }
  },
  "servers": [
    {
      "url": "http://portal.apps.noiseaware.io"
    }
  ],
  "components": {
    "requestBodies": {
      "listVars": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/listVars"
            }
          },
          "application/xml": {
            "schema": {
              "$ref": "#/components/schemas/listVars"
            }
          },
          "application/gob": {
            "schema": {
              "$ref": "#/components/schemas/listVars"
            }
          },
          "application/x-gob": {
            "schema": {
              "$ref": "#/components/schemas/listVars"
            }
          }
        },
        "required": true
      }
    },
    "securitySchemes": {
      "jwt": {
        "in": "header",
        "name": "Authorization",
        "type": "apiKey"
      }
    },
    "schemas": {
      "ErrorType": {
        "example": {
          "detail": "username is completely unacceptable",
          "field": "username"
        },
        "properties": {
          "detail": {
            "description": "Human readable explanation specific to this problem",
            "example": "username is completely unacceptable",
            "type": "string"
          },
          "field": {
            "description": "field error is associated with",
            "example": "username",
            "type": "string"
          }
        },
        "required": [
          "field",
          "detail"
        ],
        "title": "ErrorType",
        "type": "object"
      },
      "PropertiesListCountResponse": {
        "description": "PropertiesListCountResponse media type (default view)",
        "example": {
          "count": 42,
          "detail": "All good here",
          "errors": [
            {
              "detail": "username is completely unacceptable",
              "field": "username"
            },
            {
              "detail": "username is completely unacceptable",
              "field": "username"
            },
            {
              "detail": "username is completely unacceptable",
              "field": "username"
            }
          ],
          "status": "200"
        },
        "properties": {
          "count": {
            "description": "list count",
            "example": 42,
            "format": "int64",
            "type": "integer"
          },
          "detail": {
            "description": "human readable string of error",
            "example": "All good here",
            "type": "string"
          },
          "errors": {
            "description": "array of errors with details",
            "example": [
              {
                "detail": "username is completely unacceptable",
                "field": "username"
              },
              {
                "detail": "username is completely unacceptable",
                "field": "username"
              },
              {
                "detail": "username is completely unacceptable",
                "field": "username"
              }
            ],
            "items": {
              "$ref": "#/components/schemas/ErrorType"
            },
            "type": "array"
          },
          "status": {
            "description": "http status code",
            "example": "200",
            "type": "string"
          }
        },
        "required": [
          "count",
          "status",
          "detail",
          "errors"
        ],
        "title": "Mediatype identifier: application/vnd.properties.list.count.response+json; view=default",
        "type": "object"
      },
      "filter": {
        "example": {
          "key": "property",
          "operator": ">",
          "value": "4"
        },
        "properties": {
          "key": {
            "description": "field to filter by",
            "example": "property",
            "type": "string"
          },
          "operator": {
            "description": "type of filtering to do",
            "example": ">",
            "type": "string"
          },
          "value": {
            "description": "value or values to filter by",
            "example": "4",
            "type": "string"
          }
        },
        "required": [
          "key",
          "operator",
          "value"
        ],
        "title": "filter",
        "type": "object"
      },
      "listVars": {
        "example": {
          "filter": [
            {
              "key": "property",
              "operator": ">",
              "value": "4"
            },
            {
              "key": "property",
              "operator": ">",
              "value": "4"
            }
          ],
          "pagination": {
            "pageNum": 2,
            "perPage": 10
          },
          "search": "112342",
          "sort": [
            {
              "key": "checkin",
              "order": "ASC"
            },
            {
              "key": "checkin",
              "order": "ASC"
            }
          ]
        },
        "properties": {
          "filter": {
            "description": "Filters you may want to use",
            "example": [
              {
                "key": "property",
                "operator": ">",
                "value": "4"
              },
              {
                "key": "property",
                "operator": ">",
                "value": "4"
              }
            ],
            "items": {
              "$ref": "#/components/schemas/filter"
            },
            "type": "array"
          },
          "pagination": {
            "$ref": "#/components/schemas/pager"
          },
          "search": {
            "description": "search string",
            "example": "112342",
            "type": "string"
          },
          "sort": {
            "description": "Sorting parameters",
            "example": [
              {
                "key": "checkin",
                "order": "ASC"
              },
              {
                "key": "checkin",
                "order": "ASC"
              }
            ],
            "items": {
              "$ref": "#/components/schemas/sort"
            },
            "type": "array"
          }
        },
        "title": "listVars",
        "type": "object"
      },
      "pager": {
        "example": {
          "pageNum": 2,
          "perPage": 10
        },
        "properties": {
          "pageNum": {
            "description": "page number",
            "example": 2,
            "format": "int64",
            "type": "integer"
          },
          "perPage": {
            "description": "results per page",
            "example": 10,
            "format": "int64",
            "type": "integer"
          }
        },
        "title": "pager",
        "type": "object"
      },
      "sort": {
        "example": {
          "key": "checkin",
          "order": "ASC"
        },
        "properties": {
          "key": {
            "description": "field to sort by",
            "example": "checkin",
            "type": "string"
          },
          "order": {
            "description": "which direction to order by",
            "enum": [
              "ASC",
              "DESC"
            ],
            "example": "ASC",
            "type": "string"
          }
        },
        "required": [
          "key"
        ],
        "title": "sort",
        "type": "object"
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 97,
      "1": 238,
      "2": 254,
      "3": 234,
      "4": 3,
      "5": 54,
      "6": 17,
      "7": 0,
      "8": 86,
      "9": 50,
      "10": 66,
      "11": 37
    }
  }
}
```