GET /external/api/v3/questionnaire/getall?includeArchived={includeArchived}
Get a list of all questionnaire names and the corresponding id.
Request Information
URI Parameters
Name | Description | Type | Additional information | Nullable |
---|---|---|---|---|
includeArchived | boolean |
Default value is False |
False |
Body Parameters
None.
Response Information
Resource Description
GetAllQuestionnairesResponseName | Description | Type | Additional information | Nullable |
---|---|---|---|---|
Questionnaires | Collection of BaseQuestionnaire |
None |
False |
Response Formats
application/json, text/json
Sample:
{ "Questionnaires": [ { "Id": "e9c9642f-1d75-491e-ba68-949ae0ff55e5", "Name": "sample string 2", "LastModifiedDate": "2024-12-08T04:45:37.695063+01:00", "IsConcept": true }, { "Id": "e9c9642f-1d75-491e-ba68-949ae0ff55e5", "Name": "sample string 2", "LastModifiedDate": "2024-12-08T04:45:37.695063+01:00", "IsConcept": true } ] }
application/xml, text/xml
Sample:
<GetAllQuestionnairesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.V1.Responses"> <Questionnaires xmlns:d2p1="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models"> <d2p1:BaseQuestionnaire> <d2p1:Id>e9c9642f-1d75-491e-ba68-949ae0ff55e5</d2p1:Id> <d2p1:IsConcept>true</d2p1:IsConcept> <d2p1:LastModifiedDate>2024-12-08T04:45:37.695063+01:00</d2p1:LastModifiedDate> <d2p1:Name>sample string 2</d2p1:Name> </d2p1:BaseQuestionnaire> <d2p1:BaseQuestionnaire> <d2p1:Id>e9c9642f-1d75-491e-ba68-949ae0ff55e5</d2p1:Id> <d2p1:IsConcept>true</d2p1:IsConcept> <d2p1:LastModifiedDate>2024-12-08T04:45:37.695063+01:00</d2p1:LastModifiedDate> <d2p1:Name>sample string 2</d2p1:Name> </d2p1:BaseQuestionnaire> </Questionnaires> </GetAllQuestionnairesResponse>
Response Status Codes
Status Code | Name | Description |
---|---|---|
200 | OK | The request has succeeded. |
400 | Bad Request | Fulfilling the request would cause an invalid state. Request needs modification. |
401 | Unauthorized | Missing or invalid authentication token. |
403 | Forbidden | Server refuses to authorize the request. |
408 | Request Timeout | The server timed out waiting for the request. |
429 | Too Many Requests | Too many requests in a given amount of time. |
500 | Internal Server Error | The server encountered an unexpected condition which prevented it from fulfilling the request. |
503 | Service Unavailable | The server is unable to proces the request at the moment, try again later. |