10,729
edits
(Created page with "This is a read-only [https://www.odata.org/ OData v4] API service for accessing questionnaire results. == Authentication == The service uses standard '''BASIC''' authenticat...") |
No edit summary |
||
Line 5: | Line 5: | ||
The service uses standard '''BASIC''' authentication with the organization username and password. | The service uses standard '''BASIC''' authentication with the organization username and password. | ||
== Service | == Service document == | ||
Lists all questionnaire templates available. | Lists all questionnaire templates available. | ||
Line 50: | Line 50: | ||
}</syntaxhighlight> | }</syntaxhighlight> | ||
== Data | == Data request == | ||
Request for results of questionnaires. The resulting dataset depends on query applied. Without a query a single page of questionnaire results is returned. >>>Default (and max) page size is 1000. | Request for results of questionnaires. The resulting dataset depends on query applied. Without a query a single page of questionnaire results is returned. >>>Default (and max) page size is 1000. | ||
Line 272: | Line 272: | ||
* some headers should be supported and are not. | * some headers should be supported and are not. | ||
== Open | <!-- | ||
== Open questions == | |||
* Service URI, API versioning. | * Service URI, API versioning. | ||
* Namespacing - now <code>RescoQuestionnaire</code> is used. | * Namespacing - now <code>RescoQuestionnaire</code> is used. | ||
* | * Differences between this API and CRM OData API in how the lookups are modeled. | ||
* Referencing external model for | * Referencing external model for CRM lookups. | ||
* Should we somehow include “technical” cols from questions, such as <code>answeredon</code>. | * Should we somehow include “technical” cols from questions, such as <code>answeredon</code>. | ||
* How to avoid conflicts in naming after adjustment of keys. | * How to avoid conflicts in naming after adjustment of keys. | ||
* Should we really use a display name of | * Should we really use a display name of the questionnaire for generating URLs? | ||
--> |