Pond

Pond

Pond is a social media aggregator and publisher that allows you to follow your friends.

Free subscription

Technical Overview

Pond/v1_1 Service

Pond is a social media aggregator and publisher that allows you to follow your friends, collect information about them and share your own content in some of the most popular online social content services available. In Pond you decide what content you want to see and your friends don't even have to use Pond. As long as you can add them as contacts in any of the services Pond supports or they provide a feed (eg., a blog RSS feed), you can add them to Pond and follow their stuff.

API Reference

Service Operation Description
Pond/v1_1 AddDataSourceToEntityJSON Adds a data source to an existing entity. 'EntityID'=> 'type'=>'id' [Required] 'ServiceID','type'=>'int'[Required] 'URL','type'=>'URL' [Required] Description = AlfaNumeric [Optional]
AddDataSourceToEntityXML Adds a data source to an existing entity. 'EntityID'=> 'type'=>'id' [Required] 'ServiceID','type'=>'int'[Required] 'URL','type'=>'URL' [Required] Description = AlfaNumeric [Optional]
AddMyDataSourceJSON Add a DataSource to the Entity which represents the user, creating the associated Author.
AddMyDataSourceXML Add a DataSource to the Entity which represents the user, creating the associated Author.
CreateAccountAuthenticationForServiceJSON Creates an account for a service and returns an authorization URL for OAuth or similar. Parameters: AuthToken=Alphanumeric [Required] ServiceID=int [Required] Description=Alphanumeric [Optional]
CreateAccountAuthenticationForServiceXML Creates an account for a service and returns an authorization URL for OAuth or similar. Parameters: AuthToken=Alphanumeric [Required] ServiceID=int [Required] Description=Alphanumeric [Optional]
DeleteAccountJSON Deletes the account, as well as any associated events and authors. If Entity was only linked to this account it'll also be deleted. Parameters: AuthToken=Alphanumeric [Required] AccountID: ID [Required]
DeleteAccountXML Deletes the account, as well as any associated events and authors. If Entity was only linked to this account it'll also be deleted. Parameters: AuthToken=Alphanumeric [Required] AccountID: ID [Required]
DeleteDataSourceJSON Remove a DataSource from the current user account.
DeleteDataSourceXML Remove a DataSource from the current user account.
DeleteEntityJSON Deletes an Entity.
DeleteEntityXML Deletes an Entity.
DeleteSystemMessageJSON Deletes the system message with specified ID. Parameters: MessageID = ID [Required]
DeleteSystemMessageXML Deletes the system message with specified ID. Parameters: MessageID = ID [Required]
DeleteViewJSON Delete view.
DeleteViewXML Delete view.
DiscoverDataSourcesForURLJSON Returns a list of feed URLs resulting from autodiscovery on the given URL. This service is asynchronous. Results are cached. Call to service will return proper results if already cached. Otherwise, forks a child to do the discovery and returns with a 202 Result Status. Clients should retry until they get a proper response. Parameters: AuthToken=Alphanumeric [Required] URL=Alphanumeric [Required]
DiscoverDataSourcesForURLXML Returns a list of feed URLs resulting from autodiscovery on the given URL. This service is asynchronous. Results are cached. Call to service will return proper results if already cached. Otherwise, forks a child to do the discovery and returns with a 202 Result Status. Clients should retry until they get a proper response. Parameters: AuthToken=Alphanumeric [Required] URL=Alphanumeric [Required]
DissociateDataSourceFromEntityJSON Dissociates an entity from a DataSource(account only) and all its authors. If there are no more entities belonging to this datasource, all its associations will be removed. Otherwise the authors will be aggregated to the default Entity. If this is the default entity, then a new default Entity will be chosen. Parameters: AuthToken = Alphanumeric [Required] EntityID = ID [Required] DataSourceID = ID [Required]
DissociateDataSourceFromEntityXML Dissociates an entity from a DataSource(account only) and all its authors. If there are no more entities belonging to this datasource, all its associations will be removed. Otherwise the authors will be aggregated to the default Entity. If this is the default entity, then a new default Entity will be chosen. Parameters: AuthToken = Alphanumeric [Required] EntityID = ID [Required] DataSourceID = ID [Required]
GetAuthTokenJSON Returns a security token, valid for a period of 12 hours, for a valid UserName and Password. Username=Alfa [Required] Password=Alfa [Required]
GetAuthTokenXML Returns a security token, valid for a period of 12 hours, for a valid UserName and Password. Username=Alfa [Required] Password=Alfa [Required]
GetEventJSON Gets events full contents Parameters: AuthToken = token [Required] EventIDs = ID [Required] CurrPage = Int [Optional] RowsPage = Int [Optional]
GetEventXML Gets events full contents Parameters: AuthToken = token [Required] EventIDs = ID [Required] CurrPage = Int [Optional] RowsPage = Int [Optional]
GetUserJSON Returns user profile if user exists
GetUserXML Returns user profile if user exists
GetViewJSON Returns filters from view id.
GetViewXML Returns filters from view id.
ListAccountsJSON Returns all content of required accounts. Parameters: AuthToken = token [Required] ServiceIDs = IDs [Optional] CurrPage = Int [Optional] RowsPage = Int [Optional]
ListAccountsXML Returns all content for requested accountsParameters: AuthToken = token [Required] ServiceIDs = IDs [Required] CurrPage = Int [Optional] RowsPage = Int [Optional]
ListCommentsJSON Lists all comments from event in JSON format. Parameters: AuthToken = token [Required] EventID = ID [Required]
ListCommentsXML Lists all comments from event in XML format. Parameters: AuthToken = token [Required] EventID = ID [Required]
ListEntitiesJSON Lists all entities which fit the filter parameters. Parameters: AuthToken = token [Required] ServiceIDs = IDs [Optional] EntityIDs = IDs [Optional] FirstLetter= Alfa [Optional] Temporary = boolean [Optional] CurrPage = Int [Optional] RowsPage = Int [Optional]
ListEntitiesXML Lists all entities which fit the filter parameters. Parameters: AuthToken = token [Required] ServiceIDs = IDs [Optional] EntityIDs = IDs [Optional] FirstLetter= Alfa [Optional] Temporary = boolean [Optional] CurrPage = Int [Optional] RowsPage = Int [Optional]
ListEventsForMeJSON Lists events which are directed at the user, filtered by the given parameters. Parameters: AuthToken = token [Required] EventIDs = IDs [Optional] OnlyFavorites = boolean [Optional] OnlyUnRead = boolean [Optional] ServiceIDs= IDs [Optional] ExceptServiceIDs = IDs [Optional] DataSourceIDs = IDs [Optional] ExceptDataSourceIDs = IDs [Optional] CurrPage = Int [Optional] RowsPage = Int [Optional]
ListEventsForMeXML Lists events which are directed at the user, filtered by the given parameters. Parameters: AuthToken = token [Required] EventIDs = IDs [Optional] OnlyUnRead = boolean [Optional] OnlyFavorites = boolean [Optional] ServiceIDs= IDs [Optional] ExceptServiceIDs = IDs [Optional] DataSourceIDs = IDs [Optional] ExceptDataSourceIDs = IDs [Optional] CurrPage = Int [Optional] RowsPage = Int [Optional]
ListEventsJSON Lists all events, filtered by the given parameters. Parameters: AuthToken = token [Required] EventIDs = IDs [Optional] OnlyFavorites = boolean [Optional] OnlyUnRead= boolean [Optional] ServiceIDs= IDs [Optional] ExceptServiceIDs = IDs [Optional] DataSourceIDs = IDs [Optional] ExceptDataSourceIDs = IDs [Optional] EntityIDs = IDs [Optional] CurrPage = Int [Optional] RowsPage = Int [Optional]
ListEventsXML Lists all events, filtered by the given parameters. Parameters: AuthToken = token [Required] EventIDs = IDs [Optional] OnlyFavorites = boolean [Optional] OnlyUnRead= boolean [Optional] ServiceIDs= IDs [Optional] ExceptServiceIDs = IDs [Optional] DataSourceIDs = IDs [Optional] ExceptDataSourceIDs = IDs [Optional] EntityIDs = IDs [Optional] CurrPage = Int [Optional] RowsPage = Int [Optional]
ListMyAuthorsAndDataSourcesJSON Lists all information (datasources, authors), associated with the user's entity. Parameters: AuthToken = token [Required]
ListMyAuthorsAndDataSourcesXML Lists all information(datasources,authors), relating to my entity. Parameters: AuthToken = token [Required]
ListMyEventsJSON Lists events, filtered by the given parameters, which seem to be from the user specifically.Parameters: AuthToken = token [Required] EventIDs = IDs [Optional] OnlyFavorites = boolean [Optional] OnlyUnRead = boolean [Optional] ServiceIDs= IDs [Optional] ExceptServiceIDs = IDs [Optional] DataSourceIDs = IDs [Optional] ExceptDataSourceIDs = IDs [Optional] CurrPage = Int [Optional] RowsPage = Int [Optional]
ListMyEventsXML Lists events, filtered by the given parameters, which seem to be from the user specifically.Parameters: AuthToken = token [Required] EventIDs = IDs [Optional] OnlyFavorites = boolean [Optional] OnlyUnRead = boolean [Optional] ServiceIDs= IDs [Optional] ExceptServiceIDs = IDs [Optional] DataSourceIDs = IDs [Optional] ExceptDataSourceIDs = IDs [Optional] CurrPage = Int [Optional] RowsPage = Int [Optional]
ListMyNewerEventsJSON Lists newer events, filtered by the given parameters, which seem to be from the user specifically.Parameters: AuthToken = token [Required] FromEventID = ID [Required] EventIDs = IDs [Optional] OnlyFavorites = boolean [Optional] OnlyUnRead = boolean [Optional] ServiceIDs= IDs [Optional] ExceptServiceIDs = IDs [Optional] DataSourceIDs = IDs [Optional] ExceptDataSourceIDs = IDs [Optional] CurrPage = Int [Optional] RowsPage = Int [Optional]
ListMyNewerEventsXML Lists newer events, filtered by the given parameters, which seem to be from the user specifically.Parameters: AuthToken = token [Required] FromEventID = ID [Required] EventIDs = IDs [Optional] OnlyFavorites = boolean [Optional] OnlyUnRead = boolean [Optional] ServiceIDs= IDs [Optional] ExceptServiceIDs = IDs [Optional] DataSourceIDs = IDs [Optional] ExceptDataSourceIDs = IDs [Optional] CurrPage = Int [Optional] RowsPage = Int [Optional]
ListMyOlderEventsJSON Lists older events, filtered by the given parameters, which seem to be from the user specifically.Parameters: AuthToken = token [Required] FromEventID = ID [Required] EventIDs = IDs [Optional] OnlyFavorites = boolean [Optional] OnlyUnRead = boolean [Optional] ServiceIDs= IDs [Optional] ExceptServiceIDs = IDs [Optional] DataSourceIDs = IDs [Optional] ExceptDataSourceIDs = IDs [Optional] CurrPage = Int [Optional] RowsPage = Int [Optional]
ListMyOlderEventsXML Lists older events, filtered by the given parameters, which seem to be from the user specifically.Parameters: AuthToken = token [Required] FromEventID = ID [Required] EventIDs = IDs [Optional] OnlyFavorites = boolean [Optional] OnlyUnRead = boolean [Optional] ServiceIDs= IDs [Optional] ExceptServiceIDs = IDs [Optional] DataSourceIDs = IDs [Optional] ExceptDataSourceIDs = IDs [Optional] CurrPage = Int [Optional] RowsPage = Int [Optional]
ListNewerEventsForMeJSON Lists newer events which are directed at the user, filtered by the given parameters. Parameters: AuthToken = token [Required] FromEventID = ID [Required] EventIDs = IDs [Optional] OnlyFavorites = boolean [Optional] OnlyUnRead = boolean [Optional] ServiceIDs= IDs [Optional] ExceptServiceIDs = IDs [Optional] DataSourceIDs = IDs [Optional] ExceptDataSourceIDs = IDs [Optional] CurrPage = Int [Optional] RowsPage = Int [Optional]
ListNewerEventsForMeXML Lists newer events which are directed at the user, filtered by the given parameters. Parameters: AuthToken = token [Required] FromEventID = ID [Required] EventIDs = IDs [Optional] OnlyFavorites = boolean [Optional] OnlyUnRead = boolean [Optional] ServiceIDs= IDs [Optional] ExceptServiceIDs = IDs [Optional] DataSourceIDs = IDs [Optional] ExceptDataSourceIDs = IDs [Optional] CurrPage = Int [Optional] RowsPage = Int [Optional]
ListNewerEventsJSON Lists newer events, filtered by the given parameters.Parameters: AuthToken = token [Required] FromEventID = ID [Required] EventIDs = IDs [Optional] OnlyFavorites = boolean [Optional] OnlyUnRead = boolean [Optional] ServiceIDs= IDs [Optional] ExceptServiceIDs = IDs [Optional] DataSourceIDs = IDs [Optional] ExceptDataSourceIDs = IDs [Optional] CurrPage = Int [Optional] RowsPage = Int [Optional]
ListNewerEventsXML Lists newer events, filtered by the given parameters.Parameters: AuthToken = token [Required] FromEventID = ID [Required] EventIDs = IDs [Optional] OnlyFavorites = boolean [Optional] OnlyUnRead = boolean [Optional] ServiceIDs= IDs [Optional] ExceptServiceIDs = IDs [Optional] DataSourceIDs = IDs [Optional] ExceptDataSourceIDs = IDs [Optional] CurrPage = Int [Optional] RowsPage = Int [Optional]
ListOlderEventsForMeJSON Lists older events which are directed at the user, filtered by the given parameters. Parameters: AuthToken = token [Required] FromEventID = ID [Required] EventIDs = IDs [Optional] OnlyFavorites = boolean [Optional] OnlyUnRead = boolean [Optional] ServiceIDs= IDs [Optional] ExceptServiceIDs = IDs [Optional] DataSourceIDs = IDs [Optional] ExceptDataSourceIDs = IDs [Optional] CurrPage = Int [Optional] RowsPage = Int [Optional]
ListOlderEventsForMeXML Lists older events which are directed at the user, filtered by the given parameters. Parameters: AuthToken = token [Required] FromEventID = ID [Required] EventIDs = IDs [Optional] OnlyFavorites = boolean [Optional] OnlyUnRead = boolean [Optional] ServiceIDs= IDs [Optional] ExceptServiceIDs = IDs [Optional] DataSourceIDs = IDs [Optional] ExceptDataSourceIDs = IDs [Optional] CurrPage = Int [Optional] RowsPage = Int [Optional]
ListOlderEventsJSON Lists older events, filtered by the given parameters.Parameters: AuthToken = token [Required] FromEventID = ID [Required] EventIDs = IDs [Optional] OnlyFavorites = boolean [Optional] OnlyUnRead = boolean [Optional] ServiceIDs= IDs [Optional] ExceptServiceIDs = IDs [Optional] DataSourceIDs = IDs [Optional] ExceptDataSourceIDs = IDs [Optional] CurrPage = Int [Optional] RowsPage = Int [Optional]
ListOlderEventsXML Lists older events, filtered by the given parameters.Parameters: AuthToken = token [Required] FromEventID = ID [Required] EventIDs = IDs [Optional] OnlyFavorites = boolean [Optional] OnlyUnRead = boolean [Optional] ServiceIDs= IDs [Optional] ExceptServiceIDs = IDs [Optional] DataSourceIDs = IDs [Optional] ExceptDataSourceIDs = IDs [Optional] CurrPage = Int [Optional] RowsPage = Int [Optional]
ListServicesJSON Lists all services supported by Pond/v1_1, along with their icons and a flag showing if the service supports authorization. Parameters: AuthToken=Alphanumeric [Required]
ListServicesXML Lists all services supported by Pond/v1_1, along with their icons and a flag showing if the service supports Authorization. Parameters: AuthToken=Alphanumeric [Required]
ListViewsJSON List all views for user.
ListViewsXML List all views from user
MergeEntitiesJSON Join two Entities in the current account, transferring all Authors and Events from one to the other and deleting the absorbed Entity.
MergeEntitiesXML Join two Entities in the current account, transferring all Authors and Events from one to the other and deleting the absorbed Entity.
ModifyAccountJSON Modifies the description of the account.Parameters: AuthToken = token [Required] AccountID = ID [Required] Description = AlfaNumeric [Option]
ModifyAccountXML Modifies the description of the account.Parameters: AuthToken = token [Required] AccountID = ID [Required] Description = AlfaNumeric [Option]
PostEventJSON Publishes an event in one of the user's accounts, which is supported by the publishers(ListAccounts: CanPost=true). This operation is asynchronous, so the result status true only refers to the acknowledge of the event and sending to the queue of the publishers. In this case the return is a puny-url that will point to the published event in the service requested. The FileToken is the token returned by the service of upload files.Parameters: AuthToken=Alphanumeric [Required] AccountID = ID [Required] SmallText = AlfaNumeric [optional] LargeText = AlfaNumeric [optional] FileTokens = FileToken [optional]
PostEventXML Publishes an event in one of the user's accounts, which is supported by the publishers(ListAccounts: CanPost=true). This operation is asynchronous, so the result status true only refers to the acknowledge of the event and sending to the queue of the publishers. In this case the return is a puny-url that will point to the published event in the service requested. The FileToken is the token returned by the service of upload files.Parameters: AuthToken=Alphanumeric [Required] AccountID = ID [Required] SmallText = AlfaNumeric [optional] LargeText = AlfaNumeric [optional] FileTokens = FileToken [optional]
ReplyToEventJSON Publish a reply to an event in one account of the user which is support by the publishers(ListAccounts: CanPost=true). This operation is asynchronous, so the result status true only refers to the acknowledged of the event and sending to the queue of the publishers. In this case the return is one puny-url that will point to the event publisher in the service requested.The FileToken is the token returned by the service of upload files.Parameters: AuthToken=Alphanumeric [Required] InReplyToEvent = ID [Required] SmallText = AlfaNumeric [optional] LargeText = AlfaNumeric [optional] FileTokens = FileToken [optional]
ReplyToEventXML Publish a reply to an event in one account of the user which is support by the publishers(ListAccounts: CanPost=true). This operation is asynchronous, so the result status true only refers to the acknowledged of the event and sending to the queue of the publishers. In this case the return is one puny-url that will point to the event publisher in the service requested.The FileToken is the token returned by the service of upload files.Parameters: AuthToken=Alphanumeric [Required] InReplyToEvent = ID [Required] SmallText = AlfaNumeric [optional] LargeText = AlfaNumeric [optional] FileTokens = FileToken [optional]
SetEntityJSON This operation can be used to create or update an already existing entity (in case of the parameter EntityID is pass). Parameters: AuthToken= TOKEN [Required] EntityID = ID [Optional] Name = AlfaNumeric [Required] AvatarURL = URL [Optional]
SetEntityXML This operation can be used to create or update an already existing entity (in case of the parameter EntityID is pass). Parameters: AuthToken= TOKEN [Required] EntityID = ID [Optional] Name = AlfaNumeric [Required] AvatarURL = URL [Optional]
SetEventFavoriteJSON Marks all events as favorites or, if specified, removes from favourites Parameters: AuthToken = TOKEN [Required] Favorite: boolean [Optional:default-true] EventIDs = IDs [Required]
SetEventFavoriteXML Marks all events as favorites or, if specified, removes from favourites Parameters: AuthToken = TOKEN [Required] Favorite: boolean [Optional:default-true] EventIDs = IDs [Required]
SetEventReadJSON Marks all events as Read or if... Parameters: AuthToken = TOKEN [Required] Read: boolean [Optional:default-true] EventIDs = IDs [Required]
SetEventReadXML Marks all events as Read or if... Parameters: AuthToken = TOKEN [Required] Read: boolean [Optional:default-true] EventIDs = IDs [Required]
SetEventUnFavoriteJSON Removes the favorite flag from an Event, internal to Pond.
SetEventUnFavoriteXML Removes the favorite flag from an Event, internal to Pond.
SetEventUnReadJSON Removes the read flag from an Event, internal to Pond.
SetEventUnReadXML Removes the read flag from an Event, internal to Pond.
SetUserJSON Changes user profile, parameters: Name : Name of user [Required] Sex : M or F (Male or Female) DateOfBirth: Date of Birth Occupation : Occupation Country : according to ISO 3166-1 alpha 2 ( two letters ) Language : according RFC 4646 and RFC 4647
SetUserXML Changes user profile, parameters: Name : Name of user [Required] Sex : M or F (Male or Female) DateOfBirth: Date of Birth Occupation : Occupation Country : according to ISO 3166-1 alpha 2 ( two letters ) Language : according RFC 4646 and RFC 4647
SetViewJSON Create/update a view with filtered parameters.
SetViewXML Create/update a view with filtered parameters.

