RESTful API
news
news Default World Immunization Week GHO multimedias hubs documents WHOReference emergencies media newsroom ResultsReport IMR-sync

Volumes

Get volumes

Returns a set of data items of type volumes.

Copy GET /api/news/volumes
Request Informaion

URI Parameters

None

Body Parameters

None

Request Formats

None.

Response Informaion

Resource Description

Method can return success code: OK - 200 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Name Description Type Additional Information
LastModified

System.DateTimeOffset

Read only: True
Selected by default: True

PublicationDate

System.DateTimeOffset

Read only: False
Selected by default: True

DateCreated

System.DateTimeOffset

Read only: True
Selected by default: True

IncludeInSitemap

System.Boolean

Read only: False
Selected by default: True

SystemSourceKey

System.String

Read only: False
Selected by default: True

UrlName

System.String

Read only: False
Selected by default: True

ItemDefaultUrl

System.String

Read only: True
Selected by default: True

VolumeNumber

System.Decimal

Read only: False
Selected by default: True

VolumeYear

System.Decimal

Read only: False
Selected by default: True

Title

System.String

Read only: False
Selected by default: True

DisplayTitle

System.String

Read only: False
Selected by default: True

ParentId

System.Guid

Read only: False
Selected by default: True

Provider

System.String

Read only: True
Selected by default: True

Comments

Telerik.Sitefinity.Services.Comments.CommentContract

Read only: True
Selected by default: False

Resource Format

Response Formats
Copy
application/json
[
  {
    "LastModified": "2026-08-30T00:28:42.1607123Z",
    "PublicationDate": "2026-08-30T00:28:42.1607123Z",
    "DateCreated": "2026-08-30T00:28:42.1607123Z",
    "IncludeInSitemap": true,
    "SystemSourceKey": "sample string 5",
    "UrlName": "sample string 6",
    "ItemDefaultUrl": "sample string 7",
    "VolumeNumber": 8.0,
    "VolumeYear": 9.0,
    "Title": "sample string 10",
    "DisplayTitle": "sample string 11",
    "ParentId": "c37015a7-44bd-493d-8ae3-8f257bbd06a7",
    "Provider": "sample string 13",
    "Comments": {
      "Name": "sample string 1",
      "Message": "sample string 2",
      "DateCreated": "2026-08-30T00:28:42.1607123+00:00",
      "ProfilePictureUrl": "sample string 4",
      "ProfilePictureThumbnailUrl": "sample string 5"
    }
  },
  {
    "LastModified": "2026-08-30T00:28:42.1607123Z",
    "PublicationDate": "2026-08-30T00:28:42.1607123Z",
    "DateCreated": "2026-08-30T00:28:42.1607123Z",
    "IncludeInSitemap": true,
    "SystemSourceKey": "sample string 5",
    "UrlName": "sample string 6",
    "ItemDefaultUrl": "sample string 7",
    "VolumeNumber": 8.0,
    "VolumeYear": 9.0,
    "Title": "sample string 10",
    "DisplayTitle": "sample string 11",
    "ParentId": "c37015a7-44bd-493d-8ae3-8f257bbd06a7",
    "Provider": "sample string 13",
    "Comments": {
      "Name": "sample string 1",
      "Message": "sample string 2",
      "DateCreated": "2026-08-30T00:28:42.1607123+00:00",
      "ProfilePictureUrl": "sample string 4",
      "ProfilePictureThumbnailUrl": "sample string 5"
    }
  }
]

Get volumes by key

Gets volumes item by id.

Copy GET /api/news/volumes({key})
Request Informaion

URI Parameters

Name Description Type Additional Information
key

System.Guid

Required

Body Parameters

None

Request Formats

None.

Response Informaion

Resource Description

Method can return success code: OK - 200 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Name Description Type Additional Information
LastModified

System.DateTimeOffset

Read only: True
Selected by default: True

PublicationDate

System.DateTimeOffset

Read only: False
Selected by default: True

DateCreated

System.DateTimeOffset

Read only: True
Selected by default: True

IncludeInSitemap

System.Boolean

Read only: False
Selected by default: True

SystemSourceKey

System.String

Read only: False
Selected by default: True

UrlName

System.String

Read only: False
Selected by default: True

ItemDefaultUrl

System.String

Read only: True
Selected by default: True

VolumeNumber

System.Decimal

Read only: False
Selected by default: True

VolumeYear

System.Decimal

Read only: False
Selected by default: True

Title

System.String

