Medipim BE - API V4

Developer documentation

/v4/corrections/query

(Last updated: 23/11/2022)

Request

Method

POST

URL

https://api.medipim.be/v4/corrections/query

Headers

Body

Filter Description Parameters Examples
{"product": ...} Matches corrections by product. Medipim product ID {"product": "M1A2B3C4D5"}
{"status": ...} Matches corrections by status.
Possible values: "open", "in_progress" or "handled".
{"status": "open"}
{"organization": ...} Matches corrections by organization. Medipim organization ID {"organization": 1}
{"search": ...} Matches corrections by a specific search query. String {"search": "somesearchterm"}
{"locale": ...} Matches corrections by language. Locale {"locale": "nl"} or {"locale": ["nl", "fr"]}
{"createdBy": ...} Matches corrections by user. Medipim user ID {"createdBy": 1}
{"createdAt": ...} Matches corrections created since the given time. Unix timestamp. {"createdAt": 1471525605} or {"createdAt": {"from": 1471525605, "until": 1571525605}}
{"and": [...]} Matches corrections that match all of the given filters. A list of filters. {"and": [{"product": "M1A2B3C4D5"}, {"search": "test"}]}
{"or": [...]} Matches corrections that match any of the given filters. A list of filters. {"or": [{"product": "M1A2B3C4D5"}, {"search": "test"}]}
{"not": ...} Matches corrections that do not match the given filter. A filter. {"not": {"status": "open"}}
Sorting Description Parameters Examples
{"touchedAt": ...} Sort by last updated time "ASC" or "DESC" {"touchedAt": "ASC"} or {"touchedAt": "DESC"}

Response

Body

Notice

The meta page section will only be returned if you added a page in the request body.

Examples