Get permanence timeframe

Request

Returns the client reception (permanence) slots configured for an agency, grouped by day of week. Requires SITE_CALENDAR:READ.

Security

bearerAuth

Query

agency_idintegerrequired

Target agency ID whose permanence configuration is requested. Must belong to the agencies the authenticated client can read, otherwise a 403 is returned.

curl -i -X GET \
  'https://api-doc.immo-facile.com/_mock/openapi/calendar/permanences/timeframe?agency_id=0' \
  -H 'Authorization: Bearer <YOUR_opaque_HERE>'

Responses

Permanence timeframe grouped by day

Bodyapplication/json

dataobject(PermanenceTimeframeResponse)

Client reception (permanence) slots, grouped by day of week (MO, TU, WE, TH, FR, SA, SU). Each day holds a list of time ranges.

Example:

{
  "MO": [
    { … }
  ],
  "TU": []
}

Response

{
  "data": {
    "MO": [ … ],
    "TU": []
  }
}