Count calendar items

curl --request GET \
  --url https://{organization}.rescueconsole.com/api/calendar/facets \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{organization}.rescueconsole.com/api/calendar/facets', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://{organization}.rescueconsole.com/api/calendar/facets"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "total": 123,
  "unavailable": [
    "<string>"
  ],
  "facets": {
    "source": [
      {
        "value": "<string>",
        "label": "<string>",
        "count": 123
      }
    ],
    "tone": [
      {
        "value": "<string>",
        "label": "<string>",
        "count": 123
      }
    ]
  }
}

{
  "error": "house_trained must be 1, 0 or null (not assessed)"
}

{
  "error": "house_trained must be 1, 0 or null (not assessed)"
}

Calendar

Count calendar items

How many items each kind and each state would give in the same range, for the same filters Get the calendar takes. The kinds are counted with the sources filter left out and the tone filter applied, and the states the other way round. The range is never left out. The kinds offered are only the ones your key may read. A count is null, not zero, when the area it comes from could not be loaded; if any area could not be loaded, every state’s count is null, because none of them can be known.

GET

/

api

/

calendar

/

facets

Count calendar items

curl --request GET \
  --url https://{organization}.rescueconsole.com/api/calendar/facets \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{organization}.rescueconsole.com/api/calendar/facets', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://{organization}.rescueconsole.com/api/calendar/facets"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "total": 123,
  "unavailable": [
    "<string>"
  ],
  "facets": {
    "source": [
      {
        "value": "<string>",
        "label": "<string>",
        "count": 123
      }
    ],
    "tone": [
      {
        "value": "<string>",
        "label": "<string>",
        "count": 123
      }
    ]
  }
}

{
  "error": "house_trained must be 1, 0 or null (not assessed)"
}

{
  "error": "house_trained must be 1, 0 or null (not assessed)"
}

Authorizations

Authorization

string

header

required

An API key from Settings, API keys. It starts with rc_live_.

Query Parameters

from

string<date>

required

The first day, YYYY-MM-DD.

to

string<date>

required

The last day, YYYY-MM-DD, included. Not before from, and at most 366 days after it.

sources

enum<string>[]

Only these kinds of item, comma-separated.

Available options:

task,

volunteer_event,

volunteer_session,

medical_due,

adoption,

foster_start,

foster_end,

intake

tone

enum<string>[]

Only items in these states, comma-separated.

The item's state. overdue: a task or medical item whose day has passed and that is not done. due: a task or medical item due today or later, or a meet and greet whose day has passed without being marked done. scheduled: a shift, a shift schedule or a meet and greet still to come. done: done, performed or completed, and a dated fact such as an adoption, an arrival or a foster placement. cancelled: a reversed adoption, a declined foster placement, a cancelled shift or schedule.

Available options:

overdue,

due,

scheduled,

done,

cancelled

Response

The counts.

total

integer

required

How many items match every filter you sent, of the ones that could be loaded.

unavailable

string[]

required

The areas whose items could not be loaded this time.

facets

object

required

Show child attributes