Re: Documentation for notification API

classic Classic list List threaded Threaded
3 messages Options
Reply | Threaded
Open this post in threaded view
|

Re: Documentation for notification API

Drew Wills

Daniel,

I can offer these examples:

  - https://github.com/Jasig/NotificationPortlet/tree/master/notification-portlet-webapp/src/main/resources/demo

drew

On 10/26/18 2:23 PM, Daniel Rodziewicz wrote:
We are looking to implement a notification API for the notification portlet. 
The docs here state that when overriding the  RestfulJsonNotificationService.serviceUrls property each notification should be in the 'standard Notification JSON format.' 
Will someone point me to some documentation for this format? I have checked the old wiki pages and the only thing I found this. Is there further documentation which 
describes the finalized api and the JSON responses? 

Thanks  
--
You received this message because you are subscribed to the Google Groups "uPortal Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
Visit this group at https://groups.google.com/a/apereo.org/group/uportal-dev/.

--
You received this message because you are subscribed to the Google Groups "uPortal Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
Visit this group at https://groups.google.com/a/apereo.org/group/uportal-dev/.
Reply | Threaded
Open this post in threaded view
|

Re: Documentation for notification API

Daniel Rodziewicz
Thanks. 

These examples are great. Can you tell me what the URLs look like to get the notifications? 

Thanks 

Dan 

On Friday, October 26, 2018 at 4:46:29 PM UTC-6, awills wrote:

Daniel,

I can offer these examples:

  - <a href="https://github.com/Jasig/NotificationPortlet/tree/master/notification-portlet-webapp/src/main/resources/demo" target="_blank" rel="nofollow" onmousedown="this.href=&#39;https://www.google.com/url?q\x3dhttps%3A%2F%2Fgithub.com%2FJasig%2FNotificationPortlet%2Ftree%2Fmaster%2Fnotification-portlet-webapp%2Fsrc%2Fmain%2Fresources%2Fdemo\x26sa\x3dD\x26sntz\x3d1\x26usg\x3dAFQjCNHZj_lKundW73q9pG0FGgbM3Bm_kg&#39;;return true;" onclick="this.href=&#39;https://www.google.com/url?q\x3dhttps%3A%2F%2Fgithub.com%2FJasig%2FNotificationPortlet%2Ftree%2Fmaster%2Fnotification-portlet-webapp%2Fsrc%2Fmain%2Fresources%2Fdemo\x26sa\x3dD\x26sntz\x3d1\x26usg\x3dAFQjCNHZj_lKundW73q9pG0FGgbM3Bm_kg&#39;;return true;">https://github.com/Jasig/NotificationPortlet/tree/master/notification-portlet-webapp/src/main/resources/demo

drew

On 10/26/18 2:23 PM, Daniel Rodziewicz wrote:
We are looking to implement a notification API for the notification portlet. 
The docs <a href="https://github.com/Jasig/NotificationPortlet" target="_blank" rel="nofollow" onmousedown="this.href=&#39;https://www.google.com/url?q\x3dhttps%3A%2F%2Fgithub.com%2FJasig%2FNotificationPortlet\x26sa\x3dD\x26sntz\x3d1\x26usg\x3dAFQjCNG0RRAh-Lg2eB0Y5gfjHtHurUr0RQ&#39;;return true;" onclick="this.href=&#39;https://www.google.com/url?q\x3dhttps%3A%2F%2Fgithub.com%2FJasig%2FNotificationPortlet\x26sa\x3dD\x26sntz\x3d1\x26usg\x3dAFQjCNG0RRAh-Lg2eB0Y5gfjHtHurUr0RQ&#39;;return true;">here state that when overriding the  RestfulJsonNotificationService.serviceUrls property each notification should be in the 'standard Notification JSON format.' 
Will someone point me to some documentation for this format? I have checked the old wiki pages and the only thing I found <a href="https://apereo.atlassian.net/wiki/spaces/PLT/pages/101548135/Notifications+RESTful+API" target="_blank" rel="nofollow" onmousedown="this.href=&#39;https://www.google.com/url?q\x3dhttps%3A%2F%2Fapereo.atlassian.net%2Fwiki%2Fspaces%2FPLT%2Fpages%2F101548135%2FNotifications%2BRESTful%2BAPI\x26sa\x3dD\x26sntz\x3d1\x26usg\x3dAFQjCNFHaZNK9OlmKHClGUIpsX5iOGP96g&#39;;return true;" onclick="this.href=&#39;https://www.google.com/url?q\x3dhttps%3A%2F%2Fapereo.atlassian.net%2Fwiki%2Fspaces%2FPLT%2Fpages%2F101548135%2FNotifications%2BRESTful%2BAPI\x26sa\x3dD\x26sntz\x3d1\x26usg\x3dAFQjCNFHaZNK9OlmKHClGUIpsX5iOGP96g&#39;;return true;">this. Is there further documentation which 
describes the finalized api and the JSON responses? 