Service

Operations

AddDataSourceToEntityJSON

Adds a data source to an existing entity. 'EntityID'=> 'type'=>'id' [Required] 'ServiceID','type'=>'int'[Required] 'URL','type'=>'URL' [Required] Description = AlfaNumeric [Optional]
Examples
Go to top

AddDataSourceToEntityXML

Adds a data source to an existing entity. 'EntityID'=> 'type'=>'id' [Required] 'ServiceID','type'=>'int'[Required] 'URL','type'=>'URL' [Required] Description = AlfaNumeric [Optional]
Examples
Go to top

AddMyDataSourceJSON

Add a DataSource to the Entity which represents the user, creating the associated Author.
Examples
Go to top

AddMyDataSourceXML

Add a DataSource to the Entity which represents the user, creating the associated Author.
Examples
Go to top

CreateAccountAuthenticationForServiceJSON

Creates an account for a service and returns an authorization URL for OAuth or similar. Parameters: AuthToken=Alphanumeric [Required] ServiceID=int [Required] Description=Alphanumeric [Optional]
Examples
Go to top

CreateAccountAuthenticationForServiceXML

Creates an account for a service and returns an authorization URL for OAuth or similar. Parameters: AuthToken=Alphanumeric [Required] ServiceID=int [Required] Description=Alphanumeric [Optional]
Examples
Go to top

