|
GET – returns an OPML outline of one-to-many locations currently configured for this user
|
|
Upon user account creation, four default locations are defined: NewsGator Web Edition, NewsGator Media Center Edition, NewsGator POP Edition, and NewsGator Mobile Edition. A Location allows a user to create distinct subscription lists for various devices/applications that synchronize with NewsGator. For example, a user can create a Location for a Mobile device and can edit that location to synchronize a subset of their subscriptions. A Location can also be used to control which articles are displayed in NewsGator Headlines or which subscriptions display in a BlogRoll.
|
|
The OPML that is returned in the output defines each Location in a single outline element. Each outline whether it is a default NewsGator Location or a user created location contain several properties describing the Location. For instance, ng:autoAddSubs defines if subscriptions are automatically added to this location even if the subscription was first added to another location. Another important property is ng:isPublic which defines if the OPML for this specific location is accessible to the public. The url property defines the endpoint for this location that can be used for PUT and DELETE operations. |
|
This endpoint requires a NewsGator API Token. If you do not have one, you can get one for free here: Free NewsGator API Token |
- request.Credentials = ICredentials networkCreds
- request.Headers["X-NGAPIToken"] = NewsGatorAPIToken
- request.ContentType = "application/xml; charset=utf-8"
- request.Method = GET
|
|
Example Output: <?xml version="1.0" encoding="utf-8"?> <opml xmlns:ng="http://newsgator.com/schema/opml"> <head> <title>NewsGator Locations</title> </head> <body> <outline text="NewsGator Web Edition" ng:id="1" type="link" url="http://72.244.167.86/ngws/svc/Location.aspx/1" ng:autoAddSubs="True" ng:isPublic="True" /> <outline text="NewsGator Media Center Edition" ng:id="2" type="link" url="http://72.244.167.86/ngws/svc/Location.aspx/2" ng:autoAddSubs="True" ng:isPublic="False" /> <outline text="NewsGator POP Edition" ng:id="3" type="link" url="http://72.244.167.86/ngws/svc/Location.aspx/3" ng:autoAddSubs="True" ng:isPublic="False" /> <outline text="NewsGator Mobile Edition" ng:id="4" type="link" url="http://72.244.167.86/ngws/svc/Location.aspx/4" ng:autoAddSubs="True" ng:isPublic="False" /> </body> </opml> |