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

Series

Get series

Returns a set of data items of type series.

Copy GET /api/default/series
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

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-10-13T16:29:18.8627342Z",
    "PublicationDate": "2026-10-13T16:29:18.8627342Z",
    "DateCreated": "2026-10-13T16:29:18.8627342Z",
    "IncludeInSitemap": true,
    "SystemSourceKey": "sample string 5",
    "UrlName": "sample string 6",
    "ItemDefaultUrl": "sample string 7",
    "publishingoffices": "a7bf9261-065c-4c35-aa3a-97a423990e9b",
    "IsWhoPublication": true,
    "regionscountries": "ee686629-6866-4e37-8ba2-2160983f5825",
    "ArticleSortingOrder": "sample string 11",
    "IsActive": true,
    "Title": "sample string 13",
    "healthtopics": "ae9b802d-1098-4480-b000-ed67119aa80d",
    "Summary": "sample string 15",
    "Provider": "sample string 16",
    "Comments": {
      "Name": "sample string 1",
      "Message": "sample string 2",
      "DateCreated": "2026-10-13T16:29:18.8627342+00:00",
      "ProfilePictureUrl": "sample string 4",
      "ProfilePictureThumbnailUrl": "sample string 5"
    }
  },
  {
    "LastModified": "2026-10-13T16:29:18.8627342Z",
    "PublicationDate": "2026-10-13T16:29:18.8627342Z",
    "DateCreated": "2026-10-13T16:29:18.8627342Z",
    "IncludeInSitemap": true,
    "SystemSourceKey": "sample string 5",
    "UrlName": "sample string 6",
    "ItemDefaultUrl": "sample string 7",
    "publishingoffices": "a7bf9261-065c-4c35-aa3a-97a423990e9b",
    "IsWhoPublication": true,
    "regionscountries": "ee686629-6866-4e37-8ba2-2160983f5825",
    "ArticleSortingOrder": "sample string 11",
    "IsActive": true,
    "Title": "sample string 13",
    "healthtopics": "ae9b802d-1098-4480-b000-ed67119aa80d",
    "Summary": "sample string 15",
    "Provider": "sample string 16",
    "Comments": {
      "Name": "sample string 1",
      "Message": "sample string 2",
      "DateCreated": "2026-10-13T16:29:18.8627342+00:00",
      "ProfilePictureUrl": "sample string 4",
      "ProfilePictureThumbnailUrl": "sample string 5"
    }
  }
]

Get series by key

Gets series item by id.