DeleteAccountJSON

Deletes the account, as well as any associated events and authors. If Entity was only linked to this account it'll also be deleted. Parameters: AuthToken=Alphanumeric [Required] AccountID: ID [Required]
Examples
Go to top

DeleteAccountXML

Deletes the account, as well as any associated events and authors. If Entity was only linked to this account it'll also be deleted. Parameters: AuthToken=Alphanumeric [Required] AccountID: ID [Required]
Examples
Go to top

DeleteDataSourceJSON

Remove a DataSource from the current user account.
Examples
Go to top

DeleteDataSourceXML

Remove a DataSource from the current user account.
Examples
Go to top

DeleteEntityJSON

Deletes an Entity.
Examples
Go to top

DeleteEntityXML

Deletes an Entity.
Examples
Go to top

DeleteSystemMessageJSON

Deletes the system message with specified ID. Parameters: MessageID = ID [Required]
Examples
Go to top

DeleteSystemMessageXML

Deletes the system message with specified ID. Parameters: MessageID = ID [Required]
Examples
Go to top

DeleteViewJSON

Delete view.
Examples
Go to top

DeleteViewXML

Delete view.
Examples
Go to top

DiscoverDataSourcesForURLJSON

Returns a list of feed URLs resulting from autodiscovery on the given URL. This service is asynchronous. Results are cached. Call to service will return proper results if already cached. Otherwise, forks a child to do the discovery and returns with a 202 Result Status. Clients should retry until they get a proper response. Parameters: AuthToken=Alphanumeric [Required] URL=Alphanumeric [Required]
Examples
Go to top

