{
  "opencollection": "1.0.0",
  "info": {
    "name": "Openpath API Documentation auth orgs/readers API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "orgs/readers",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List all owned or assigned readers",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/orgs/:orgId/readers",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query"
              },
              {
                "name": "sort",
                "value": "",
                "type": "query"
              },
              {
                "name": "order",
                "value": "",
                "type": "query"
              },
              {
                "name": "q",
                "value": "",
                "type": "query"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query"
              },
              {
                "name": "preFilter",
                "value": "",
                "type": "query"
              },
              {
                "name": "options",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Possible comma separated values for the options parameter include: withEffectiveLocationRestriction. The withEffectiveLocationRestriction option causes current effective location restriction to be included in the response. Only readers with an effective location restriction include this object.<br/><br/>__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-hw:w,o{params.orgId}-hw:r,o{params.orgId}-site:w,o{p"
        },
        {
          "info": {
            "name": "Create a reader",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/orgs/:orgId/readers",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o:w,s-o:w<br/><br/>__Endpoint name__: createReader"
        },
        {
          "info": {
            "name": "Describe an owned or assigned reader",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/orgs/:orgId/readers/:readerId",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path"
              },
              {
                "name": "readerId",
                "value": "",
                "type": "path"
              },
              {
                "name": "options",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Possible comma separated values for the options parameter include: withEffectiveLocationRestriction. The withEffectiveLocationRestriction option causes current effective location restriction to be included in the response. Only readers with an effective location restriction include this object.<br/><br/>__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-dashActivity:w,o{params.orgId}-dashActivity:r,o{params.orgId}-dashCust:w,o{params.orgId}-dashCust:"
        },
        {
          "info": {
            "name": "Update a reader",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/orgs/:orgId/readers/:readerId",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path"
              },
              {
                "name": "readerId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o:w,o-support:w,s-o:w<br/><br/>__Endpoint name__: updateReader"
        },
        {
          "info": {
            "name": "Delete a reader",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/orgs/:orgId/readers/:readerId",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path"
              },
              {
                "name": "readerId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o:w,s-o:w<br/><br/>__Endpoint name__: deleteReader"
        },
        {
          "info": {
            "name": "Remotely trigger a reader to identify itself via LED and buzzer",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/orgs/:orgId/readers/:readerId/identify",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path"
              },
              {
                "name": "readerId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o:w,s-o:w<br/><br/>__Endpoint name__: remoteReaderIdentify"
        },
        {
          "info": {
            "name": "Remotely trigger a reader to restart",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/orgs/:orgId/readers/:readerId/restart",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path"
              },
              {
                "name": "readerId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o:w,s-o:w<br/><br/>__Endpoint name__: remoteReaderRestart"
        }
      ]
    }
  ],
  "bundled": true
}