Read only: False
Selected by default: True

DisplayTitle

System.String

Read only: False
Selected by default: True

ParentId

System.Guid

Read only: False
Selected by default: True

Provider

System.String

Read only: True
Selected by default: True

Comments

Telerik.Sitefinity.Services.Comments.CommentContract

Read only: True
Selected by default: False

Resource Format

Response Formats
Copy
application/json
{
  "LastModified": "2026-08-30T00:28:42.1607123Z",
  "PublicationDate": "2026-08-30T00:28:42.1607123Z",
  "DateCreated": "2026-08-30T00:28:42.1607123Z",
  "IncludeInSitemap": true,
  "SystemSourceKey": "sample string 5",
  "UrlName": "sample string 6",
  "ItemDefaultUrl": "sample string 7",
  "VolumeNumber": 8.0,
  "VolumeYear": 9.0,
  "Title": "sample string 10",
  "DisplayTitle": "sample string 11",
  "ParentId": "d128fbda-dee5-43fd-92bf-b54a22289762",
  "Provider": "sample string 13",
  "Comments": {
    "Name": "sample string 1",
    "Message": "sample string 2",
    "DateCreated": "2026-08-30T00:28:42.1607123+00:00",
    "ProfilePictureUrl": "sample string 4",
    "ProfilePictureThumbnailUrl": "sample string 5"
  }
}

Get property

Gets Id property from volumes item.

Copy GET /api/news/volumes({key})/property
Request Informaion

URI Parameters

Name Description Type Additional Information
key

System.Guid

Required

property

System.String

Required

Body Parameters

None

Request Formats

None.

Response Informaion

Resource Description

Method can return success code: OK - 200 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Name Description Type Additional Information
Id

System.Guid

Read only: False

Resource Format

Response Formats
Copy
application/json
{
  "Id": "b909570c-6b36-4bfe-a848-0d6abb51bfbb"
}

Post volumes

Creates a volumes item.

Copy POST /api/news/volumes
Request Informaion

URI Parameters

None

Body Parameters

Name Description Type Additional Information
LastModified

System.DateTimeOffset

Read only: True
Selected by default: True

PublicationDate

System.DateTimeOffset

Read only: False
Selected by default: True

DateCreated

System.DateTimeOffset

Read only: True
Selected by default: True

IncludeInSitemap

System.Boolean

Read only: False
Selected by default: True

SystemSourceKey

System.String

Read only: False
Selected by default: True

UrlName

System.String

Read only: False
Selected by default: True

ItemDefaultUrl

System.String

Read only: True
Selected by default: True

VolumeNumber

System.Decimal

Read only: False
Selected by default: True

VolumeYear

System.Decimal

Read only: False
Selected by default: True

Title

System.String

Read only: False
Selected by default: True

DisplayTitle

System.String

Read only: False
Selected by default: True

ParentId

System.Guid

Read only: False
Selected by default: True

Provider

System.String

Read only: True
Selected by default: True

Comments

Telerik.Sitefinity.Services.Comments.CommentContract

Read only: True
Selected by default: False

Request Formats
Copy
application/json
{
  "PublicationDate": "2026-08-30T00:28:42.1607123Z",
  "IncludeInSitemap": true,
  "SystemSourceKey": "sample string 3",
  "UrlName": "sample string 4",
  "VolumeNumber": 5.0,
  "VolumeYear": 6.0,
  "Title": "sample string 7",
  "DisplayTitle": "sample string 8",
  "ParentId": "3298a37f-b793-4efd-a88b-86b33544508f"
}
Response Informaion

Resource Description

Method can return success code: Created - 201 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Name Description Type Additional Information
LastModified

System.DateTimeOffset

Read only: True
Selected by default: True

PublicationDate

System.DateTimeOffset

Read only: False
Selected by default: True

DateCreated

System.DateTimeOffset

Read only: True
Selected by default: True

IncludeInSitemap

System.Boolean

Read only: False
Selected by default: True

SystemSourceKey

System.String

Read only: False
Selected by default: True

UrlName

System.String

Read only: False
Selected by default: True

ItemDefaultUrl

System.String

Read only: True
Selected by default: True

VolumeNumber

System.Decimal

Read only: False
Selected by default: True

VolumeYear

System.Decimal

Read only: False
Selected by default: True

Title

System.String

Read only: False
Selected by default: True

DisplayTitle

System.String

Read only: False
Selected by default: True

ParentId

System.Guid

Read only: False
Selected by default: True