DiscoverDataSourcesForURLXML

Returns a list of feed URLs resulting from autodiscovery on the given URL. This service is asynchronous. Results are cached. Call to service will return proper results if already cached. Otherwise, forks a child to do the discovery and returns with a 202 Result Status. Clients should retry until they get a proper response. Parameters: AuthToken=Alphanumeric [Required] URL=Alphanumeric [Required]
Examples
Go to top

DissociateDataSourceFromEntityJSON

Dissociates an entity from a DataSource(account only) and all its authors. If there are no more entities belonging to this datasource, all its associations will be removed. Otherwise the authors will be aggregated to the default Entity. If this is the default entity, then a new default Entity will be chosen. Parameters: AuthToken = Alphanumeric [Required] EntityID = ID [Required] DataSourceID = ID [Required]
Examples
Go to top

DissociateDataSourceFromEntityXML

Dissociates an entity from a DataSource(account only) and all its authors. If there are no more entities belonging to this datasource, all its associations will be removed. Otherwise the authors will be aggregated to the default Entity. If this is the default entity, then a new default Entity will be chosen. Parameters: AuthToken = Alphanumeric [Required] EntityID = ID [Required] DataSourceID = ID [Required]
Examples
Go to top

GetAuthTokenJSON

Returns a security token, valid for a period of 12 hours, for a valid UserName and Password. Username=Alfa [Required] Password=Alfa [Required]
Examples
Go to top

