Offering

Table of Contents

Sample Request
- Get Information on All Offerings for a Sub-Entity
- Get Information for an Individual Offering
Sample Response JSON
Notes on Values

Each Sub-Entity in Supportable has a list of Offerings (services) it administers.

Sample Request #

Headers	Authorization = Bearer [token]
Parameters	None
Body	None

Get Information on All Offerings for a Sub-Entity #

GET https://connect.supportableapp.com/api/sub-entities/{subEntityId}/offerings

Get Information for an Individual Offering #

GET https://connect.supportableapp.com/api/sub-entities/{subEntityId}/offerings/{offeringId}

Sample Response JSON #

Status: 200

[
  {
    "id": "636d1c9f582a9cb870f6cc9a",
    "status": true,
    "name": "OM-RR-Asmt",
    "offeringType": {
      "id": "61d6dcdb1a28b5d9378ea619",
      "status": true,
      "name": "Comprehensive Assessment"
    },
    "shortName": "Asmt",
    "preferred": {
      "name": "Substance Use Assessment",
      "shortName": "Asmt"
    }
  },
  . . .
]

Notes on Values #

Attribute	Data Type	Description
id	string	The unique identifier of the Offering.
status	boolean	Whether the Offering is active in Supportable.
name	string	The official name of the Offering.
offeringType	object	The Offering Type with which the Offering is associated.
offeringType.id	string	The unique identifier of the Offering Type.
offeringType.status	boolean	Whether the Offering Type is active in Supportable.
offeringType.name	string	The name of the Offering Type.
shortName	string	The shortened name of the Offering, to be used in parts of the application to save space.
preferred	object	The preferred, more end user/customer friendly alias for the offering (service).
preferred.name	string	The preferred full name of the Offering, as it appears in the application.
preferred.ShortName	string	The preferred short name of the Offering, as it appears in the application.