Thanks  
--
You received this message because you are subscribed to the Google Groups "uPortal Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to <a href="javascript:" target="_blank" gdf-obfuscated-mailto="cBEeiOB5AQAJ" rel="nofollow" onmousedown="this.href=&#39;javascript:&#39;;return true;" onclick="this.href=&#39;javascript:&#39;;return true;">uportal-dev...@apereo.org.
Visit this group at <a href="https://groups.google.com/a/apereo.org/group/uportal-dev/" target="_blank" rel="nofollow" onmousedown="this.href=&#39;https://groups.google.com/a/apereo.org/group/uportal-dev/&#39;;return true;" onclick="this.href=&#39;https://groups.google.com/a/apereo.org/group/uportal-dev/&#39;;return true;">https://groups.google.com/a/apereo.org/group/uportal-dev/.

--
You received this message because you are subscribed to the Google Groups "uPortal Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
Visit this group at https://groups.google.com/a/apereo.org/group/uportal-dev/.
Reply | Threaded
Open this post in threaded view
|

Re: Documentation for notification API

Daniel Rodziewicz
Thanks 

On Monday, October 29, 2018 at 11:17:23 AM UTC-6, awills wrote:

Daniel,

The new method uses the following URI:  /NotificationPortlet/api/v2/notifications

  - <a href="https://github.com/Jasig/NotificationPortlet/blob/master/notification-portlet-webapp/src/main/java/org/jasig/portlet/notice/controller/rest/NotificationRestV2Controller.java#L73" target="_blank" rel="nofollow" onmousedown="this.href=&#39;https://www.google.com/url?q\x3dhttps%3A%2F%2Fgithub.com%2FJasig%2FNotificationPortlet%2Fblob%2Fmaster%2Fnotification-portlet-webapp%2Fsrc%2Fmain%2Fjava%2Forg%2Fjasig%2Fportlet%2Fnotice%2Fcontroller%2Frest%2FNotificationRestV2Controller.java%23L73\x26sa\x3dD\x26sntz\x3d1\x26usg\x3dAFQjCNHo9aoK4j5HU5ntbu03sRirHhh5Xw&#39;;return true;" onclick="this.href=&#39;https://www.google.com/url?q\x3dhttps%3A%2F%2Fgithub.com%2FJasig%2FNotificationPortlet%2Fblob%2Fmaster%2Fnotification-portlet-webapp%2Fsrc%2Fmain%2Fjava%2Forg%2Fjasig%2Fportlet%2Fnotice%2Fcontroller%2Frest%2FNotificationRestV2Controller.java%23L73\x26sa\x3dD\x26sntz\x3d1\x26usg\x3dAFQjCNHo9aoK4j5HU5ntbu03sRirHhh5Xw&#39;;return true;">https://github.com/Jasig/NotificationPortlet/blob/master/notification-portlet-webapp/src/main/java/org/jasig/portlet/notice/controller/rest/NotificationRestV2Controller.java#L73

This is a Servlet API-based REST endpoint that accepts an OAuth2/OIDC Id Token for security.  (You can obtain one of those from /uPortal/api/v5-1/userinfo.)

drew



On 10/29/18 7:32 AM, Daniel Rodziewicz wrote:
Thanks. 

These examples are great. Can you tell me what the URLs look like to get the notifications? 

Thanks 

Dan 

On Friday, October 26, 2018 at 4:46:29 PM UTC-6, awills wrote:

Daniel,