Provider

System.String

Read only: True
Selected by default: True

Comments

Telerik.Sitefinity.Services.Comments.CommentContract

Read only: True
Selected by default: False

Resource Format

Response Formats
Copy
application/json
{
  "LastModified": "2026-08-30T00:28:42.1607123Z",
  "PublicationDate": "2026-08-30T00:28:42.1607123Z",
  "DateCreated": "2026-08-30T00:28:42.1607123Z",
  "IncludeInSitemap": true,
  "SystemSourceKey": "sample string 5",
  "UrlName": "sample string 6",
  "ItemDefaultUrl": "sample string 7",
  "VolumeNumber": 8.0,
  "VolumeYear": 9.0,
  "Title": "sample string 10",
  "DisplayTitle": "sample string 11",
  "ParentId": "e32bcb7d-c574-4d99-9264-cf3d31a45231",
  "Provider": "sample string 13",
  "Comments": {
    "Name": "sample string 1",
    "Message": "sample string 2",
    "DateCreated": "2026-08-30T00:28:42.1607123+00:00",
    "ProfilePictureUrl": "sample string 4",
    "ProfilePictureThumbnailUrl": "sample string 5"
  }
}

Patch volumes by key

Partial update for volumes item.

Copy PATCH /api/news/volumes({key})
Request Informaion

URI Parameters

Name Description Type Additional Information
key

System.Guid

Required

Body Parameters

Name Description Type Additional Information
LastModified

System.DateTimeOffset

Read only: True
Selected by default: True

PublicationDate

System.DateTimeOffset

Read only: False
Selected by default: True

DateCreated

System.DateTimeOffset

Read only: True
Selected by default: True

IncludeInSitemap

System.Boolean

Read only: False
Selected by default: True

SystemSourceKey

System.String

Read only: False
Selected by default: True

UrlName

System.String

Read only: False
Selected by default: True

ItemDefaultUrl

System.String

Read only: True
Selected by default: True

VolumeNumber

System.Decimal

Read only: False
Selected by default: True

VolumeYear

System.Decimal

Read only: False
Selected by default: True

Title

System.String

Read only: False
Selected by default: True

DisplayTitle

System.String

Read only: False
Selected by default: True

ParentId

System.Guid

Read only: False
Selected by default: True

Provider

System.String

Read only: True
Selected by default: True

Comments

Telerik.Sitefinity.Services.Comments.CommentContract

Read only: True
Selected by default: False

Request Formats
Copy
application/json
{
  "PublicationDate": "2026-08-30T00:28:42.1607123Z",
  "IncludeInSitemap": true,
  "SystemSourceKey": "sample string 3",
  "UrlName": "sample string 4",
  "VolumeNumber": 5.0,
  "VolumeYear": 6.0,
  "Title": "sample string 7",
  "DisplayTitle": "sample string 8",
  "ParentId": "c39f50e3-4f25-4794-8aee-d7dfd5f310a0"
}
Response Informaion

Resource Description

Method can return success code: NoContent - 204 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Resource Format

Response Formats

None.

Put volumes by key

Full update for volumes item.

Copy PUT /api/news/volumes({key})
Request Informaion

URI Parameters

Name Description Type Additional Information
key

System.Guid

Required

Body Parameters

Name Description Type Additional Information
LastModified

System.DateTimeOffset

Read only: True
Selected by default: True

PublicationDate

System.DateTimeOffset

Read only: False
Selected by default: True

DateCreated

System.DateTimeOffset

Read only: True
Selected by default: True

IncludeInSitemap

System.Boolean

Read only: False
Selected by default: True

SystemSourceKey

System.String

Read only: False
Selected by default: True

UrlName

System.String

Read only: False
Selected by default: True

ItemDefaultUrl

System.String

Read only: True
Selected by default: True

VolumeNumber

System.Decimal

Read only: False
Selected by default: True

VolumeYear

System.Decimal

Read only: False
Selected by default: True

Title

System.String

Read only: False
Selected by default: True

DisplayTitle

System.String

Read only: False
Selected by default: True

ParentId

System.Guid

Read only: False
Selected by default: True

Provider

System.String

Read only: True
Selected by default: True

Comments

Telerik.Sitefinity.Services.Comments.CommentContract

Read only: True
Selected by default: False

