Suggestion API
POST /api/sante-suggest
Suggest entities using SANTé
SANTé suggest provides a way to get a suggestion. It returns a list of possible suggestion results.
Body parameter
{
"q": "string",
"offset": 0,
"limit": 1,
"prefixes": [
"string"
],
"classes": [
"string"
],
"filters": [
{}
],
"content": [
"string"
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | Query | true | none |
Example responses
200 Response
{
"params": {
"q": "string",
"offset": 0,
"limit": 1,
"prefixes": [
"string"
],
"classes": [
"string"
],
"filters": [
{}
],
"content": [
"string"
]
},
"result": [
{
"suggestion": "string",
"score": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The query was successful and returned a result. | SanteSuggestResponseDto |
| 400 | Bad Request | The request contains invalid input. | None |
| 500 | Internal Server Error | There was an issue while processing the query. | None |