I can offer these examples:

  - <a href="https://github.com/Jasig/NotificationPortlet/tree/master/notification-portlet-webapp/src/main/resources/demo" rel="nofollow" target="_blank" onmousedown="this.href=&#39;https://www.google.com/url?q\x3dhttps%3A%2F%2Fgithub.com%2FJasig%2FNotificationPortlet%2Ftree%2Fmaster%2Fnotification-portlet-webapp%2Fsrc%2Fmain%2Fresources%2Fdemo\x26sa\x3dD\x26sntz\x3d1\x26usg\x3dAFQjCNHZj_lKundW73q9pG0FGgbM3Bm_kg&#39;;return true;" onclick="this.href=&#39;https://www.google.com/url?q\x3dhttps%3A%2F%2Fgithub.com%2FJasig%2FNotificationPortlet%2Ftree%2Fmaster%2Fnotification-portlet-webapp%2Fsrc%2Fmain%2Fresources%2Fdemo\x26sa\x3dD\x26sntz\x3d1\x26usg\x3dAFQjCNHZj_lKundW73q9pG0FGgbM3Bm_kg&#39;;return true;">https://github.com/Jasig/NotificationPortlet/tree/master/notification-portlet-webapp/src/main/resources/demo

drew

On 10/26/18 2:23 PM, Daniel Rodziewicz wrote:
We are looking to implement a notification API for the notification portlet. 
The docs <a href="https://github.com/Jasig/NotificationPortlet" rel="nofollow" target="_blank" onmousedown="this.href=&#39;https://www.google.com/url?q\x3dhttps%3A%2F%2Fgithub.com%2FJasig%2FNotificationPortlet\x26sa\x3dD\x26sntz\x3d1\x26usg\x3dAFQjCNG0RRAh-Lg2eB0Y5gfjHtHurUr0RQ&#39;;return true;" onclick="this.href=&#39;https://www.google.com/url?q\x3dhttps%3A%2F%2Fgithub.com%2FJasig%2FNotificationPortlet\x26sa\x3dD\x26sntz\x3d1\x26usg\x3dAFQjCNG0RRAh-Lg2eB0Y5gfjHtHurUr0RQ&#39;;return true;">here state that when overriding the  RestfulJsonNotificationService.serviceUrls property each notification should be in the 'standard Notification JSON format.' 
Will someone point me to some documentation for this format? I have checked the old wiki pages and the only thing I found <a href="https://apereo.atlassian.net/wiki/spaces/PLT/pages/101548135/Notifications+RESTful+API" rel="nofollow" target="_blank" onmousedown="this.href=&#39;https://www.google.com/url?q\x3dhttps%3A%2F%2Fapereo.atlassian.net%2Fwiki%2Fspaces%2FPLT%2Fpages%2F101548135%2FNotifications%2BRESTful%2BAPI\x26sa\x3dD\x26sntz\x3d1\x26usg\x3dAFQjCNFHaZNK9OlmKHClGUIpsX5iOGP96g&#39;;return true;" onclick="this.href=&#39;https://www.google.com/url?q\x3dhttps%3A%2F%2Fapereo.atlassian.net%2Fwiki%2Fspaces%2FPLT%2Fpages%2F101548135%2FNotifications%2BRESTful%2BAPI\x26sa\x3dD\x26sntz\x3d1\x26usg\x3dAFQjCNFHaZNK9OlmKHClGUIpsX5iOGP96g&#39;;return true;">this. Is there further documentation which 
describes the finalized api and the JSON responses? 

Thanks  
--
You received this message because you are subscribed to the Google Groups "uPortal Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
Visit this group at <a href="https://groups.google.com/a/apereo.org/group/uportal-dev/" rel="nofollow" target="_blank" onmousedown="this.href=&#39;https://groups.google.com/a/apereo.org/group/uportal-dev/&#39;;return true;" onclick="this.href=&#39;https://groups.google.com/a/apereo.org/group/uportal-dev/&#39;;return true;">https://groups.google.com/a/apereo.org/group/uportal-dev/.
--
You received this message because you are subscribed to the Google Groups "uPortal Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to <a href="javascript:" target="_blank" gdf-obfuscated-mailto="5n8VsKhTAgAJ" rel="nofollow" onmousedown="this.href=&#39;javascript:&#39;;return true;" onclick="this.href=&#39;javascript:&#39;;return true;">uportal-dev...@apereo.org.
Visit this group at <a href="https://groups.google.com/a/apereo.org/group/uportal-dev/" target="_blank" rel="nofollow" onmousedown="this.href=&#39;https://groups.google.com/a/apereo.org/group/uportal-dev/&#39;;return true;" onclick="this.href=&#39;https://groups.google.com/a/apereo.org/group/uportal-dev/&#39;;return true;">https://groups.google.com/a/apereo.org/group/uportal-dev/.

--
You received this message because you are subscribed to the Google Groups "uPortal Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
Visit this group at https://groups.google.com/a/apereo.org/group/uportal-dev/.