List a Participant's current Services

get/public/v1/participants/{participant}/current-services

Returns the Services belonging to the Participant's current Plan (the Plan whose date range includes today). Each Service includes its service coordinator, charge items and charge item sets. When the Participant has no current Plan, an empty list is returned.

get/public/v1/participants/{participant}/current-services

curl --request GET \
  --url 'https://api.app.astalty.com.au/public/v1/participants/{participant}/current-services' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Accept: application/json'

Response

{
  "data": [
    {
      "id": "p1l2a3n4-s5e6-47v8-9b0c-1d2e3f4a5b6c",
      "name": "Level 2 Coordination",
      "amount": 1000000,
      "management_type": "ndia",
      "type": "unscheduled_service",
      "status": "current",
      "start": "2024-01-01T00:00:00+00:00",
      "end": "2024-12-31T00:00:00+00:00",
      "support_category": {
        "name": "Support Coordination",
        "prefix": "07",
        "group": "Capacity"
      },
      "service_coordinator": {
        "id": "u1s2e3r4-a5b6-47c8-9d0e-1f2a3b4c5d6e",
        "first_name": "John",
        "last_name": "Doe",
        "email": "john.doe@example.com"
      },
      "charge_items": [
        {
          "id": "c1h2a3r4-g5e6-47i8-9b0c-1d2e3f4a5b6c",
          "reference": "SUPPORT_COORD_L2",
          "number": "07_001_0106_8_3",
          "name": "Support Coordination Level 2",
          "unit": "H",
          "price": 10044,
          "gst_code": "P2",
          "default_claim_type": "Direct",
          "archived_at": null
        }
      ],
      "charge_item_sets": [
        {
          "id": "a1b2c3d4-e5f6-47a8-9b0c-1d2e3f4a5b6c",
          "reference": "SC-SET-01",
          "name": "Standard Support Coordination Set",
          "charge_rate_pattern": "variable_weekday",
          "gst_code": "P2",
          "archived_at": null
        }
      ]
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 0,
    "total": 0,
    "allowed_sorts": [
      "string"
    ]
  }
}

Authorization

Authorizationstringrequired
Bearer authentication header of the form Bearer <token>, where <token> is your API key. See How to set up an API key.

Path parameters

participantstringrequired
The participant UUID

Query parameters

page[size]integer
Number of results per page. Minimum 1, maximum 100.
Default:25
page[number]integer
The page number to retrieve. Use the last_page value from the meta response to determine the total number of pages available.
Default:1

Response

200application/json

Paginated set of PlanServiceResource

dataobject[]required
▶Show 12 child attributesHide child attributes
- idstringrequired
  Example:p1l2a3n4-s5e6-47v8-9b0c-1d2e3f4a5b6c
- namestringrequired
  Example:Level 2 Coordination
- amountintegerrequired
  Example:1000000
- management_typeenum<string>required
  Available options:planselfndiaunknown
- typestring | nullrequired
  Example:unscheduled_service
- statusstringrequired
  Example:current
- startstringrequired
  Example:2024-01-01T00:00:00+00:00
- endstringrequired
  Example:2024-12-31T00:00:00+00:00
- support_categoryobject | nullrequired
  ▶Show 3 child attributesHide child attributes
  namestringrequired
  Example:Support Coordination
  prefixstringrequired
  Example:07
  groupstringrequired
  Example:Capacity
- service_coordinatorobject | nullrequired
  ▶Show 4 child attributesHide child attributes
  idstringrequired
  Example:u1s2e3r4-a5b6-47c8-9d0e-1f2a3b4c5d6e
  first_namestringrequired
  Example:John
  last_namestringrequired
  Example:Doe
  emailstringrequired
  Example:john.doe@example.com
- charge_itemsobject[]required
  ▶Show 9 child attributesHide child attributes
  idstringrequired
  Example:c1h2a3r4-g5e6-47i8-9b0c-1d2e3f4a5b6c
  referencestringrequired
  Example:SUPPORT_COORD_L2
  numberstringrequired
  Example:07_001_0106_8_3
  namestringrequired
  Example:Support Coordination Level 2
  unitstringrequired
  Example:H
  priceintegerrequired
  Example:10044
  gst_codestringrequired
  Example:P2
  default_claim_typestring | nullrequired
  Example:Direct
  archived_atstring | nullrequired
- charge_item_setsobject[]required
  ▶Show 6 child attributesHide child attributes
  idstringrequired
  Example:a1b2c3d4-e5f6-47a8-9b0c-1d2e3f4a5b6c
  referencestringrequired
  Example:SC-SET-01
  namestringrequired
  Example:Standard Support Coordination Set
  charge_rate_patternstringrequired
  Example:variable_weekday
  gst_codestring | nullrequired
  Example:P2
  archived_atstring | nullrequired
metaobjectrequired
▶Show 5 child attributesHide child attributes
- current_pageintegerrequired≥ 1
- last_pageintegerrequired≥ 1
- per_pageintegerrequired≥ 0
  Number of items shown per page.
- totalintegerrequired≥ 0
  Total number of items being paginated.
- allowed_sortsstring[]required
  The list of allowed sorts for this endpoint.

Errors

401Unauthenticated
403Authorization error
404Not found

Command Palette

Authorization

Path parameters

Query parameters

Response

Errors