GetAuthTokenXML

Returns a security token, valid for a period of 12 hours, for a valid UserName and Password. Username=Alfa [Required] Password=Alfa [Required]
Examples
Go to top

GetEventJSON

Gets events full contents Parameters: AuthToken = token [Required] EventIDs = ID [Required] CurrPage = Int [Optional] RowsPage = Int [Optional]
Examples
Go to top

GetEventXML

Gets events full contents Parameters: AuthToken = token [Required] EventIDs = ID [Required] CurrPage = Int [Optional] RowsPage = Int [Optional]
Examples
Go to top

GetUserJSON

Returns user profile if user exists
Examples
Go to top

GetUserXML

Returns user profile if user exists
Examples
Go to top

GetViewJSON

Returns filters from view id.
Examples
Go to top

GetViewXML

Returns filters from view id.
Examples
Go to top

ListAccountsJSON

Returns all content of required accounts. Parameters: AuthToken = token [Required] ServiceIDs = IDs [Optional] CurrPage = Int [Optional] RowsPage = Int [Optional]
Examples
Go to top

ListAccountsXML

Returns all content for requested accountsParameters: AuthToken = token [Required] ServiceIDs = IDs [Required] CurrPage = Int [Optional] RowsPage = Int [Optional]
Examples
Go to top

ListCommentsJSON

Lists all comments from event in JSON format. Parameters: AuthToken = token [Required] EventID = ID [Required]
Examples
Go to top

ListCommentsXML

Lists all comments from event in XML format. Parameters: AuthToken = token [Required] EventID = ID [Required]
Examples
Go to top

ListEntitiesJSON

Lists all entities which fit the filter parameters. Parameters: AuthToken = token [Required] ServiceIDs = IDs [Optional] EntityIDs = IDs [Optional] FirstLetter= Alfa [Optional] Temporary = boolean [Optional] CurrPage = Int [Optional] RowsPage = Int [Optional]
Examples
Go to top

ListEntitiesXML

Lists all entities which fit the filter parameters. Parameters: AuthToken = token [Required] ServiceIDs = IDs [Optional] EntityIDs = IDs [Optional] FirstLetter= Alfa [Optional] Temporary = boolean [Optional] CurrPage = Int [Optional] RowsPage = Int [Optional]
Examples
Go to top

ListEventsForMeJSON

Lists events which are directed at the user, filtered by the given parameters. Parameters: AuthToken = token [Required] EventIDs = IDs [Optional] OnlyFavorites = boolean [Optional] OnlyUnRead = boolean [Optional] ServiceIDs= IDs [Optional] ExceptServiceIDs = IDs [Optional] DataSourceIDs = IDs [Optional] ExceptDataSourceIDs = IDs [Optional] CurrPage = Int [Optional] RowsPage = Int [Optional]
Examples
Go to top