Request Formats
Copy
application/json
{
  "PublicationDate": "2026-08-30T00:28:42.1607123Z",
  "IncludeInSitemap": true,
  "SystemSourceKey": "sample string 3",
  "UrlName": "sample string 4",
  "VolumeNumber": 5.0,
  "VolumeYear": 6.0,
  "Title": "sample string 7",
  "DisplayTitle": "sample string 8",
  "ParentId": "58fbe1e9-f35d-43a2-9b31-337335759b41"
}
Response Informaion

Resource Description

Method can return success code: NoContent - 204 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Resource Format

Response Formats

None.

Delete volumes by key

Deletes a volumes item by Id.

Copy DELETE /api/news/volumes({key})
Request Informaion

URI Parameters

Name Description Type Additional Information
key

System.Guid

Required

Body Parameters

None

Request Formats

None.

Response Informaion

Resource Description

Method can return success code: NoContent - 204 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Resource Format

Response Formats

None.

Get Parent

Returns a set of related items of type Parent from volumes item.

Copy GET /api/news/volumes({key})/Parent
Request Informaion

URI Parameters

Name Description Type Additional Information
key

System.Guid

Required

Body Parameters

None

Request Formats

None.

Response Informaion

Resource Description

Method can return success code: OK - 200 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Name Description Type Additional Information
LastModified

System.DateTimeOffset

Read only: True
Selected by default: True

PublicationDate

System.DateTimeOffset

Read only: False
Selected by default: True

DateCreated

System.DateTimeOffset

Read only: True
Selected by default: True

IncludeInSitemap

System.Boolean

Read only: False
Selected by default: True

SystemSourceKey

System.String

Read only: False
Selected by default: True

UrlName

System.String

Read only: False
Selected by default: True

ItemDefaultUrl

System.String

Read only: True
Selected by default: True

publishingoffices

System.Guid

Read only: False
Selected by default: False

IsWhoPublication

System.Boolean

Read only: False
Selected by default: True

regionscountries

System.Guid

Read only: False
Selected by default: False

ArticleSortingOrder

System.String

Read only: False
Selected by default: True

IsActive

System.Boolean

Read only: False
Selected by default: True

Title

System.String

Read only: False
Selected by default: True

healthtopics

System.Guid

Read only: False
Selected by default: False

Summary

System.String

Read only: False
Selected by default: True

Provider

System.String

Read only: True
Selected by default: True

Comments

Telerik.Sitefinity.Services.Comments.CommentContract

Read only: True
Selected by default: False

Resource Format

Response Formats
Copy
application/json
[
  {
    "LastModified": "2026-08-30T00:28:42.1607123Z",
    "PublicationDate": "2026-08-30T00:28:42.1607123Z",
    "DateCreated": "2026-08-30T00:28:42.1607123Z",
    "IncludeInSitemap": true,
    "SystemSourceKey": "sample string 5",
    "UrlName": "sample string 6",
    "ItemDefaultUrl": "sample string 7",
    "publishingoffices": "60f849f2-51b6-455d-b6e1-ea13604a82a3",
    "IsWhoPublication": true,
    "regionscountries": "58dd9cb4-7ba9-4b69-9c31-f5ef89406273",
    "ArticleSortingOrder": "sample string 11",
    "IsActive": true,
    "Title": "sample string 13",
    "healthtopics": "ee6b8f0f-7480-4dfb-b7ed-2377b308751f",
    "Summary": "sample string 15",
    "Provider": "sample string 16",
    "Comments": {
      "Name": "sample string 1",
      "Message": "sample string 2",
      "DateCreated": "2026-08-30T00:28:42.1607123+00:00",
      "ProfilePictureUrl": "sample string 4",
      "ProfilePictureThumbnailUrl": "sample string 5"
    }
  },
  {
    "LastModified": "2026-08-30T00:28:42.1607123Z",
    "PublicationDate": "2026-08-30T00:28:42.1607123Z",
    "DateCreated": "2026-08-30T00:28:42.1607123Z",
    "IncludeInSitemap": true,
    "SystemSourceKey": "sample string 5",
    "UrlName": "sample string 6",
    "ItemDefaultUrl": "sample string 7",
    "publishingoffices": "60f849f2-51b6-455d-b6e1-ea13604a82a3",
    "IsWhoPublication": true,
    "regionscountries": "58dd9cb4-7ba9-4b69-9c31-f5ef89406273",
    "ArticleSortingOrder": "sample string 11",
    "IsActive": true,
    "Title": "sample string 13",
    "healthtopics": "ee6b8f0f-7480-4dfb-b7ed-2377b308751f",
    "Summary": "sample string 15",
    "Provider": "sample string 16",
    "Comments": {
      "Name": "sample string 1",
      "Message": "sample string 2",
      "DateCreated": "2026-08-30T00:28:42.1607123+00:00",
      "ProfilePictureUrl": "sample string 4",
      "ProfilePictureThumbnailUrl": "sample string 5"
    }
  }
]

