SoNET Web API Help - OData

Metadata

APIDescription
GET odata/$metadata

Gets a metadata that describes available operation and service contracts.

Announcements

APIDescription
GET odata/Announcements

Gets a collection of Announcement objects.

GET odata/Announcements(xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)

Gets single Announcement object by its unique ID.

GET odata/Announcements?$filter={x}|$select={x}|$orderby={x}|$top={x}|$skip={x}|$count=true

Applies one of the OData operators to Announcement objects.

POST odata/Announcements

Creates new Announcement object.

PUT odata/Announcements(xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)

Updates all properties of a single Announcement object.

PATCH odata/Announcements(xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)

Updates individual properties of a single Announcement object.

DELETE odata/Announcements(xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)

Deletes single Announcement object.

Classifieds

APIDescription
GET odata/Classifieds

Gets a collection of Classified objects.

GET odata/Classifieds(xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)

Gets single Classified object by its unique ID.

GET odata/Classifieds?$filter={x}|$select={x}|$orderby={x}|$top={x}|$skip={x}|$count=true

Applies one of the OData operators to Classified objects.

POST odata/Classifieds

Creates new Classified object.

PUT odata/Classifieds(xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)

Updates all properties of a single Classified object.

PATCH odata/Classifieds(xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)

Updates individual properties of a single Classified object.

DELETE odata/Classifieds(xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)

Deletes single Classified object.

FunFacts (Journal)

APIDescription
GET odata/FunFacts

Gets a collection of FunFact objects.

GET odata/FunFacts(xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)

Gets single FunFact object by its unique ID.

GET odata/FunFacts?$filter={x}|$select={x}|$orderby={x}|$top={x}|$skip={x}|$count=true

Applies one of the OData operators to FunFact objects.

POST odata/FunFacts

Creates new FunFact object.

PUT odata/FunFacts(xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)

Updates all properties of a single FunFact object.

PATCH odata/FunFacts(xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)

Updates individual properties of a single FunFact object.

DELETE odata/FunFacts(xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)

Deletes single FunFact object.

Media

APIDescription
GET odata/Media

Gets a collection of Media objects.

GET odata/Media(xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)

Gets single Media object by its unique ID.

GET odata/Media?$filter={x}|$select={x}|$orderby={x}|$top={x}|$skip={x}|$count=true

Applies one of the OData operators to Media objects.

GET odata/Media?$expand=MediaCategoryObject

"Expands" the query to include related MediaCategoryObject.

POST odata/Media

Creates new Media object.

PUT odata/Media(xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)

Updates all properties of a single Media object.

PATCH odata/Media(xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)

Updates individual properties of a single Media object.

DELETE odata/Media(xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)

Deletes single Media object.

POST odata/Media(xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)/SubmitFeedback

Submits feedback/comments for Media with optional creation of the Observer.

Media Categories (Folders)

APIDescription
GET odata/MediaCategories

Gets a collection of MediaCategory objects.

GET odata/MediaCategories(xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)

Gets single MediaCategory object by its unique ID.

GET odata/MediaCategories?$filter={x}|$select={x}|$orderby={x}|$top={x}|$skip={x}|$count=true

Applies one of the OData operators to MediaCategory objects.

GET odata/MediaCategories?$expand=MediaList

"Expands" the query to include related Media objects.

POST odata/MediaCategories

Creates new MediaCategory object.

PUT odata/MediaCategories(xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)

Updates all properties of a single MediaCategory object.

PATCH odata/MediaCategories(xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)

Updates individual properties of a single MediaCategory object.

DELETE odata/MediaCategories(xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)

Deletes single MediaCategory object.

Media Feedbacks (Comments)

APIDescription
GET odata/MediaFeedbacks

Gets a collection of MediaFeedback objects.

GET odata/MediaFeedbacks(xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)

Gets single MediaFeedback object by its unique ID.

GET odata/MediaFeedbacks?$filter={x}|$select={x}|$orderby={x}|$top={x}|$skip={x}|$count=true

Applies one of the OData operators to MediaFeedback objects.

GET odata/MediaFeedbacks?$expand=MediaObject