Copy GET /api/default/series({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

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-10-13T16:29:18.8627342Z",
  "PublicationDate": "2026-10-13T16:29:18.8627342Z",
  "DateCreated": "2026-10-13T16:29:18.8627342Z",
  "IncludeInSitemap": true,
  "SystemSourceKey": "sample string 5",
  "UrlName": "sample string 6",
  "ItemDefaultUrl": "sample string 7",
  "publishingoffices": "ff65680e-d7c0-4b4b-8f77-d1c782c72a80",
  "IsWhoPublication": true,
  "regionscountries": "df9b942f-2ef9-4056-8b93-5d1eb7291704",
  "ArticleSortingOrder": "sample string 11",
  "IsActive": true,
  "Title": "sample string 13",
  "healthtopics": "7b2f71c0-a562-4ae4-af19-517987878077",
  "Summary": "sample string 15",
  "Provider": "sample string 16",
  "Comments": {
    "Name": "sample string 1",
    "Message": "sample string 2",
    "DateCreated": "2026-10-13T16:29:18.8627342+00:00",
    "ProfilePictureUrl": "sample string 4",
    "ProfilePictureThumbnailUrl": "sample string 5"
  }
}

Get property

Gets Id property from series item.

Copy GET /api/default/series({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": "202aa6aa-adeb-4918-9385-2a81421290f6"
}

Post series

Creates a series item.

Copy POST /api/default/series
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

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

Request Formats
Copy
application/json
{
  "PublicationDate": "2026-10-13T16:29:18.8627342Z",
  "IncludeInSitemap": true,
  "SystemSourceKey": "sample string 3",
  "UrlName": "sample string 4",
  "publishingoffices": "d7366a04-df1b-41bf-b9d4-8a73d0e5fba6",
  "IsWhoPublication": true,
  "regionscountries": "d4d9014a-f467-42cc-b5af-217ca034577b",
  "ArticleSortingOrder": "sample string 8",
  "IsActive": true,
  "Title": "sample string 10",
  "healthtopics": "c64e0961-6f1a-48c9-ac74-ad52a7a3ffe6",
  "Summary": "sample string 12"
}
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

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-10-13T16:29:18.8627342Z",
  "PublicationDate": "2026-10-13T16:29:18.8627342Z",
  "DateCreated": "2026-10-13T16:29:18.8627342Z",
  "IncludeInSitemap": true,
  "SystemSourceKey": "sample string 5",
  "UrlName": "sample string 6",
  "ItemDefaultUrl": "sample string 7",
  "publishingoffices": "8b752dc6-a74f-4b1b-9693-6b116eef70d6",
  "IsWhoPublication": true,
  "regionscountries": "7922fd5c-0f20-4b09-91b2-627425654a97",
  "ArticleSortingOrder": "sample string 11",
  "IsActive": true,
  "Title": "sample string 13",
  "healthtopics": "dfd74aed-4a61-4945-8792-2058f2f61a68",
  "Summary": "sample string 15",
  "Provider": "sample string 16",
  "Comments": {
    "Name": "sample string 1",
    "Message": "sample string 2",
    "DateCreated": "2026-10-13T16:29:18.8627342+00:00",
    "ProfilePictureUrl": "sample string 4",
    "ProfilePictureThumbnailUrl": "sample string 5"
  }
}

Patch series by key

Partial update for series item.

Copy PATCH /api/default/series({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

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

Request Formats
Copy
application/json
{
  "PublicationDate": "2026-10-13T16:29:18.8627342Z",
  "IncludeInSitemap": true,
  "SystemSourceKey": "sample string 3",
  "UrlName": "sample string 4",
  "publishingoffices": "25dc52c8-e287-4879-898a-1e0aecd3f007",
  "IsWhoPublication": true,
  "regionscountries": "5307ee67-1065-4df5-a4eb-d0cf1ee416ac",
  "ArticleSortingOrder": "sample string 8",
  "IsActive": true,
  "Title": "sample string 10",
  "healthtopics": "5404ac54-5c2e-4380-9322-22f3320cd051",
  "Summary": "sample string 12"
}
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 series by key

Full update for series item.

Copy PUT /api/default/series({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

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

Request Formats
Copy
application/json
{
  "PublicationDate": "2026-10-13T16:29:18.8627342Z",
  "IncludeInSitemap": true,
  "SystemSourceKey": "sample string 3",
  "UrlName": "sample string 4",
  "publishingoffices": "12a30893-6b5a-4be5-948e-a0295970c26f",
  "IsWhoPublication": true,
  "regionscountries": "d807b776-8c8e-4471-9bef-f8d95ecec507",
  "ArticleSortingOrder": "sample string 8",
  "IsActive": true,
  "Title": "sample string 10",
  "healthtopics": "c372be56-029e-4299-8648-e825714e35f9",
  "Summary": "sample string 12"
}
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 series by key

Deletes a series item by Id.

Copy DELETE /api/default/series({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 MainImage

Returns a set of related items of type MainImage from series item.

Copy GET /api/default/series({key})/MainImage
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

Title

System.String

Read only: False
Selected by default: True

Description

System.String

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

Ordinal

System.Single

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

Author

System.String

Read only: False
Selected by default: True

Extension

System.String

Read only: True
Selected by default: True

MimeType

System.String

Read only: True
Selected by default: True

TotalSize

System.Int64

Read only: True
Selected by default: True

regionscountries

System.Guid

Read only: False
Selected by default: False

publishingoffices

System.Guid

Read only: False
Selected by default: False

events

System.Guid

Read only: False
Selected by default: False

targets

System.Guid

Read only: False
Selected by default: False

Category

System.Guid

Read only: False
Selected by default: False

imagetypes

System.Guid

Read only: False
Selected by default: False

JoomlaArticleId

System.String

Read only: False
Selected by default: True

departmentaltargets

System.Guid

Read only: False
Selected by default: False

stakeholders

System.Guid

Read only: False
Selected by default: False

Tags

System.Guid

Read only: False
Selected by default: False

healthtopics

System.Guid

Read only: False
Selected by default: False

targetaudiences

System.Guid

Read only: False
Selected by default: False

IsOptimized

System.Boolean

Read only: False
Selected by default: True

OptImgStatus

System.String

Read only: False
Selected by default: True

Width

System.Int32

Read only: True
Selected by default: True

Height

System.Int32

Read only: True
Selected by default: True

AlternativeText

System.String

Read only: False
Selected by default: True

FolderId

System.Guid

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

Url

System.String

Read only: True
Selected by default: True

ThumbnailUrl

System.String

Read only: True
Selected by default: True

Thumbnails

Telerik.Sitefinity.Modules.Libraries.Web.Services.Extensibility.ThumbnailModel

Read only: True
Selected by default: False

IsDamMedia

System.Boolean

Read only: True
Selected by default: False

Resource Format

Response Formats
Copy
application/json
[
  {
    "LastModified": "2026-10-13T16:29:18.8627342Z",
    "PublicationDate": "2026-10-13T16:29:18.8627342Z",
    "Title": "sample string 3",
    "Description": "sample string 4",
    "DateCreated": "2026-10-13T16:29:18.8627342Z",
    "IncludeInSitemap": true,
    "SystemSourceKey": "sample string 7",
    "Ordinal": 8.1,
    "UrlName": "sample string 9",
    "ItemDefaultUrl": "sample string 10",
    "Author": "sample string 11",
    "Extension": "sample string 12",
    "MimeType": "sample string 13",
    "TotalSize": 14,
    "regionscountries": "d287f1a1-98d0-4345-a7f2-ea3011615d2b",
    "publishingoffices": "d339c640-0437-439a-9ba3-6323f2a8efd8",
    "events": "7a9b15da-98ea-458d-925b-7990df339f09",
    "targets": "d08f17a0-5c82-41dd-bff5-7190a5e7c06b",
    "Category": "8576972e-bfd6-4d13-834a-28a6cb840197",
    "imagetypes": "bba2a092-d186-49f9-a717-58894add7e2d",
    "JoomlaArticleId": "sample string 21",
    "departmentaltargets": "8077c86a-e757-485d-9d94-964895ba4031",
    "stakeholders": "6f8e3897-4e8d-4346-a6c2-fa7ca5e26c12",
    "Tags": "b2227b7c-df4a-459e-b8c9-25b0ec91d272",
    "healthtopics": "637d5a3f-8546-47e8-9954-67a151ad46ef",
    "targetaudiences": "2d5e892c-02a4-45f7-b443-ba456e55c3ec",
    "IsOptimized": true,
    "OptImgStatus": "sample string 28",
    "Width": 29,
    "Height": 30,
    "AlternativeText": "sample string 31",
    "FolderId": "17b2d70b-0f27-4f7e-bec5-42eb96aa28da",
    "ParentId": "9ae4cd1f-e83c-4175-8b9d-ba6148ffb5d8",
    "Provider": "sample string 34",
    "Url": "sample string 35",
    "ThumbnailUrl": "sample string 36",
    "Thumbnails": {
      "Title": "sample string 1",
      "Url": "sample string 2",
      "Width": 3,
      "Height": 4,
      "MimeType": "sample string 5"
    },
    "IsDamMedia": true
  },
  {
    "LastModified": "2026-10-13T16:29:18.8627342Z",
    "PublicationDate": "2026-10-13T16:29:18.8627342Z",
    "Title": "sample string 3",
    "Description": "sample string 4",
    "DateCreated": "2026-10-13T16:29:18.8627342Z",
    "IncludeInSitemap": true,
    "SystemSourceKey": "sample string 7",
    "Ordinal": 8.1,
    "UrlName": "sample string 9",
    "ItemDefaultUrl": "sample string 10",
    "Author": "sample string 11",
    "Extension": "sample string 12",
    "MimeType": "sample string 13",
    "TotalSize": 14,
    "regionscountries": "d287f1a1-98d0-4345-a7f2-ea3011615d2b",
    "publishingoffices": "d339c640-0437-439a-9ba3-6323f2a8efd8",
    "events": "7a9b15da-98ea-458d-925b-7990df339f09",
    "targets": "d08f17a0-5c82-41dd-bff5-7190a5e7c06b",
    "Category": "8576972e-bfd6-4d13-834a-28a6cb840197",
    "imagetypes": "bba2a092-d186-49f9-a717-58894add7e2d",
    "JoomlaArticleId": "sample string 21",
    "departmentaltargets": "8077c86a-e757-485d-9d94-964895ba4031",
    "stakeholders": "6f8e3897-4e8d-4346-a6c2-fa7ca5e26c12",
    "Tags": "b2227b7c-df4a-459e-b8c9-25b0ec91d272",
    "healthtopics": "637d5a3f-8546-47e8-9954-67a151ad46ef",
    "targetaudiences": "2d5e892c-02a4-45f7-b443-ba456e55c3ec",
    "IsOptimized": true,
    "OptImgStatus": "sample string 28",
    "Width": 29,
    "Height": 30,
    "AlternativeText": "sample string 31",
    "FolderId": "17b2d70b-0f27-4f7e-bec5-42eb96aa28da",
    "ParentId": "9ae4cd1f-e83c-4175-8b9d-ba6148ffb5d8",
    "Provider": "sample string 34",
    "Url": "sample string 35",
    "ThumbnailUrl": "sample string 36",
    "Thumbnails": {
      "Title": "sample string 1",
      "Url": "sample string 2",
      "Width": 3,
      "Height": 4,
      "MimeType": "sample string 5"
    },
    "IsDamMedia": true
  }
]

Get MainImage by relatedKey

Returns a related item of type MainImage from series item.

Copy GET /api/default/series({key})/MainImage({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

Title

System.String

Read only: False
Selected by default: True

Description

System.String

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

Ordinal

System.Single

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

Author

System.String

Read only: False
Selected by default: True

Extension

System.String

Read only: True
Selected by default: True

MimeType

System.String

Read only: True
Selected by default: True

TotalSize

System.Int64

Read only: True
Selected by default: True

regionscountries

System.Guid

Read only: False
Selected by default: False

publishingoffices

System.Guid

Read only: False
Selected by default: False

events

System.Guid

Read only: False
Selected by default: False

targets

System.Guid

Read only: False
Selected by default: False

Category

System.Guid

Read only: False
Selected by default: False

imagetypes

System.Guid

Read only: False
Selected by default: False

JoomlaArticleId

System.String

Read only: False
Selected by default: True

departmentaltargets

System.Guid

Read only: False
Selected by default: False

stakeholders

System.Guid

Read only: False
Selected by default: False

Tags

System.Guid

Read only: False
Selected by default: False

healthtopics

System.Guid

Read only: False
Selected by default: False

targetaudiences

System.Guid

Read only: False
Selected by default: False

IsOptimized

System.Boolean

Read only: False
Selected by default: True

OptImgStatus

System.String

Read only: False
Selected by default: True

Width

System.Int32

Read only: True
Selected by default: True

Height

System.Int32

Read only: True
Selected by default: True

AlternativeText

System.String

Read only: False
Selected by default: True

FolderId

System.Guid

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

Url

System.String

Read only: True
Selected by default: True

ThumbnailUrl

System.String

Read only: True
Selected by default: True

Thumbnails

Telerik.Sitefinity.Modules.Libraries.Web.Services.Extensibility.ThumbnailModel

Read only: True
Selected by default: False

IsDamMedia

System.Boolean

Read only: True
Selected by default: False

Resource Format

Response Formats
Copy
application/json
{
  "LastModified": "2026-10-13T16:29:18.8627342Z",
  "PublicationDate": "2026-10-13T16:29:18.8627342Z",
  "Title": "sample string 3",
  "Description": "sample string 4",
  "DateCreated": "2026-10-13T16:29:18.8627342Z",
  "IncludeInSitemap": true,
  "SystemSourceKey": "sample string 7",
  "Ordinal": 8.1,
  "UrlName": "sample string 9",
  "ItemDefaultUrl": "sample string 10",
  "Author": "sample string 11",
  "Extension": "sample string 12",
  "MimeType": "sample string 13",
  "TotalSize": 14,
  "regionscountries": "579f8c3e-da9a-4c6b-b199-f310520a84bd",
  "publishingoffices": "33b328c5-99b2-4abe-a388-d97d90b73326",
  "events": "5263669e-ddc9-4bd5-8e12-dca78b0aef70",
  "targets": "fc7d0029-704d-4c6f-89d3-6bf958d9beb0",
  "Category": "5507eb56-88ff-489b-92ca-f52b36626a51",
  "imagetypes": "3eb21e71-e75a-415e-938d-891258982dfc",
  "JoomlaArticleId": "sample string 21",
  "departmentaltargets": "a5eaae00-19ae-4c3d-84a9-47bfabf141db",
  "stakeholders": "1585baaa-af4c-4e6c-af78-1f44e28aa280",
  "Tags": "7bc8806f-ca1e-4e12-b12e-1a3678c43ff9",
  "healthtopics": "f469b56c-0c49-41e1-ae3b-a55c6f4affd1",
  "targetaudiences": "87b7b06b-6f92-4e88-b6a8-1765a85198fe",
  "IsOptimized": true,
  "OptImgStatus": "sample string 28",
  "Width": 29,
  "Height": 30,
  "AlternativeText": "sample string 31",
  "FolderId": "0e86ec18-361c-42f1-85ba-b4848ea3b66e",
  "ParentId": "d1c64b86-2c41-474d-a6f4-d81889bab67d",
  "Provider": "sample string 34",
  "Url": "sample string 35",
  "ThumbnailUrl": "sample string 36",
  "Thumbnails": {
    "Title": "sample string 1",
    "Url": "sample string 2",
    "Width": 3,
    "Height": 4,
    "MimeType": "sample string 5"
  },
  "IsDamMedia": true
}

Post MainImage

Add MainImage relation to series item.

Copy POST /api/default/series({key})/MainImage/$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 MainImage

Delete set of related items of type MainImage from series item.

Copy DELETE /api/default/series({key})/MainImage/$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 MainImage by relatedKey

Delete relation of type MainImage from series item.

Copy DELETE /api/default/series({key})/MainImage({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.