ListEventsForMeXML

Lists events which are directed at the user, filtered by the given parameters. Parameters: AuthToken = token [Required] EventIDs = IDs [Optional] OnlyUnRead = boolean [Optional] OnlyFavorites = boolean [Optional] ServiceIDs= IDs [Optional] ExceptServiceIDs = IDs [Optional] DataSourceIDs = IDs [Optional] ExceptDataSourceIDs = IDs [Optional] CurrPage = Int [Optional] RowsPage = Int [Optional]
Examples
Go to top

ListEventsJSON

Lists all events, filtered by the given parameters. Parameters: AuthToken = token [Required] EventIDs = IDs [Optional] OnlyFavorites = boolean [Optional] OnlyUnRead= boolean [Optional] ServiceIDs= IDs [Optional] ExceptServiceIDs = IDs [Optional] DataSourceIDs = IDs [Optional] ExceptDataSourceIDs = IDs [Optional] EntityIDs = IDs [Optional] CurrPage = Int [Optional] RowsPage = Int [Optional]
Examples
Go to top

ListEventsXML

Lists all events, filtered by the given parameters. Parameters: AuthToken = token [Required] EventIDs = IDs [Optional] OnlyFavorites = boolean [Optional] OnlyUnRead= boolean [Optional] ServiceIDs= IDs [Optional] ExceptServiceIDs = IDs [Optional] DataSourceIDs = IDs [Optional] ExceptDataSourceIDs = IDs [Optional] EntityIDs = IDs [Optional] CurrPage = Int [Optional] RowsPage = Int [Optional]
Examples
Go to top

ListMyAuthorsAndDataSourcesJSON

Lists all information (datasources, authors), associated with the user's entity. Parameters: AuthToken = token [Required]
Examples
Go to top

ListMyAuthorsAndDataSourcesXML

Lists all information(datasources,authors), relating to my entity. Parameters: AuthToken = token [Required]
Examples
Go to top

ListMyEventsJSON

Lists events, filtered by the given parameters, which seem to be from the user specifically.Parameters: AuthToken = token [Required] EventIDs = IDs [Optional] OnlyFavorites = boolean [Optional] OnlyUnRead = boolean [Optional] ServiceIDs= IDs [Optional] ExceptServiceIDs = IDs [Optional] DataSourceIDs = IDs [Optional] ExceptDataSourceIDs = IDs [Optional] CurrPage = Int [Optional] RowsPage = Int [Optional]
Examples
Go to top

ListMyEventsXML

Lists events, filtered by the given parameters, which seem to be from the user specifically.Parameters: AuthToken = token [Required] EventIDs = IDs [Optional] OnlyFavorites = boolean [Optional] OnlyUnRead = boolean [Optional] ServiceIDs= IDs [Optional] ExceptServiceIDs = IDs [Optional] DataSourceIDs = IDs [Optional] ExceptDataSourceIDs = IDs [Optional] CurrPage = Int [Optional] RowsPage = Int [Optional]
Examples
Go to top

ListMyNewerEventsJSON

Lists newer events, filtered by the given parameters, which seem to be from the user specifically.Parameters: AuthToken = token [Required] FromEventID = ID [Required] EventIDs = IDs [Optional] OnlyFavorites = boolean [Optional] OnlyUnRead = boolean [Optional] ServiceIDs= IDs [Optional] ExceptServiceIDs = IDs [Optional] DataSourceIDs = IDs [Optional] ExceptDataSourceIDs = IDs [Optional] CurrPage = Int [Optional] RowsPage = Int [Optional]
Examples
Go to top

ListMyNewerEventsXML

Lists newer events, filtered by the given parameters, which seem to be from the user specifically.Parameters: AuthToken = token [Required] FromEventID = ID [Required] EventIDs = IDs [Optional] OnlyFavorites = boolean [Optional] OnlyUnRead = boolean [Optional] ServiceIDs= IDs [Optional] ExceptServiceIDs = IDs [Optional] DataSourceIDs = IDs [Optional] ExceptDataSourceIDs = IDs [Optional] CurrPage = Int [Optional] RowsPage = Int [Optional]
Examples
Go to top

ListMyOlderEventsJSON

Lists older events, filtered by the given parameters, which seem to be from the user specifically.Parameters: AuthToken = token [Required] FromEventID = ID [Required] EventIDs = IDs [Optional] OnlyFavorites = boolean [Optional] OnlyUnRead = boolean [Optional] ServiceIDs= IDs [Optional] ExceptServiceIDs = IDs [Optional] DataSourceIDs = IDs [Optional] ExceptDataSourceIDs = IDs [Optional] CurrPage = Int [Optional] RowsPage = Int [Optional]
Examples
Go to top

ListMyOlderEventsXML

Lists older events, filtered by the given parameters, which seem to be from the user specifically.Parameters: AuthToken = token [Required] FromEventID = ID [Required] EventIDs = IDs [Optional] OnlyFavorites = boolean [Optional] OnlyUnRead = boolean [Optional] ServiceIDs= IDs [Optional] ExceptServiceIDs = IDs [Optional] DataSourceIDs = IDs [Optional] ExceptDataSourceIDs = IDs [Optional] CurrPage = Int [Optional] RowsPage = Int [Optional]
Examples
Go to top

ListNewerEventsForMeJSON

Lists newer events which are directed at the user, filtered by the given parameters. Parameters: AuthToken = token [Required] FromEventID = ID [Required] EventIDs = IDs [Optional] OnlyFavorites = boolean [Optional] OnlyUnRead = boolean [Optional] ServiceIDs= IDs [Optional] ExceptServiceIDs = IDs [Optional] DataSourceIDs = IDs [Optional] ExceptDataSourceIDs = IDs [Optional] CurrPage = Int [Optional] RowsPage = Int [Optional]
Examples
Go to top