Get Parent by relatedKey

Returns a related item of type Parent from volumes item.

Copy GET /api/news/volumes({key})/Parent({relatedKey})
Request Informaion

URI Parameters

Name Description Type Additional Information
key

System.Guid

Required

relatedKey

System.Guid

Required

Body Parameters

None

Request Formats

None.

Response Informaion

Resource Description

Method can return success code: OK - 200 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Name Description Type Additional Information
LastModified

System.DateTimeOffset

Read only: True
Selected by default: True

PublicationDate

System.DateTimeOffset

Read only: False
Selected by default: True

DateCreated

System.DateTimeOffset

Read only: True
Selected by default: True

IncludeInSitemap

System.Boolean

Read only: False
Selected by default: True

SystemSourceKey

System.String

Read only: False
Selected by default: True

UrlName

System.String

Read only: False
Selected by default: True

ItemDefaultUrl

System.String

Read only: True
Selected by default: True

publishingoffices

System.Guid

Read only: False
Selected by default: False

IsWhoPublication

System.Boolean

Read only: False
Selected by default: True

regionscountries

System.Guid

Read only: False
Selected by default: False

ArticleSortingOrder

System.String

Read only: False
Selected by default: True

IsActive

System.Boolean

Read only: False
Selected by default: True

Title

System.String

Read only: False
Selected by default: True

healthtopics

System.Guid

Read only: False
Selected by default: False

Summary

System.String

Read only: False
Selected by default: True

Provider

System.String

Read only: True
Selected by default: True

Comments

Telerik.Sitefinity.Services.Comments.CommentContract

Read only: True
Selected by default: False

Resource Format

Response Formats
Copy
application/json
{
  "LastModified": "2026-08-30T00:28:42.1607123Z",
  "PublicationDate": "2026-08-30T00:28:42.1607123Z",
  "DateCreated": "2026-08-30T00:28:42.1607123Z",
  "IncludeInSitemap": true,
  "SystemSourceKey": "sample string 5",
  "UrlName": "sample string 6",
  "ItemDefaultUrl": "sample string 7",
  "publishingoffices": "712b61fc-0cd5-47ef-bfc2-07ee4f37a357",
  "IsWhoPublication": true,
  "regionscountries": "22c2d399-c19e-4eff-9926-324f9afa60cf",
  "ArticleSortingOrder": "sample string 11",
  "IsActive": true,
  "Title": "sample string 13",
  "healthtopics": "c4a59311-111a-42c9-933b-f9c00264a56a",
  "Summary": "sample string 15",
  "Provider": "sample string 16",
  "Comments": {
    "Name": "sample string 1",
    "Message": "sample string 2",
    "DateCreated": "2026-08-30T00:28:42.1607123+00:00",
    "ProfilePictureUrl": "sample string 4",
    "ProfilePictureThumbnailUrl": "sample string 5"
  }
}

Post Parent

Add Parent relation to volumes item.

Copy POST /api/news/volumes({key})/Parent/$ref
Request Informaion

URI Parameters

Name Description Type Additional Information
key

System.Guid

Required

Body Parameters

None

Request Formats
Copy
application/json
{
  "@odata.id": "http://host/route/service/type(key)"
}
Response Informaion

Resource Description

Method can return success code: NoContent - 204 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Resource Format

Response Formats

None.

Delete Parent

Delete set of related items of type Parent from volumes item.

Copy DELETE /api/news/volumes({key})/Parent/$ref
Request Informaion

URI Parameters

Name Description Type Additional Information
key

System.Guid

Required

Body Parameters

None

Request Formats

None.

Response Informaion

Resource Description

Method can return success code: NoContent - 204 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Resource Format

Response Formats

None.

Delete Parent by relatedKey

Delete relation of type Parent from volumes item.

Copy DELETE /api/news/volumes({key})/Parent({relatedKey})/$ref
Request Informaion

URI Parameters

Name Description Type Additional Information
key

System.Guid

Required

relatedKey

System.Guid

Required

Body Parameters

None

Request Formats

None.

Response Informaion

Resource Description

Method can return success code: NoContent - 204 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Resource Format

Response Formats

None.