"Expands" the query to include related Media object.

DELETE odata/MediaFeedbacks(xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)

Deletes single MediaFeedback object.

Media Ratings

APIDescription
GET odata/MediaRatings

Gets a collection of MediaRating objects.

GET odata/MediaRatings(xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)

Gets single MediaRating object by its unique ID.

GET odata/MediaRatings?$filter={x}|$select={x}|$orderby={x}|$top={x}|$skip={x}|$count=true

Applies one of the OData operators to MediaRating objects.

GET odata/MediaRatings?$expand=MediaObject

"Expands" the query to include related Media object.

POST odata/MediaRatings

Creates new MediaRating object.

PUT odata/MediaRatings(xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)

Updates all properties of a single MediaRating object.

PATCH odata/MediaRatings(xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)

Updates individual properties of a single MediaRating object.

DELETE odata/MediaRatings(xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)

Deletes single MediaRating object.

Sites

APIDescription
GET odata/Sites

Gets a collection of Site objects.

GET odata/Sites('SiteName')

Gets single Site object by its name.

GET odata/Sites?$filter={x}|$select={x}|$orderby={x}|$top={x}|$skip={x}|$count=true

Applies one of the OData operators to Site objects.

GET odata/Sites('SiteName')?$expand=SubscriptionLevelObject

"Expands" the query to include related SubscriptionLevel objects.

GET odata/Sites('SiteName')/SoNET.HasValidSubscription

Determines whether a Site is a valid subscriber.

POST odata/Sites

Creates new Site object.

PUT odata/Sites('SiteName')

Updates all properties of a single Site object.

PATCH odata/Sites('SiteName')

Updates individual properties of a single Site object.

DELETE odata/Sites('SiteName')

Deletes single Site object.

POST odata/Sites('SiteName')/SoNET.UpdateSEOScripts

Updates SEO scripts for a Site.

Site Ratings

APIDescription
GET odata/SiteRatings

Gets a collection of SiteRating objects.

GET odata/SiteRatings(xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)

Gets single SiteRating object by its unique ID.

GET odata/SiteRatings?$filter={x}|$select={x}|$orderby={x}|$top={x}|$skip={x}|$count=true

Applies one of the OData operators to SiteRating objects.

GET odata/SiteRatings?$expand=SiteObject

"Expands" the query to include related Site object.

POST odata/SiteRatings

Creates new SiteRating object.

PUT odata/SiteRatings(xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)

Updates all properties of a single SiteRating object.

PATCH odata/SiteRatings(xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)

Updates individual properties of a single SiteRating object.

DELETE odata/SiteRatings(xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)

Deletes single SiteRating object.

Users

APIDescription
GET odata/Users

Gets a collection of Users.

GET odata/Users(xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)

Gets single User by its unique ID.

GET odata/Users?$filter={x}|$select={x}|$orderby={x}|$top={x}|$skip={x}|$count=true

Applies one of the OData operators to Users.

POST odata/Users

Creates new User.

POST odata/Users(xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)/SoNET.AddToRole

Adds given User to a security Role.

POST odata/Users(xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)/SoNET.IsSiteOwner

Determines whether the User is Site owner (contains all Administrator rights).

POST odata/Users(xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)/SoNET.UploadPicture

Uploads a profile picture for the User. Image is automatically resized.

PUT odata/Users(xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)

Updates all properties of a single User.

PATCH odata/Users(xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)

Updates individual properties of a single User.

DELETE odata/Users(xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)

Deletes single User.

FormResults

APIDescription
GET odata/FormResults

Gets a collection of FormResult objects.

GET odata/FormResults(xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)

Gets single FormResult object by its unique ID.

GET odata/FormResults?$filter={x}|$select={x}|$orderby={x}|$top={x}|$skip={x}|$count=true

Applies one of the OData operators to FormResult objects.

POST odata/FormResults

Creates new FormResult object.

PUT odata/FormResults(xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)

Updates all properties of a single FormResult object.

PATCH odata/FormResults(xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)

Updates individual properties of a single FormResult object.

DELETE odata/FormResults(xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)

Deletes single FormResult object.

Need help? Contact Us