ListNewerEventsForMeXML

Lists newer events which are directed at the user, filtered by the given parameters. Parameters: AuthToken = token [Required] FromEventID = ID [Required] EventIDs = IDs [Optional] OnlyFavorites = boolean [Optional] OnlyUnRead = boolean [Optional] ServiceIDs= IDs [Optional] ExceptServiceIDs = IDs [Optional] DataSourceIDs = IDs [Optional] ExceptDataSourceIDs = IDs [Optional] CurrPage = Int [Optional] RowsPage = Int [Optional]
Examples
Go to top

ListNewerEventsJSON

Lists newer events, filtered by the given parameters.Parameters: AuthToken = token [Required] FromEventID = ID [Required] EventIDs = IDs [Optional] OnlyFavorites = boolean [Optional] OnlyUnRead = boolean [Optional] ServiceIDs= IDs [Optional] ExceptServiceIDs = IDs [Optional] DataSourceIDs = IDs [Optional] ExceptDataSourceIDs = IDs [Optional] CurrPage = Int [Optional] RowsPage = Int [Optional]
Examples
Go to top

ListNewerEventsXML

Lists newer events, filtered by the given parameters.Parameters: AuthToken = token [Required] FromEventID = ID [Required] EventIDs = IDs [Optional] OnlyFavorites = boolean [Optional] OnlyUnRead = boolean [Optional] ServiceIDs= IDs [Optional] ExceptServiceIDs = IDs [Optional] DataSourceIDs = IDs [Optional] ExceptDataSourceIDs = IDs [Optional] CurrPage = Int [Optional] RowsPage = Int [Optional]
Examples
Go to top

ListOlderEventsForMeJSON

Lists older events which are directed at the user, filtered by the given parameters. Parameters: AuthToken = token [Required] FromEventID = ID [Required] EventIDs = IDs [Optional] OnlyFavorites = boolean [Optional] OnlyUnRead = boolean [Optional] ServiceIDs= IDs [Optional] ExceptServiceIDs = IDs [Optional] DataSourceIDs = IDs [Optional] ExceptDataSourceIDs = IDs [Optional] CurrPage = Int [Optional] RowsPage = Int [Optional]
Examples
Go to top

ListOlderEventsForMeXML

Lists older events which are directed at the user, filtered by the given parameters. Parameters: AuthToken = token [Required] FromEventID = ID [Required] EventIDs = IDs [Optional] OnlyFavorites = boolean [Optional] OnlyUnRead = boolean [Optional] ServiceIDs= IDs [Optional] ExceptServiceIDs = IDs [Optional] DataSourceIDs = IDs [Optional] ExceptDataSourceIDs = IDs [Optional] CurrPage = Int [Optional] RowsPage = Int [Optional]
Examples
Go to top

ListOlderEventsJSON

Lists older events, filtered by the given parameters.Parameters: AuthToken = token [Required] FromEventID = ID [Required] EventIDs = IDs [Optional] OnlyFavorites = boolean [Optional] OnlyUnRead = boolean [Optional] ServiceIDs= IDs [Optional] ExceptServiceIDs = IDs [Optional] DataSourceIDs = IDs [Optional] ExceptDataSourceIDs = IDs [Optional] CurrPage = Int [Optional] RowsPage = Int [Optional]
Examples
Go to top

ListOlderEventsXML

Lists older events, filtered by the given parameters.Parameters: AuthToken = token [Required] FromEventID = ID [Required] EventIDs = IDs [Optional] OnlyFavorites = boolean [Optional] OnlyUnRead = boolean [Optional] ServiceIDs= IDs [Optional] ExceptServiceIDs = IDs [Optional] DataSourceIDs = IDs [Optional] ExceptDataSourceIDs = IDs [Optional] CurrPage = Int [Optional] RowsPage = Int [Optional]
Examples
Go to top

ListServicesJSON

Lists all services supported by Pond/v1_1, along with their icons and a flag showing if the service supports authorization. Parameters: AuthToken=Alphanumeric [Required]
Examples
Go to top

ListServicesXML

Lists all services supported by Pond/v1_1, along with their icons and a flag showing if the service supports Authorization. Parameters: AuthToken=Alphanumeric [Required]
Examples
Go to top

ListViewsJSON

List all views for user.
Examples
Go to top

ListViewsXML

List all views from user
Examples
Go to top

MergeEntitiesJSON

Join two Entities in the current account, transferring all Authors and Events from one to the other and deleting the absorbed Entity.
Examples
Go to top

MergeEntitiesXML

Join two Entities in the current account, transferring all Authors and Events from one to the other and deleting the absorbed Entity.
Examples
Go to top

ModifyAccountJSON

Modifies the description of the account.Parameters: AuthToken = token [Required] AccountID = ID [Required] Description = AlfaNumeric [Option]
Examples
Go to top

ModifyAccountXML

Modifies the description of the account.Parameters: AuthToken = token [Required] AccountID = ID [Required] Description = AlfaNumeric [Option]
Examples
Go to top

PostEventJSON

Publishes an event in one of the user's accounts, which is supported by the publishers(ListAccounts: CanPost=true). This operation is asynchronous, so the result status true only refers to the acknowledge of the event and sending to the queue of the publishers. In this case the return is a puny-url that will point to the published event in the service requested. The FileToken is the token returned by the service of upload files.Parameters: AuthToken=Alphanumeric [Required] AccountID = ID [Required] SmallText = AlfaNumeric [optional] LargeText = AlfaNumeric [optional] FileTokens = FileToken [optional]
Examples
Go to top

