{
  "opencollection": "1.0.0",
  "info": {
    "name": "ChartHop access band API",
    "version": "V1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "band",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Find comp bands in the organization",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v1/org/:orgId/band",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Org identifier (either id or slug)"
              },
              {
                "name": "date",
                "value": "",
                "type": "query",
                "description": "Date to search as of"
              },
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "Table id to start paginating from"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number of results to return"
              },
              {
                "name": "includeDeleted",
                "value": "",
                "type": "query",
                "description": "Include deleted bands"
              },
              {
                "name": "returnAccess",
                "value": "",
                "type": "query",
                "description": "Return access information -- pass a list of actions to check, for example: create,update,delete"
              },
              {
                "name": "jobTierOne",
                "value": "",
                "type": "query",
                "description": "Filter by job tier one value"
              },
              {
                "name": "jobTierTwo",
                "value": "",
                "type": "query",
                "description": "Filter by job tier two value"
              },
              {
                "name": "jobTierThree",
                "value": "",
                "type": "query",
                "description": "Filter by job tier three value"
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Sort by CompBand field (e.g., label, baseCompMin, baseCompMax)"
              },
              {
                "name": "jobLevel",
                "value": "",
                "type": "query",
                "description": "Filter by job level label"
              }
            ]
          },
          "docs": "Find comp bands in the organization"
        },
        {
          "info": {
            "name": "Create a comp band",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/v1/org/:orgId/band",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Org identifier (either id or slug)"
              },
              {
                "name": "date",
                "value": "",
                "type": "query",
                "description": "Effective date of band creation"
              }
            ]
          },
          "docs": "Create a comp band"
        },
        {
          "info": {
            "name": "Delete all comp bands on a date",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/v1/org/:orgId/band",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Org identifier (either id or slug)"
              },
              {
                "name": "date",
                "value": "",
                "type": "query",
                "description": "Effective date of group update"
              }
            ]
          },
          "docs": "Delete all comp bands on a date"
        },
        {
          "info": {
            "name": "Perform a bulk update on comp bands",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/v1/org/:orgId/band/bulkupdate",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Org identifier (either id or slug)"
              }
            ]
          },
          "docs": "Perform a bulk update on comp bands"
        },
        {
          "info": {
            "name": "Return the count of comp bands in the organization",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v1/org/:orgId/band/count",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Org identifier (either id or slug)"
              },
              {
                "name": "date",
                "value": "",
                "type": "query",
                "description": "Date to search as of"
              },
              {
                "name": "jobTierOne",
                "value": "",
                "type": "query",
                "description": "Filter by job tier one value"
              },
              {
                "name": "jobTierTwo",
                "value": "",
                "type": "query",
                "description": "Filter by job tier two value"
              },
              {
                "name": "jobTierThree",
                "value": "",
                "type": "query",
                "description": "Filter by job tier three value"
              },
              {
                "name": "jobLevel",
                "value": "",
                "type": "query",
                "description": "Filter by job level label"
              }
            ]
          },
          "docs": "Return the count of comp bands in the organization"
        },
        {
          "info": {
            "name": "Delete all comp band data on a date",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/v1/org/:orgId/band/reset",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Org identifier (either id or slug)"
              },
              {
                "name": "date",
                "value": "",
                "type": "query",
                "description": "Effective date of group update"
              }
            ]
          },
          "docs": "Delete all comp band data on a date"
        },
        {
          "info": {
            "name": "Get comp band schema with job tier field configurations and their possible values",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v1/org/:orgId/band/schema",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Org identifier (either id or slug)"
              },
              {
                "name": "date",
                "value": "",
                "type": "query",
                "description": "Date to search as of"
              }
            ]
          },
          "docs": "Get comp band schema with job tier field configurations and their possible values"
        },
        {
          "info": {
            "name": "Return a particular comp band by id on an effective date",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v1/org/:orgId/band/:bandId",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Org identifier (either id or slug)"
              },
              {
                "name": "bandId",
                "value": "",
                "type": "path",
                "description": "Comp band id"
              },
              {
                "name": "date",
                "value": "",
                "type": "query",
                "description": "Date to search as of"
              }
            ]
          },
          "docs": "Return a particular comp band by id on an effective date"
        },
        {
          "info": {
            "name": "Update a comp band",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/v1/org/:orgId/band/:bandId",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Org identifier (either id or slug)"
              },
              {
                "name": "bandId",
                "value": "",
                "type": "path",
                "description": "Band id"
              },
              {
                "name": "date",
                "value": "",
                "type": "query",
                "description": "Effective date of band update"
              }
            ]
          },
          "docs": "Update a comp band"
        },
        {
          "info": {
            "name": "Delete a comp band",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/v1/org/:orgId/band/:bandId",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Org identifier (either id or slug)"
              },
              {
                "name": "bandId",
                "value": "",
                "type": "path",
                "description": "Comp band id"
              },
              {
                "name": "date",
                "value": "",
                "type": "query",
                "description": "Effective date of group update"
              }
            ]
          },
          "docs": "Delete a comp band"
        }
      ]
    }
  ],
  "bundled": true
}