Valuekeep Developers - Web API Reference

Settings | Product News

Overview


URL api/{tenantKey}/{orgKey}/settings/productNews
Methods Supported GET, POST

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

GET Operations

GET Get Product News

Custom operation 'GetProductNews'.

The following elements are required:

version (string) Version.

Response:

When successful, the response body contains a resource of type 'ProductNews'. See ProductNews.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

GET /settings/productNews/getProductNews

POST Operations

POST Mark News As Viewed

Custom operation 'MarkNewsAsViewed'.

The following elements are required:

version (string) Version.

Response:

When successful, the response body is empty.

Resource URL:

POST /settings/productNews/markNewsAsViewed

Resources


ProductNews

The following elements are optional:

id (string) Id.
title (string) Title.
content (string) Content.
detailsUrl (string) Details Url.
publishDate (DateTime) Publish Date.
version (string) Version.