PostEventXML

Publishes an event in one of the user's accounts, which is supported by the publishers(ListAccounts: CanPost=true). This operation is asynchronous, so the result status true only refers to the acknowledge of the event and sending to the queue of the publishers. In this case the return is a puny-url that will point to the published event in the service requested. The FileToken is the token returned by the service of upload files.Parameters: AuthToken=Alphanumeric [Required] AccountID = ID [Required] SmallText = AlfaNumeric [optional] LargeText = AlfaNumeric [optional] FileTokens = FileToken [optional]
Examples
Go to top

ReplyToEventJSON

Publish a reply to an event in one account of the user which is support by the publishers(ListAccounts: CanPost=true). This operation is asynchronous, so the result status true only refers to the acknowledged of the event and sending to the queue of the publishers. In this case the return is one puny-url that will point to the event publisher in the service requested.The FileToken is the token returned by the service of upload files.Parameters: AuthToken=Alphanumeric [Required] InReplyToEvent = ID [Required] SmallText = AlfaNumeric [optional] LargeText = AlfaNumeric [optional] FileTokens = FileToken [optional]
Examples
Go to top

ReplyToEventXML

Publish a reply to an event in one account of the user which is support by the publishers(ListAccounts: CanPost=true). This operation is asynchronous, so the result status true only refers to the acknowledged of the event and sending to the queue of the publishers. In this case the return is one puny-url that will point to the event publisher in the service requested.The FileToken is the token returned by the service of upload files.Parameters: AuthToken=Alphanumeric [Required] InReplyToEvent = ID [Required] SmallText = AlfaNumeric [optional] LargeText = AlfaNumeric [optional] FileTokens = FileToken [optional]
Examples
Go to top

SetEntityJSON

This operation can be used to create or update an already existing entity (in case of the parameter EntityID is pass). Parameters: AuthToken= TOKEN [Required] EntityID = ID [Optional] Name = AlfaNumeric [Required] AvatarURL = URL [Optional]
Examples
Go to top

SetEntityXML

This operation can be used to create or update an already existing entity (in case of the parameter EntityID is pass). Parameters: AuthToken= TOKEN [Required] EntityID = ID [Optional] Name = AlfaNumeric [Required] AvatarURL = URL [Optional]
Examples
Go to top

SetEventFavoriteJSON

Marks all events as favorites or, if specified, removes from favourites Parameters: AuthToken = TOKEN [Required] Favorite: boolean [Optional:default-true] EventIDs = IDs [Required]
Examples
Go to top

SetEventFavoriteXML

Marks all events as favorites or, if specified, removes from favourites Parameters: AuthToken = TOKEN [Required] Favorite: boolean [Optional:default-true] EventIDs = IDs [Required]
Examples
Go to top

SetEventReadJSON

Marks all events as Read or if... Parameters: AuthToken = TOKEN [Required] Read: boolean [Optional:default-true] EventIDs = IDs [Required]
Examples
Go to top

SetEventReadXML

Marks all events as Read or if... Parameters: AuthToken = TOKEN [Required] Read: boolean [Optional:default-true] EventIDs = IDs [Required]
Examples
Go to top

SetEventUnFavoriteJSON

Removes the favorite flag from an Event, internal to Pond.
Examples
Go to top

SetEventUnFavoriteXML

Removes the favorite flag from an Event, internal to Pond.
Examples
Go to top

SetEventUnReadJSON

Removes the read flag from an Event, internal to Pond.
Examples
Go to top

SetEventUnReadXML

Removes the read flag from an Event, internal to Pond.
Examples
Go to top

SetUserJSON

Changes user profile, parameters: Name : Name of user [Required] Sex : M or F (Male or Female) DateOfBirth: Date of Birth Occupation : Occupation Country : according to ISO 3166-1 alpha 2 ( two letters ) Language : according RFC 4646 and RFC 4647
Examples
Go to top

SetUserXML

Changes user profile, parameters: Name : Name of user [Required] Sex : M or F (Male or Female) DateOfBirth: Date of Birth Occupation : Occupation Country : according to ISO 3166-1 alpha 2 ( two letters ) Language : according RFC 4646 and RFC 4647
Examples
Go to top

SetViewJSON

Create/update a view with filtered parameters.
Examples
Go to top

SetViewXML

Create/update a view with filtered parameters.
Examples
Go to top

REST API Authentication

Authenticating REST Request

Every request must contain authentication information to establish the identity of whom making the request and a autorization token denominated ESBAccessKey.

ESB Access Key

The ESB Access Key is what will authorize the usage of the API and is available when the buying process ends. In the costumer area you can find the product details where you can generate an ESB Access Key for you usage, another user registered on SAPO Services or even for everyone.

The element ESBAccessKey must appear on the URL as a query-string

HTTP GET example using username and password:

HTTP POST username and password:

Request with ESBToken

Using a token instead of your username and password can be useful if you don't want to give your credentials to whom is using the API.

In order to generate a ESB Token you must use SAPO Security Token Service. The ESBToken is valid for 12 hours.

HTTP GET example using ESB Token:

HTTP POST ESB Token:

Parameters description

ESBCredentials are parameters used to authenticate and authorize a REST request

Elements Description
ESBUsername The e-mail of the account that is used to access the API.
ESBPassword The password that in combination with the ESBUsername is used to access the corresponding account.
ESBToken An authentication token generated by using an user name (ESBUsername) and password (ESBPassword). It should be used a ESBToken or the combination of ESBUsername and ESBPassword.
ESBAccessKey The authorization key used to authorize the request against your purchase. The account being used to access the service must be associated to this key.
Go to top