/v4/osp-categories/query
(Last updated: 03/10/2023)
Request
Method
POST
URL
https://api.medipim.fr/v4/osp-categories/query
Headers
Body
filter
: one of the filters below; filters can be combined usingand
,or
¬
. (optional)page
(optional; if none is provided all results are returned)no
: page number (zero-based)size
: one of 10, 50, 100 or 250 (defaults to 100)
Filter | Description | Parameters | Examples |
---|---|---|---|
{"id": ...} |
Matches OSP category by ID. | One or more IDs | {"id": "1A02B04"} or {"id": ["1A02", "1A06A02", ...]} |
{"parent": ...} |
Matches OSP category by parent category ID. | OSP Category ID | {"parent": "1"} |
{"and": [...]} |
Matches OSP categories that match all of the given filters. | A list of filters. | {"and": [{"id": "0000018"}, ...]} |
{"or": [...]} |
Matches OSP categories that match any of the given filters. | A list of filters. | {"or": [{"id": "0000018"}, ...]} |
{"not": ...} |
Matches OSP categories that do not match the given filter. | A filter. | {"not": {"id": "0000018"}} |
Response
Body
meta
total
: total number of OSP categories (integer)page
no
: page number (zero-based) (integer)offset
: offset of the first item in the entire resultset (integer)size
: size of the page (integer)
results[]
:id
: Medipim ID of the OSP category (string)name.{fr|en|...}
: Name of the OSP category (string, localized)parent
: Id of the parent category (integer)order
: Sort order of the OSP category (integer)meta
:createdAt
: When the OSP category was created on Medipim (unix timestamp)updatedAt
: when the OSP category information was last updated (unix timestamp)
Notice
The meta page section will only be returned if you added a page in the request body.