|
1 | 1 | # Vocean Connector |
2 | 2 | --- |
3 | | -Vocean is a platform for digital co-creation with the vison to _let every voice matter_ and to unleash the power of the many. With Vocean you can include more individuals in innovative processes and by doing so you will get a better basis for making decisions and a wider support for the result. For more information, visit [Vocean](https://vocean.com/ "Vocean website"). With the API provided by Vocean you can retrieve information that participants have contributed with in different activities. |
| 3 | +Vocean is the space for co-creation. This is where ideas meet and grow strong together. Here you can harness the intelligence of collectives, empower people and determine the way forward. For more information, visit [Vocean](https://vocean.com/ "Vocean website"). With the API provided by Vocean you can retrieve information that participants have contributed with in different activities. It is also possible to instead let a trigger inform you, for example, when an idea is added, or you are added to a Vocean activity. |
4 | 4 |
|
5 | 5 | ## Publisher: Vocean AB |
6 | 6 |
|
7 | 7 | ## Prerequisites |
8 | 8 | --- |
9 | | -You must be a member of a Vocean account, appointed with a Vocean Premium Leader license. If you aren't a member of a Vocean account yet you can easily sign up for an account of your own [here](https://vocean.com/pricing/ "Sign up for Vocean"). |
| 9 | +You must be a member of a Vocean space, appointed with a Vocean Premium Leader license. If you are not a member of a Vocean space yet you can easily sign up for a space of your own [here](https://vocean.com/pricing/ "Sign up for Vocean"). |
10 | 10 |
|
11 | 11 | ## Restrictions |
12 | 12 | --- |
13 | | -Within Vocean you can be a member of several accounts, the Vocean Connector allows you to reach all your accounts. However, to be able to retrieve data you must be a leader of the specified activity and have Vocean Premium Leader rights in that account. (If you have a Leader license in a Vocean account you can access its [members page](https://app.vocean.com/#/network/members) and see if you have the Premium Leader license flag enabled on your membership.) |
| 13 | +Within Vocean you can be a member of several spaces, the Vocean Connector allows you to reach all your spaces where you have Vocean Premium Leader rights. However, to be able to retrieve data from an activity you must also be a leader of the specified activity. (If you have a Leader license in a Vocean space you can access its [members page](https://app.vocean.com/#/network/members) and see if you have the Premium Leader license flag enabled on your membership.) |
14 | 14 |
|
15 | | -## Geting Started |
| 15 | +## Getting Started |
16 | 16 | --- |
17 | | -* Create an activity. Invite others to participate and await their contributions. |
18 | | -* Call the relevant action from the Connector (e.g. `GetIdeas` for an Innovate activity) and provide the activity id. The activity id is found from the activity's URL as the trailing guid after _/activity/_. |
| 17 | +* Call the relevant action from the Connector (for example, `Get ideas` for an Innovate activity) and in relevant cases choose the activity in the dropdown. Note: you then need to first choose the network to get a dropdown for activities. |
| 18 | + |
| 19 | +When needed: |
| 20 | +* Create an activity. |
| 21 | +* Invite others to participate and await their contributions. |
19 | 22 |
|
20 | 23 | ## Supported Operations |
21 | 24 | --- |
22 | 25 | The connector supports the following actions: |
23 | | -* `GetIdeas`: Get all the ideas for a specified Innovation activity in Vocean |
24 | | -* `GetVotes`: Get all the votes for a specified Vote activity in Vocean |
25 | | -* `GetExploreResponses`: Get all the responses for a specified Explore activity in Vocean |
| 26 | +* `Get spaces`: Get available spaces in Vocean |
| 27 | +* `Get activities`: Get available activities in Vocean, for the specified network |
| 28 | +* `Get ideas`: Get all the ideas and related data from a specified Innovate activity in Vocean |
| 29 | +* `Get votes`: Get all the votes from a specified Vote activity in Vocean |
| 30 | +* `Get explore responses`: Get all the responses from a specified Explore activity in Vocean |
| 31 | +* `Add idea`: Create an idea in a specific Vocean activity |
| 32 | +* `Add ideas`: Create ideas in a specific Vocean activity |
| 33 | + |
| 34 | +The connector supports the following triggers: |
| 35 | +* `When an idea is added or interacted with`: Triggers when an idea is added, or something happens to an existing idea |
| 36 | +* `When an activity's, or a workboard's, availability changes for the current user`: Triggers when something happens to an activity, or a workboard, that affects the current user's possibility to interact with the activity or workboard |
26 | 37 |
|
27 | 38 | ## Known Limitations |
28 | 39 | --- |
29 | | -The Data API has restrictions in terms of the size of the Response and returns a maximum of 1000 _items_. Note that the number of votes matches the number of respondents in Vote activities, while each idea and each response to a question in an Explore activity count as a separate item and the number of _respondents_ might be far less than 1000 if each respondent gives more than one idea or if there are more than one question in the Explore activity. (For Explore responses the maximum is actually slightly increased if 1000 is not evenly dividable by the number of questions in the activity.) |
| 40 | +The Data API has restrictions in terms of the size of the Response and returns a maximum of 1,000 _items_ for the ‘Get’ actions. Note that the number of votes matches the number of respondents in Vote activities, while each idea and each response to a question in an Explore activity count as a separate item and the number of _respondents_ might be far less than 1,000 if each respondent contributes with more than one idea or if there are more than one question in the Explore activity. (For Explore responses the maximum is actually slightly increased if 1,000 is not evenly dividable by the number of questions in the activity.) |
| 41 | + |
| 42 | +The dropdowns for spaces and activities are limited to 100 items. |
0 commit comments