Difference between revisions of "Release 25"
From UnionCloud Support
RebeccaMilne (talk | contribs) |
|||
| Line 1: | Line 1: | ||
| − | + | This page details the content that has been updated in the Union Cloud Release named in the title above, if you were looking for the content from a different Sprint, or Union Cloud Release, please take a look at the [[Version History]] page to see all Sprints and Releases.<br/> | |
Release 25: Find out what's coming next... | Release 25: Find out what's coming next... | ||
| Line 11: | Line 11: | ||
* Ability to delete pages etc. | * Ability to delete pages etc. | ||
* Other general improvements to how the 'Page Tree View' works. | * Other general improvements to how the 'Page Tree View' works. | ||
| + | |||
| + | ==Guest Checkout== | ||
| + | The release will allow the purchase of e-shop items and event tickets without the need for an account. As a result we are also moving the point at which you ‘sign in’ to the checkout. Unions can choose whether they want to turn this option on or off. This will mean a couple of things.<br/> | ||
| + | * If you are already signed in and go to an events page/the e-shop you will only see tickets/products available to signed in users and/or those tickets/products that you are eligible for. | ||
| + | * If you are not signed in you will only see those tickets/products that have been specifically made available to everyone. | ||
| + | * If you purchase a ticket/product as a guest, at checkout you will be asked to ‘sign in’ or ‘continue as a guest’. | ||
| + | * If you choose to ‘continue as guest’ then you will be asked to enter an email so we can send you a ticket/confirmation of purchase email and you will be added to a specific user group automatically. You will also be asked if you want to create an account on the confirmation of purchase page. | ||
| + | * If you choose to ‘continue as guest’ and you use an email address that is already registered then you will be notified of this and asked to ‘sign in’ although you can still ‘continue as guest’. | ||
| + | |||
| + | ==Improvements to the page tree== | ||
| + | The release will fix the following bugs as well as allow you to do the following:<br/> | ||
| + | * By default the page tree view will be collapsed and only the section(s) you choose to open will be expanded. | ||
| + | * When returning back from editing a page you will be taken to the section of the page tree view that you came from and not back to the start. | ||
| + | * You can add Sections/Pages/Links/Widgets/Subsite directly into the page tree view at whatever point you want (assuming to have permissions to). | ||
| + | * You can copy & paste Sections/Pages/Links/Widgets/Subsite straight into the page tree view at whatever point you want (assuming to have permissions to). This will copy all child elements if there are any (up to 300) as well as all the text/links etc. with those pages. | ||
| + | * You will be able to now delete a whole section and in doing this it will delete all its child elements. | ||
| + | |||
| + | ==Application Program Interface (APIs)== | ||
| + | There will be a suite of API’s for integration into UnionCloud, AdvicePro and Exchequer’s mobile expenses app that is being used by more and more by Clubs & Soc’s for the management of expenses. The info on the actual API’s in contained here: https://apiary.io/ if you create an account and then contact us via ZenDesk to let us know the email address used to create the account we can approve and give you access. There is loads of documentation on this and it will be a simple copy and paste job. That being said here is a short over view of each API. | ||
| + | |||
| + | ===Advice Pro=== | ||
| + | AdvicePro will be able to use the ‘GET '''/users'''’ API to be able to pull information from UnionCloud into their system on a student as they create a case for them. In time we will also be able to take a feed from them showing the appropriate case details in UnionCloud. | ||
| + | |||
| + | ===Exchequer=== | ||
| + | '''Authentication''' | ||
| + | * POST '''/authenticate''' - This service is required to authenticate the connection user and will generate an authentication token to allow external systems to call the UnionCloud API services. | ||
| + | |||
| + | '''Member/Group''' | ||
| + | * GET '''/getmemberfromemail''' - This service should be used to get basic details of a student user in the system and information on groups they are associated to and needs the authentication token generated by the authentication API response to be included for the request to be successful. | ||
| + | * GET '''/getgroup''' - This service should be used to get basic details of a group in the system with information on its committee members and needs the authentication token generated by the authentication API response to be included for the request to be successful. | ||
| + | |||
| + | ===UnionCloud=== | ||
| + | ====Authentication==== | ||
| + | * POST '''/authenticate''' - This service is required to authenticate the connection user and will generate an authentication token to allow external systems to call the UnionCloud API services. | ||
| + | ====Uploads==== | ||
| + | * POST '''/upload/students''' - This service should be used to upload student users into the system and needs the authentication token generated by the authentication API response to be included for the request to be successful. | ||
| + | * POST '''/upload/guests''' - This service should be used to upload guest users into the system and needs the authentication token generated by the authentication API response to be included for the request to be successful. | ||
| + | ====Users==== | ||
| + | * POST '''/users/search''' - This service should be used to search or return relevant details for any user(s) in UnionCloud and needs the authentication token generated by the authentication API response to be included for the request to be successful. | ||
| + | * GET '''/users''' - This service should be used to get relevant details (including user group associations) for any user in UnionCloud and needs the authentication token generated by the authentication API response to be included for the request to be successful. | ||
| + | * GET '''/users/{uid}/user_group_memberships''' - This service should be used to get user group membership details for a particular user group in the system and needs the authentication token generated by the authentication API response to be included for the request to be successful. | ||
| + | * PUT '''/users/{uid}''' - This service should be used to update details for any user in the system and needs the authentication token generated by the authentication API response to be included for the request to be successful. | ||
| + | * DELETE '''/users/{uid}''' - This service should be used to delete any user in UnionCloud and needs the authentication token generated by the authentication API response to be included for the request to be successful. | ||
| + | ====UserGroup and UserGroup Memberships==== | ||
| + | * POST '''/user_groups''' - This service should be used to create new user groups in the system and needs the authentication token generated by the authentication API response to be included for the request to be successful. | ||
| + | * PUT '''/user_groups/{ug_id}''' - This service should be used to update details for an existing user group in the system and needs the authentication token generated by the authentication API response to be included for the request to be successful. | ||
| + | * GET '''/user_groups/folderstructure''' - This service should be used to get the folder structure hierarchy of custom user groups in the system and needs the authentication token generated by the authentication API response to be included for the request to be successful. | ||
| + | * POST '''/user_group_memberships''' - This service should be used to create a user group membership for a particular user in a particular user group in the system and needs the authentication token generated by the authentication API response to be included for the request to be successful. | ||
| + | * POST '''/user_groups/search''' - This service should be used to search user groups in the system and needs the authentication token generated by the authentication API response to be included for the request to be successful. | ||
| + | * GET '''/user_groups''' - This service should be used to get all the user groups in the system and needs the authentication token generated by the authentication API response to be included for the request to be successful. | ||
| + | * GET '''/user_groups/{ug_id}''' - This service should be used to get the user group details of a specific user group and needs the authentication token generated by the authentication API response to be included for the request to be successful. | ||
| + | * GET '''/user_groups/{ug_id}/user_group_memberships''' - This request is to be used to get membership details about a specific user group in the system and needs the authentication token generated by the authentication API response to be included for the request to be successful. | ||
| + | * DELETE '''/user_groups/{ug_id}''' - This service should be used to delete a user group from the system and needs the authentication token generated by the authentication API response to be included for the request to be successful. | ||
| + | * PUT '''/user_group_memberships/{ugm_id}''' - This service should be used to update a user group membership record for a particular user in a particular user group in the system and needs the authentication token generated by the authentication API response to be included for the request to be successful. | ||
| + | * DELETE '''/user_group_memberships/{ugm_id}''' - This service should be used to delete a user group membership record from the system and needs the authentication token generated by the authentication API response to be included for the request to be successful. | ||
| + | ====Events==== | ||
| + | * GET '''/event_types''' - This service should be used to get the current event types as set by the NUS admin that can be used for creation of new events in the system and needs the authentication token generated by the authentication API response to be included for the request to be successful. | ||
| + | * GET '''/events''' - This service should be used to get details of all events set up in UnionCloud except their respective attendees’ information and needs the authentication token generated by the authentication API response to be included for the request to be successful. | ||
| + | * GET '''/events/{event_id}''' - This service should be used to get the details of a specific event set up in UnionCloud except the attendees’ information and needs the authentication token generated by the authentication API response to be included for the request to be successful. | ||
| + | * POST '''/events/search''' - This service should be used to search events in the system(useful when event_id is not known yet) and needs the authentication token generated by the authentication API response to be included for the request to be successful. | ||
| + | * POST '''/events''' - This service should be used to create a new event in the system and needs the authentication token generated by the authentication API response to be included for the request to be successful. | ||
| + | * POST '''/events/{event_id}/ticket_types''' - This service should be used to create a new ticket type for an existing event in the system and needs the authentication token generated by the authentication API response to be included for the request to be successful. | ||
| + | * POST '''/events/{event_id}/questions''' - This service should be used to create a new question for an existing event in the system and needs the authentication token generated by the authentication API response to be included for the request to be successful. | ||
| + | * PUT '''/events/{event_id}/cancel''' - This service should be used to cancel an event set up in UnionCloud and needs the authentication token generated by the authentication API response to be included for the request to be successful. Note that events cannot be deleted from the UnionCloud system. Using this method will cancel the referenced event. A cancel of an event is irreversible. | ||
| + | * PUT '''/events/{event_id}''' - This service should be used to update event details of an existing event and needs the authentication token generated by the authentication API response to be included for the request to be successful. | ||
| + | * PUT '''/events/{event_id}/ticket_types/{ticket_type_id}''' - This service should be used to update an existing ticket type for an existing event in the system and needs the authentication token generated by the authentication API response to be included for the request to be successful. | ||
| + | * PUT '''/events/{event_id}/questions/{question_id}''' - This service should be used to update an existing question for an existing event in the system and needs the authentication token generated by the authentication API response to be included for the request to be successful. | ||
| + | * DELETE '''/ticket_types/{ticket_type_id}''' - This service should be used to delete an existing ticket type for an existing event in the system and needs the authentication token generated by the authentication API response to be included for the request to be successful. | ||
| + | * DELETE '''/events/{event_id}/questions/{question_id}''' - This service should be used to delete an existing question for an existing event in the system and needs the authentication token generated by the authentication API response to be included for the request to be successful. | ||
| + | * GET '''/eventAttendees''' : This service should be used to get the current attendees’ details of an event set up in UnionCloud and needs the authentication token generated by the authentication API response to be included for the request to be successful. | ||
| + | ====Groups==== | ||
| + | Groups | ||
| + | * GET '''/groups''' - This service is used as a sync service to bring basic details about all groups and their respective group memberships as present in the system. | ||
Revision as of 15:11, 20 June 2016
This page details the content that has been updated in the Union Cloud Release named in the title above, if you were looking for the content from a different Sprint, or Union Cloud Release, please take a look at the Version History page to see all Sprints and Releases.
Release 25: Find out what's coming next...
The next major UnionCloud update will be released 25th June. There are a number of big features included in this release such as:
- A suite of 22 APIs centered mainly around Users, UserGroups and UserGroup Memberships & Events. Descriptions of all of the API's as well as example code will be shared here.
- Integration into the Exchequer Expense365 App
- Integration into AdvicePro
- The ability for people to buy tickets or eshop items without having to sign in or have an account ie. Guest Purchases.
- Ability to copy & paste Subsites, Pages, Links and Widgets.
- Ability to delete pages etc.
- Other general improvements to how the 'Page Tree View' works.
Contents
Guest Checkout
The release will allow the purchase of e-shop items and event tickets without the need for an account. As a result we are also moving the point at which you ‘sign in’ to the checkout. Unions can choose whether they want to turn this option on or off. This will mean a couple of things.
- If you are already signed in and go to an events page/the e-shop you will only see tickets/products available to signed in users and/or those tickets/products that you are eligible for.
- If you are not signed in you will only see those tickets/products that have been specifically made available to everyone.
- If you purchase a ticket/product as a guest, at checkout you will be asked to ‘sign in’ or ‘continue as a guest’.
- If you choose to ‘continue as guest’ then you will be asked to enter an email so we can send you a ticket/confirmation of purchase email and you will be added to a specific user group automatically. You will also be asked if you want to create an account on the confirmation of purchase page.
- If you choose to ‘continue as guest’ and you use an email address that is already registered then you will be notified of this and asked to ‘sign in’ although you can still ‘continue as guest’.
Improvements to the page tree
The release will fix the following bugs as well as allow you to do the following:
- By default the page tree view will be collapsed and only the section(s) you choose to open will be expanded.
- When returning back from editing a page you will be taken to the section of the page tree view that you came from and not back to the start.
- You can add Sections/Pages/Links/Widgets/Subsite directly into the page tree view at whatever point you want (assuming to have permissions to).
- You can copy & paste Sections/Pages/Links/Widgets/Subsite straight into the page tree view at whatever point you want (assuming to have permissions to). This will copy all child elements if there are any (up to 300) as well as all the text/links etc. with those pages.
- You will be able to now delete a whole section and in doing this it will delete all its child elements.
Application Program Interface (APIs)
There will be a suite of API’s for integration into UnionCloud, AdvicePro and Exchequer’s mobile expenses app that is being used by more and more by Clubs & Soc’s for the management of expenses. The info on the actual API’s in contained here: https://apiary.io/ if you create an account and then contact us via ZenDesk to let us know the email address used to create the account we can approve and give you access. There is loads of documentation on this and it will be a simple copy and paste job. That being said here is a short over view of each API.
Advice Pro
AdvicePro will be able to use the ‘GET /users’ API to be able to pull information from UnionCloud into their system on a student as they create a case for them. In time we will also be able to take a feed from them showing the appropriate case details in UnionCloud.
Exchequer
Authentication
- POST /authenticate - This service is required to authenticate the connection user and will generate an authentication token to allow external systems to call the UnionCloud API services.
Member/Group
- GET /getmemberfromemail - This service should be used to get basic details of a student user in the system and information on groups they are associated to and needs the authentication token generated by the authentication API response to be included for the request to be successful.
- GET /getgroup - This service should be used to get basic details of a group in the system with information on its committee members and needs the authentication token generated by the authentication API response to be included for the request to be successful.
UnionCloud
Authentication
- POST /authenticate - This service is required to authenticate the connection user and will generate an authentication token to allow external systems to call the UnionCloud API services.
Uploads
- POST /upload/students - This service should be used to upload student users into the system and needs the authentication token generated by the authentication API response to be included for the request to be successful.
- POST /upload/guests - This service should be used to upload guest users into the system and needs the authentication token generated by the authentication API response to be included for the request to be successful.
Users
- POST /users/search - This service should be used to search or return relevant details for any user(s) in UnionCloud and needs the authentication token generated by the authentication API response to be included for the request to be successful.
- GET /users - This service should be used to get relevant details (including user group associations) for any user in UnionCloud and needs the authentication token generated by the authentication API response to be included for the request to be successful.
- GET /users/{uid}/user_group_memberships - This service should be used to get user group membership details for a particular user group in the system and needs the authentication token generated by the authentication API response to be included for the request to be successful.
- PUT /users/{uid} - This service should be used to update details for any user in the system and needs the authentication token generated by the authentication API response to be included for the request to be successful.
- DELETE /users/{uid} - This service should be used to delete any user in UnionCloud and needs the authentication token generated by the authentication API response to be included for the request to be successful.
UserGroup and UserGroup Memberships
- POST /user_groups - This service should be used to create new user groups in the system and needs the authentication token generated by the authentication API response to be included for the request to be successful.
- PUT /user_groups/{ug_id} - This service should be used to update details for an existing user group in the system and needs the authentication token generated by the authentication API response to be included for the request to be successful.
- GET /user_groups/folderstructure - This service should be used to get the folder structure hierarchy of custom user groups in the system and needs the authentication token generated by the authentication API response to be included for the request to be successful.
- POST /user_group_memberships - This service should be used to create a user group membership for a particular user in a particular user group in the system and needs the authentication token generated by the authentication API response to be included for the request to be successful.
- POST /user_groups/search - This service should be used to search user groups in the system and needs the authentication token generated by the authentication API response to be included for the request to be successful.
- GET /user_groups - This service should be used to get all the user groups in the system and needs the authentication token generated by the authentication API response to be included for the request to be successful.
- GET /user_groups/{ug_id} - This service should be used to get the user group details of a specific user group and needs the authentication token generated by the authentication API response to be included for the request to be successful.
- GET /user_groups/{ug_id}/user_group_memberships - This request is to be used to get membership details about a specific user group in the system and needs the authentication token generated by the authentication API response to be included for the request to be successful.
- DELETE /user_groups/{ug_id} - This service should be used to delete a user group from the system and needs the authentication token generated by the authentication API response to be included for the request to be successful.
- PUT /user_group_memberships/{ugm_id} - This service should be used to update a user group membership record for a particular user in a particular user group in the system and needs the authentication token generated by the authentication API response to be included for the request to be successful.
- DELETE /user_group_memberships/{ugm_id} - This service should be used to delete a user group membership record from the system and needs the authentication token generated by the authentication API response to be included for the request to be successful.
Events
- GET /event_types - This service should be used to get the current event types as set by the NUS admin that can be used for creation of new events in the system and needs the authentication token generated by the authentication API response to be included for the request to be successful.
- GET /events - This service should be used to get details of all events set up in UnionCloud except their respective attendees’ information and needs the authentication token generated by the authentication API response to be included for the request to be successful.
- GET /events/{event_id} - This service should be used to get the details of a specific event set up in UnionCloud except the attendees’ information and needs the authentication token generated by the authentication API response to be included for the request to be successful.
- POST /events/search - This service should be used to search events in the system(useful when event_id is not known yet) and needs the authentication token generated by the authentication API response to be included for the request to be successful.
- POST /events - This service should be used to create a new event in the system and needs the authentication token generated by the authentication API response to be included for the request to be successful.
- POST /events/{event_id}/ticket_types - This service should be used to create a new ticket type for an existing event in the system and needs the authentication token generated by the authentication API response to be included for the request to be successful.
- POST /events/{event_id}/questions - This service should be used to create a new question for an existing event in the system and needs the authentication token generated by the authentication API response to be included for the request to be successful.
- PUT /events/{event_id}/cancel - This service should be used to cancel an event set up in UnionCloud and needs the authentication token generated by the authentication API response to be included for the request to be successful. Note that events cannot be deleted from the UnionCloud system. Using this method will cancel the referenced event. A cancel of an event is irreversible.
- PUT /events/{event_id} - This service should be used to update event details of an existing event and needs the authentication token generated by the authentication API response to be included for the request to be successful.
- PUT /events/{event_id}/ticket_types/{ticket_type_id} - This service should be used to update an existing ticket type for an existing event in the system and needs the authentication token generated by the authentication API response to be included for the request to be successful.
- PUT /events/{event_id}/questions/{question_id} - This service should be used to update an existing question for an existing event in the system and needs the authentication token generated by the authentication API response to be included for the request to be successful.
- DELETE /ticket_types/{ticket_type_id} - This service should be used to delete an existing ticket type for an existing event in the system and needs the authentication token generated by the authentication API response to be included for the request to be successful.
- DELETE /events/{event_id}/questions/{question_id} - This service should be used to delete an existing question for an existing event in the system and needs the authentication token generated by the authentication API response to be included for the request to be successful.
- GET /eventAttendees : This service should be used to get the current attendees’ details of an event set up in UnionCloud and needs the authentication token generated by the authentication API response to be included for the request to be successful.
Groups
Groups
- GET /groups - This service is used as a sync service to bring basic details about all groups and their respective group memberships as present in the system.
