RESTful API

Get newsitems

Returns a set of data items of type newsitems.

Copy


                                        GET /api/news/newsitems

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
PublicationDate		System.DateTimeOffset	Read only: False
Title		System.String	Read only: False
Description		System.String	Read only: False
DateCreated		System.DateTimeOffset	Read only: True
IncludeInSitemap		System.Boolean	Read only: False
UrlName		System.String	Read only: False
ShowPhotoCaption		System.Boolean	Read only: False
Category		System.Guid	Read only: False
HideImage		System.Boolean	Read only: False
OpenGraphDescription		System.String	Read only: False
OpenGraphTitle		System.String	Read only: False
FeaturedNews		System.Boolean	Read only: False
CircularYear		System.Decimal	Read only: False
CircularNumber		System.Decimal	Read only: False
Tags		System.Guid	Read only: False
CallToActionText		System.String	Read only: False
CallToActionUrl		System.String	Read only: False
Summary		System.String	Read only: False
Content		System.String	Read only: False
Author		System.String	Read only: False
SourceName		System.String	Read only: False
SourceSite		System.String	Read only: False
Provider		System.String	Read only: True

Resource Format

Response Formats

Copy


                                                                    application/json
                                                                    [
  {
    "LastModified": "2024-12-20T18:57:05.5300654Z",
    "PublicationDate": "2024-12-20T18:57:05.5300654Z",
    "Title": "sample string 3",
    "Description": "sample string 4",
    "DateCreated": "2024-12-20T18:57:05.5300654Z",
    "IncludeInSitemap": true,
    "UrlName": "sample string 7",
    "ShowPhotoCaption": true,
    "Category": "008ad07d-59b2-4a52-8a48-644dc15cf86b",
    "HideImage": true,
    "OpenGraphDescription": "sample string 11",
    "OpenGraphTitle": "sample string 12",
    "FeaturedNews": true,
    "CircularYear": 14.0,
    "CircularNumber": 15.0,
    "Tags": "6658c32c-0597-4ee8-864d-3c1881472fba",
    "CallToActionText": "sample string 17",
    "CallToActionUrl": "sample string 18",
    "Summary": "sample string 19",
    "Content": "sample string 20",
    "Author": "sample string 21",
    "SourceName": "sample string 22",
    "SourceSite": "sample string 23",
    "Provider": "sample string 24"
  },
  {
    "LastModified": "2024-12-20T18:57:05.5300654Z",
    "PublicationDate": "2024-12-20T18:57:05.5300654Z",
    "Title": "sample string 3",
    "Description": "sample string 4",
    "DateCreated": "2024-12-20T18:57:05.5300654Z",
    "IncludeInSitemap": true,
    "UrlName": "sample string 7",
    "ShowPhotoCaption": true,
    "Category": "008ad07d-59b2-4a52-8a48-644dc15cf86b",
    "HideImage": true,
    "OpenGraphDescription": "sample string 11",
    "OpenGraphTitle": "sample string 12",
    "FeaturedNews": true,
    "CircularYear": 14.0,
    "CircularNumber": 15.0,
    "Tags": "6658c32c-0597-4ee8-864d-3c1881472fba",
    "CallToActionText": "sample string 17",
    "CallToActionUrl": "sample string 18",
    "Summary": "sample string 19",
    "Content": "sample string 20",
    "Author": "sample string 21",
    "SourceName": "sample string 22",
    "SourceSite": "sample string 23",
    "Provider": "sample string 24"
  }
]

Get newsitems by key

Gets newsitems item by id.

Copy


                                        GET /api/news/newsitems({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
PublicationDate		System.DateTimeOffset	Read only: False
Title		System.String	Read only: False
Description		System.String	Read only: False
DateCreated		System.DateTimeOffset	Read only: True
IncludeInSitemap		System.Boolean	Read only: False
UrlName		System.String	Read only: False
ShowPhotoCaption		System.Boolean	Read only: False
Category		System.Guid	Read only: False
HideImage		System.Boolean	Read only: False
OpenGraphDescription		System.String	Read only: False
OpenGraphTitle		System.String	Read only: False
FeaturedNews		System.Boolean	Read only: False
CircularYear		System.Decimal	Read only: False
CircularNumber		System.Decimal	Read only: False
Tags		System.Guid	Read only: False
CallToActionText		System.String	Read only: False
CallToActionUrl		System.String	Read only: False
Summary		System.String	Read only: False
Content		System.String	Read only: False
Author		System.String	Read only: False
SourceName		System.String	Read only: False
SourceSite		System.String	Read only: False
Provider		System.String	Read only: True

Resource Format

Response Formats

Copy


                                                                    application/json
                                                                    {
  "LastModified": "2024-12-20T18:57:05.5300654Z",
  "PublicationDate": "2024-12-20T18:57:05.5300654Z",
  "Title": "sample string 3",
  "Description": "sample string 4",
  "DateCreated": "2024-12-20T18:57:05.5300654Z",
  "IncludeInSitemap": true,
  "UrlName": "sample string 7",
  "ShowPhotoCaption": true,
  "Category": "95731509-d7b2-4d98-bfca-502c584bb011",
  "HideImage": true,
  "OpenGraphDescription": "sample string 11",
  "OpenGraphTitle": "sample string 12",
  "FeaturedNews": true,
  "CircularYear": 14.0,
  "CircularNumber": 15.0,
  "Tags": "334711c4-be1b-490b-af3e-a6b074c33c60",
  "CallToActionText": "sample string 17",
  "CallToActionUrl": "sample string 18",
  "Summary": "sample string 19",
  "Content": "sample string 20",
  "Author": "sample string 21",
  "SourceName": "sample string 22",
  "SourceSite": "sample string 23",
  "Provider": "sample string 24"
}

Get property

Gets Id property from newsitems item.

Copy


                                        GET /api/news/newsitems({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": "9f829c55-8053-46d3-975e-d5e8c92bb20b"
}

Post newsitems

Creates a newsitems item.

Copy


                                        POST /api/news/newsitems

Request Informaion

URI Parameters

None

Body Parameters

Name	Description	Type	Additional Information
LastModified		System.DateTimeOffset	Read only: True
PublicationDate		System.DateTimeOffset	Read only: False
Title		System.String	Read only: False
Description		System.String	Read only: False
DateCreated		System.DateTimeOffset	Read only: True
IncludeInSitemap		System.Boolean	Read only: False
UrlName		System.String	Read only: False
ShowPhotoCaption		System.Boolean	Read only: False
Category		System.Guid	Read only: False
HideImage		System.Boolean	Read only: False
OpenGraphDescription		System.String	Read only: False
OpenGraphTitle		System.String	Read only: False
FeaturedNews		System.Boolean	Read only: False
CircularYear		System.Decimal	Read only: False
CircularNumber		System.Decimal	Read only: False
Tags		System.Guid	Read only: False
CallToActionText		System.String	Read only: False
CallToActionUrl		System.String	Read only: False
Summary		System.String	Read only: False
Content		System.String	Read only: False
Author		System.String	Read only: False
SourceName		System.String	Read only: False
SourceSite		System.String	Read only: False
Provider		System.String	Read only: True

Request Formats

Copy


                                                                    application/json
                                                                    {
  "PublicationDate": "2024-12-20T18:57:05.5300654Z",
  "Title": "sample string 2",
  "Description": "sample string 3",
  "IncludeInSitemap": true,
  "UrlName": "sample string 5",
  "ShowPhotoCaption": true,
  "Category": "e19910e8-155c-4f39-81df-66c29d812ba5",
  "HideImage": true,
  "OpenGraphDescription": "sample string 9",
  "OpenGraphTitle": "sample string 10",
  "FeaturedNews": true,
  "CircularYear": 12.0,
  "CircularNumber": 13.0,
  "Tags": "92c16e79-39ba-4d95-b236-434ed5b99ab6",
  "CallToActionText": "sample string 15",
  "CallToActionUrl": "sample string 16",
  "Summary": "sample string 17",
  "Content": "sample string 18",
  "Author": "sample string 19",
  "SourceName": "sample string 20",
  "SourceSite": "sample string 21"
}

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
PublicationDate		System.DateTimeOffset	Read only: False
Title		System.String	Read only: False
Description		System.String	Read only: False
DateCreated		System.DateTimeOffset	Read only: True
IncludeInSitemap		System.Boolean	Read only: False
UrlName		System.String	Read only: False
ShowPhotoCaption		System.Boolean	Read only: False
Category		System.Guid	Read only: False
HideImage		System.Boolean	Read only: False
OpenGraphDescription		System.String	Read only: False
OpenGraphTitle		System.String	Read only: False
FeaturedNews		System.Boolean	Read only: False
CircularYear		System.Decimal	Read only: False
CircularNumber		System.Decimal	Read only: False
Tags		System.Guid	Read only: False
CallToActionText		System.String	Read only: False
CallToActionUrl		System.String	Read only: False
Summary		System.String	Read only: False
Content		System.String	Read only: False
Author		System.String	Read only: False
SourceName		System.String	Read only: False
SourceSite		System.String	Read only: False
Provider		System.String	Read only: True

Resource Format

Response Formats

Copy


                                                                    application/json
                                                                    {
  "LastModified": "2024-12-20T18:57:05.5300654Z",
  "PublicationDate": "2024-12-20T18:57:05.5300654Z",
  "Title": "sample string 3",
  "Description": "sample string 4",
  "DateCreated": "2024-12-20T18:57:05.5300654Z",
  "IncludeInSitemap": true,
  "UrlName": "sample string 7",
  "ShowPhotoCaption": true,
  "Category": "86bb1d39-3fc9-4e03-9e54-713fe8405ee1",
  "HideImage": true,
  "OpenGraphDescription": "sample string 11",
  "OpenGraphTitle": "sample string 12",
  "FeaturedNews": true,
  "CircularYear": 14.0,
  "CircularNumber": 15.0,
  "Tags": "47acfb78-6d9f-406b-be1f-495819e7e68f",
  "CallToActionText": "sample string 17",
  "CallToActionUrl": "sample string 18",
  "Summary": "sample string 19",
  "Content": "sample string 20",
  "Author": "sample string 21",
  "SourceName": "sample string 22",
  "SourceSite": "sample string 23",
  "Provider": "sample string 24"
}

Patch newsitems by key

Partial update for newsitems item.

Copy


                                        PATCH /api/news/newsitems({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
PublicationDate		System.DateTimeOffset	Read only: False
Title		System.String	Read only: False
Description		System.String	Read only: False
DateCreated		System.DateTimeOffset	Read only: True
IncludeInSitemap		System.Boolean	Read only: False
UrlName		System.String	Read only: False
ShowPhotoCaption		System.Boolean	Read only: False
Category		System.Guid	Read only: False
HideImage		System.Boolean	Read only: False
OpenGraphDescription		System.String	Read only: False
OpenGraphTitle		System.String	Read only: False
FeaturedNews		System.Boolean	Read only: False
CircularYear		System.Decimal	Read only: False
CircularNumber		System.Decimal	Read only: False
Tags		System.Guid	Read only: False
CallToActionText		System.String	Read only: False
CallToActionUrl		System.String	Read only: False
Summary		System.String	Read only: False
Content		System.String	Read only: False
Author		System.String	Read only: False
SourceName		System.String	Read only: False
SourceSite		System.String	Read only: False
Provider		System.String	Read only: True

Request Formats

Copy


                                                                    application/json
                                                                    {
  "PublicationDate": "2024-12-20T18:57:05.5300654Z",
  "Title": "sample string 2",
  "Description": "sample string 3",
  "IncludeInSitemap": true,
  "UrlName": "sample string 5",
  "ShowPhotoCaption": true,
  "Category": "25f7a39d-d439-4d9b-bc7b-7634b4cc86cc",
  "HideImage": true,
  "OpenGraphDescription": "sample string 9",
  "OpenGraphTitle": "sample string 10",
  "FeaturedNews": true,
  "CircularYear": 12.0,
  "CircularNumber": 13.0,
  "Tags": "a83e13ce-9046-443b-b4ba-16cfefe3ef7a",
  "CallToActionText": "sample string 15",
  "CallToActionUrl": "sample string 16",
  "Summary": "sample string 17",
  "Content": "sample string 18",
  "Author": "sample string 19",
  "SourceName": "sample string 20",
  "SourceSite": "sample string 21"
}

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 newsitems by key

Full update for newsitems item.

Copy


                                        PUT /api/news/newsitems({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
PublicationDate		System.DateTimeOffset	Read only: False
Title		System.String	Read only: False
Description		System.String	Read only: False
DateCreated		System.DateTimeOffset	Read only: True
IncludeInSitemap		System.Boolean	Read only: False
UrlName		System.String	Read only: False
ShowPhotoCaption		System.Boolean	Read only: False
Category		System.Guid	Read only: False
HideImage		System.Boolean	Read only: False
OpenGraphDescription		System.String	Read only: False
OpenGraphTitle		System.String	Read only: False
FeaturedNews		System.Boolean	Read only: False
CircularYear		System.Decimal	Read only: False
CircularNumber		System.Decimal	Read only: False
Tags		System.Guid	Read only: False
CallToActionText		System.String	Read only: False
CallToActionUrl		System.String	Read only: False
Summary		System.String	Read only: False
Content		System.String	Read only: False
Author		System.String	Read only: False
SourceName		System.String	Read only: False
SourceSite		System.String	Read only: False
Provider		System.String	Read only: True

Request Formats

Copy


                                                                    application/json
                                                                    {
  "PublicationDate": "2024-12-20T18:57:05.5300654Z",
  "Title": "sample string 2",
  "Description": "sample string 3",
  "IncludeInSitemap": true,
  "UrlName": "sample string 5",
  "ShowPhotoCaption": true,
  "Category": "5de175f2-e996-409d-919a-b7889e6a3786",
  "HideImage": true,
  "OpenGraphDescription": "sample string 9",
  "OpenGraphTitle": "sample string 10",
  "FeaturedNews": true,
  "CircularYear": 12.0,
  "CircularNumber": 13.0,
  "Tags": "0a9dd8fa-4dab-4edf-abf4-65338e15bfe9",
  "CallToActionText": "sample string 15",
  "CallToActionUrl": "sample string 16",
  "Summary": "sample string 17",
  "Content": "sample string 18",
  "Author": "sample string 19",
  "SourceName": "sample string 20",
  "SourceSite": "sample string 21"
}

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 newsitems by key

Deletes a newsitems item by Id.

Copy


                                        DELETE /api/news/newsitems({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 RelatedDocuments

Returns a set of related items of type RelatedDocuments from newsitems item.

Copy


                                        GET /api/news/newsitems({key})/RelatedDocuments

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
PublicationDate		System.DateTimeOffset	Read only: False
Title		System.String	Read only: False
Description		System.String	Read only: False
DateCreated		System.DateTimeOffset	Read only: True
IncludeInSitemap		System.Boolean	Read only: False
Ordinal		System.Single	Read only: False
UrlName		System.String	Read only: False
Author		System.String	Read only: False
Extension		System.String	Read only: True
MimeType		System.String	Read only: True
TotalSize		System.Int64	Read only: True
Tags		System.Guid	Read only: False
Category		System.Guid	Read only: False
Parts		System.String	Read only: False
FolderId		System.Guid	Read only: False
ParentId		System.Guid	Read only: False
Provider		System.String	Read only: True
Url		System.String	Read only: True
ThumbnailUrl		System.String	Read only: True
Thumbnails		Telerik.Sitefinity.Modules.Libraries.Web.Services.Extensibility.ThumbnailModel	Read only: True

Resource Format

Response Formats

Copy


                                                                    application/json
                                                                    [
  {
    "LastModified": "2024-12-20T18:57:05.5300654Z",
    "PublicationDate": "2024-12-20T18:57:05.5300654Z",
    "Title": "sample string 3",
    "Description": "sample string 4",
    "DateCreated": "2024-12-20T18:57:05.5300654Z",
    "IncludeInSitemap": true,
    "Ordinal": 7.1,
    "UrlName": "sample string 8",
    "Author": "sample string 9",
    "Extension": "sample string 10",
    "MimeType": "sample string 11",
    "TotalSize": 12,
    "Tags": "d580caa6-03f1-4a66-a899-f2289a28a8e0",
    "Category": "2bc1fb24-e9df-4700-a7c2-305fd6eb5046",
    "Parts": "sample string 15",
    "FolderId": "87b085c6-b3e8-48da-bca2-57e09c1627ed",
    "ParentId": "dc3f2d6b-76c5-4e2c-9523-60ec867d60fd",
    "Provider": "sample string 18",
    "Url": "sample string 19",
    "ThumbnailUrl": "sample string 20",
    "Thumbnails": {
      "Title": "sample string 1",
      "Url": "sample string 2",
      "Width": 3
    }
  },
  {
    "LastModified": "2024-12-20T18:57:05.5300654Z",
    "PublicationDate": "2024-12-20T18:57:05.5300654Z",
    "Title": "sample string 3",
    "Description": "sample string 4",
    "DateCreated": "2024-12-20T18:57:05.5300654Z",
    "IncludeInSitemap": true,
    "Ordinal": 7.1,
    "UrlName": "sample string 8",
    "Author": "sample string 9",
    "Extension": "sample string 10",
    "MimeType": "sample string 11",
    "TotalSize": 12,
    "Tags": "d580caa6-03f1-4a66-a899-f2289a28a8e0",
    "Category": "2bc1fb24-e9df-4700-a7c2-305fd6eb5046",
    "Parts": "sample string 15",
    "FolderId": "87b085c6-b3e8-48da-bca2-57e09c1627ed",
    "ParentId": "dc3f2d6b-76c5-4e2c-9523-60ec867d60fd",
    "Provider": "sample string 18",
    "Url": "sample string 19",
    "ThumbnailUrl": "sample string 20",
    "Thumbnails": {
      "Title": "sample string 1",
      "Url": "sample string 2",
      "Width": 3
    }
  }
]

Get RelatedDocuments by relatedKey

Returns a related item of type RelatedDocuments from newsitems item.

Copy


                                        GET /api/news/newsitems({key})/RelatedDocuments({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
PublicationDate		System.DateTimeOffset	Read only: False
Title		System.String	Read only: False
Description		System.String	Read only: False
DateCreated		System.DateTimeOffset	Read only: True
IncludeInSitemap		System.Boolean	Read only: False
Ordinal		System.Single	Read only: False
UrlName		System.String	Read only: False
Author		System.String	Read only: False
Extension		System.String	Read only: True
MimeType		System.String	Read only: True
TotalSize		System.Int64	Read only: True
Tags		System.Guid	Read only: False
Category		System.Guid	Read only: False
Parts		System.String	Read only: False
FolderId		System.Guid	Read only: False
ParentId		System.Guid	Read only: False
Provider		System.String	Read only: True
Url		System.String	Read only: True
ThumbnailUrl		System.String	Read only: True
Thumbnails		Telerik.Sitefinity.Modules.Libraries.Web.Services.Extensibility.ThumbnailModel	Read only: True

Resource Format

Response Formats

Copy


                                                                    application/json
                                                                    {
  "LastModified": "2024-12-20T18:57:05.5456891Z",
  "PublicationDate": "2024-12-20T18:57:05.5456891Z",
  "Title": "sample string 3",
  "Description": "sample string 4",
  "DateCreated": "2024-12-20T18:57:05.5456891Z",
  "IncludeInSitemap": true,
  "Ordinal": 7.1,
  "UrlName": "sample string 8",
  "Author": "sample string 9",
  "Extension": "sample string 10",
  "MimeType": "sample string 11",
  "TotalSize": 12,
  "Tags": "1ca1917d-10a7-48d9-9e34-3f7766b92059",
  "Category": "7d5a20b5-ccfe-4c90-ad2f-31d22dd6c1b6",
  "Parts": "sample string 15",
  "FolderId": "635c1cd5-1a0d-4491-8de8-0ca9e50577bc",
  "ParentId": "27cfe9d8-c2ee-4f08-9bc6-d422b930669d",
  "Provider": "sample string 18",
  "Url": "sample string 19",
  "ThumbnailUrl": "sample string 20",
  "Thumbnails": {
    "Title": "sample string 1",
    "Url": "sample string 2",
    "Width": 3
  }
}

Post RelatedDocuments

Add RelatedDocuments relation to newsitems item.

Copy


                                        POST /api/news/newsitems({key})/RelatedDocuments/$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 RelatedDocuments

Delete set of related items of type RelatedDocuments from newsitems item.

Copy


                                        DELETE /api/news/newsitems({key})/RelatedDocuments/$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 RelatedDocuments by relatedKey

Delete relation of type RelatedDocuments from newsitems item.

Copy


                                        DELETE /api/news/newsitems({key})/RelatedDocuments({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.

Get NewsImage

Returns a set of related items of type NewsImage from newsitems item.

Copy


                                        GET /api/news/newsitems({key})/NewsImage

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
PublicationDate		System.DateTimeOffset	Read only: False
Title		System.String	Read only: False
Description		System.String	Read only: False
DateCreated		System.DateTimeOffset	Read only: True
IncludeInSitemap		System.Boolean	Read only: False
Ordinal		System.Single	Read only: False
UrlName		System.String	Read only: False
Author		System.String	Read only: False
Extension		System.String	Read only: True
MimeType		System.String	Read only: True
TotalSize		System.Int64	Read only: True
LongTextCaption		System.String	Read only: False
Category		System.Guid	Read only: False
Tags		System.Guid	Read only: False
Width		System.Int32	Read only: True
Height		System.Int32	Read only: True
AlternativeText		System.String	Read only: False
FolderId		System.Guid	Read only: False
ParentId		System.Guid	Read only: False
Provider		System.String	Read only: True
Url		System.String	Read only: True
ThumbnailUrl		System.String	Read only: True
Thumbnails		Telerik.Sitefinity.Modules.Libraries.Web.Services.Extensibility.ThumbnailModel	Read only: True

Resource Format

Response Formats

Copy


                                                                    application/json
                                                                    [
  {
    "LastModified": "2024-12-20T18:57:05.5456891Z",
    "PublicationDate": "2024-12-20T18:57:05.5456891Z",
    "Title": "sample string 3",
    "Description": "sample string 4",
    "DateCreated": "2024-12-20T18:57:05.5456891Z",
    "IncludeInSitemap": true,
    "Ordinal": 7.1,
    "UrlName": "sample string 8",
    "Author": "sample string 9",
    "Extension": "sample string 10",
    "MimeType": "sample string 11",
    "TotalSize": 12,
    "LongTextCaption": "sample string 13",
    "Category": "496ada1b-f3a8-4833-9732-a492f18c7ae7",
    "Tags": "fed08e53-e4f8-46df-a2d2-7528547c90c0",
    "Width": 16,
    "Height": 17,
    "AlternativeText": "sample string 18",
    "FolderId": "a3879df8-4d24-4238-837e-b2dfbd6b1645",
    "ParentId": "e471395f-7cf8-4f53-a483-85cb479448fb",
    "Provider": "sample string 21",
    "Url": "sample string 22",
    "ThumbnailUrl": "sample string 23",
    "Thumbnails": {
      "Title": "sample string 1",
      "Url": "sample string 2",
      "Width": 3
    }
  },
  {
    "LastModified": "2024-12-20T18:57:05.5456891Z",
    "PublicationDate": "2024-12-20T18:57:05.5456891Z",
    "Title": "sample string 3",
    "Description": "sample string 4",
    "DateCreated": "2024-12-20T18:57:05.5456891Z",
    "IncludeInSitemap": true,
    "Ordinal": 7.1,
    "UrlName": "sample string 8",
    "Author": "sample string 9",
    "Extension": "sample string 10",
    "MimeType": "sample string 11",
    "TotalSize": 12,
    "LongTextCaption": "sample string 13",
    "Category": "496ada1b-f3a8-4833-9732-a492f18c7ae7",
    "Tags": "fed08e53-e4f8-46df-a2d2-7528547c90c0",
    "Width": 16,
    "Height": 17,
    "AlternativeText": "sample string 18",
    "FolderId": "a3879df8-4d24-4238-837e-b2dfbd6b1645",
    "ParentId": "e471395f-7cf8-4f53-a483-85cb479448fb",
    "Provider": "sample string 21",
    "Url": "sample string 22",
    "ThumbnailUrl": "sample string 23",
    "Thumbnails": {
      "Title": "sample string 1",
      "Url": "sample string 2",
      "Width": 3
    }
  }
]

Get NewsImage by relatedKey

Returns a related item of type NewsImage from newsitems item.

Copy


                                        GET /api/news/newsitems({key})/NewsImage({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
PublicationDate		System.DateTimeOffset	Read only: False
Title		System.String	Read only: False
Description		System.String	Read only: False
DateCreated		System.DateTimeOffset	Read only: True
IncludeInSitemap		System.Boolean	Read only: False
Ordinal		System.Single	Read only: False
UrlName		System.String	Read only: False
Author		System.String	Read only: False
Extension		System.String	Read only: True
MimeType		System.String	Read only: True
TotalSize		System.Int64	Read only: True
LongTextCaption		System.String	Read only: False
Category		System.Guid	Read only: False
Tags		System.Guid	Read only: False
Width		System.Int32	Read only: True
Height		System.Int32	Read only: True
AlternativeText		System.String	Read only: False
FolderId		System.Guid	Read only: False
ParentId		System.Guid	Read only: False
Provider		System.String	Read only: True
Url		System.String	Read only: True
ThumbnailUrl		System.String	Read only: True
Thumbnails		Telerik.Sitefinity.Modules.Libraries.Web.Services.Extensibility.ThumbnailModel	Read only: True

Resource Format

Response Formats

Copy


                                                                    application/json
                                                                    {
  "LastModified": "2024-12-20T18:57:05.5456891Z",
  "PublicationDate": "2024-12-20T18:57:05.5456891Z",
  "Title": "sample string 3",
  "Description": "sample string 4",
  "DateCreated": "2024-12-20T18:57:05.5456891Z",
  "IncludeInSitemap": true,
  "Ordinal": 7.1,
  "UrlName": "sample string 8",
  "Author": "sample string 9",
  "Extension": "sample string 10",
  "MimeType": "sample string 11",
  "TotalSize": 12,
  "LongTextCaption": "sample string 13",
  "Category": "af0b087a-a36f-408c-8f99-1161c0396e17",
  "Tags": "9793d874-5cb3-4fdb-996f-e1a43fc90a40",
  "Width": 16,
  "Height": 17,
  "AlternativeText": "sample string 18",
  "FolderId": "2b7b604b-9c01-4a71-afec-98cd8db220ec",
  "ParentId": "fbe9d8e5-3fca-4af0-aec8-5af05b3d1b90",
  "Provider": "sample string 21",
  "Url": "sample string 22",
  "ThumbnailUrl": "sample string 23",
  "Thumbnails": {
    "Title": "sample string 1",
    "Url": "sample string 2",
    "Width": 3
  }
}

Post NewsImage

Add NewsImage relation to newsitems item.

Copy


                                        POST /api/news/newsitems({key})/NewsImage/$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 NewsImage

Delete set of related items of type NewsImage from newsitems item.

Copy


                                        DELETE /api/news/newsitems({key})/NewsImage/$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 NewsImage by relatedKey

Delete relation of type NewsImage from newsitems item.

Copy


                                        DELETE /api/news/newsitems({key})/NewsImage({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.

Get OpenGraphImage

Returns a set of related items of type OpenGraphImage from newsitems item.

Copy


                                        GET /api/news/newsitems({key})/OpenGraphImage

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
PublicationDate		System.DateTimeOffset	Read only: False
Title		System.String	Read only: False
Description		System.String	Read only: False
DateCreated		System.DateTimeOffset	Read only: True
IncludeInSitemap		System.Boolean	Read only: False
Ordinal		System.Single	Read only: False
UrlName		System.String	Read only: False
Author		System.String	Read only: False
Extension		System.String	Read only: True
MimeType		System.String	Read only: True
TotalSize		System.Int64	Read only: True
LongTextCaption		System.String	Read only: False
Category		System.Guid	Read only: False
Tags		System.Guid	Read only: False
Width		System.Int32	Read only: True
Height		System.Int32	Read only: True
AlternativeText		System.String	Read only: False
FolderId		System.Guid	Read only: False
ParentId		System.Guid	Read only: False
Provider		System.String	Read only: True
Url		System.String	Read only: True
ThumbnailUrl		System.String	Read only: True
Thumbnails		Telerik.Sitefinity.Modules.Libraries.Web.Services.Extensibility.ThumbnailModel	Read only: True

Resource Format

Response Formats

Copy


                                                                    application/json
                                                                    [
  {
    "LastModified": "2024-12-20T18:57:05.5456891Z",
    "PublicationDate": "2024-12-20T18:57:05.5456891Z",
    "Title": "sample string 3",
    "Description": "sample string 4",
    "DateCreated": "2024-12-20T18:57:05.5456891Z",
    "IncludeInSitemap": true,
    "Ordinal": 7.1,
    "UrlName": "sample string 8",
    "Author": "sample string 9",
    "Extension": "sample string 10",
    "MimeType": "sample string 11",
    "TotalSize": 12,
    "LongTextCaption": "sample string 13",
    "Category": "9ddc6b52-0fed-43a5-85c8-e3d2ff31aca7",
    "Tags": "3954d7e9-d538-4556-92a1-2747446f3dd4",
    "Width": 16,
    "Height": 17,
    "AlternativeText": "sample string 18",
    "FolderId": "e3cc6fcb-5991-4a6f-a7d5-26dbaf6e5bff",
    "ParentId": "ffdfea68-c859-4bea-872b-612ffbdf75c2",
    "Provider": "sample string 21",
    "Url": "sample string 22",
    "ThumbnailUrl": "sample string 23",
    "Thumbnails": {
      "Title": "sample string 1",
      "Url": "sample string 2",
      "Width": 3
    }
  },
  {
    "LastModified": "2024-12-20T18:57:05.5456891Z",
    "PublicationDate": "2024-12-20T18:57:05.5456891Z",
    "Title": "sample string 3",
    "Description": "sample string 4",
    "DateCreated": "2024-12-20T18:57:05.5456891Z",
    "IncludeInSitemap": true,
    "Ordinal": 7.1,
    "UrlName": "sample string 8",
    "Author": "sample string 9",
    "Extension": "sample string 10",
    "MimeType": "sample string 11",
    "TotalSize": 12,
    "LongTextCaption": "sample string 13",
    "Category": "9ddc6b52-0fed-43a5-85c8-e3d2ff31aca7",
    "Tags": "3954d7e9-d538-4556-92a1-2747446f3dd4",
    "Width": 16,
    "Height": 17,
    "AlternativeText": "sample string 18",
    "FolderId": "e3cc6fcb-5991-4a6f-a7d5-26dbaf6e5bff",
    "ParentId": "ffdfea68-c859-4bea-872b-612ffbdf75c2",
    "Provider": "sample string 21",
    "Url": "sample string 22",
    "ThumbnailUrl": "sample string 23",
    "Thumbnails": {
      "Title": "sample string 1",
      "Url": "sample string 2",
      "Width": 3
    }
  }
]

Get OpenGraphImage by relatedKey

Returns a related item of type OpenGraphImage from newsitems item.

Copy


                                        GET /api/news/newsitems({key})/OpenGraphImage({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
PublicationDate		System.DateTimeOffset	Read only: False
Title		System.String	Read only: False
Description		System.String	Read only: False
DateCreated		System.DateTimeOffset	Read only: True
IncludeInSitemap		System.Boolean	Read only: False
Ordinal		System.Single	Read only: False
UrlName		System.String	Read only: False
Author		System.String	Read only: False
Extension		System.String	Read only: True
MimeType		System.String	Read only: True
TotalSize		System.Int64	Read only: True
LongTextCaption		System.String	Read only: False
Category		System.Guid	Read only: False
Tags		System.Guid	Read only: False
Width		System.Int32	Read only: True
Height		System.Int32	Read only: True
AlternativeText		System.String	Read only: False
FolderId		System.Guid	Read only: False
ParentId		System.Guid	Read only: False
Provider		System.String	Read only: True
Url		System.String	Read only: True
ThumbnailUrl		System.String	Read only: True
Thumbnails		Telerik.Sitefinity.Modules.Libraries.Web.Services.Extensibility.ThumbnailModel	Read only: True

Resource Format

Response Formats

Copy


                                                                    application/json
                                                                    {
  "LastModified": "2024-12-20T18:57:05.5456891Z",
  "PublicationDate": "2024-12-20T18:57:05.5456891Z",
  "Title": "sample string 3",
  "Description": "sample string 4",
  "DateCreated": "2024-12-20T18:57:05.5456891Z",
  "IncludeInSitemap": true,
  "Ordinal": 7.1,
  "UrlName": "sample string 8",
  "Author": "sample string 9",
  "Extension": "sample string 10",
  "MimeType": "sample string 11",
  "TotalSize": 12,
  "LongTextCaption": "sample string 13",
  "Category": "55e39674-29f8-4779-be34-77a2cb2ee8d5",
  "Tags": "5a6c2f23-d67a-4936-8e3a-3f5bf3a159a1",
  "Width": 16,
  "Height": 17,
  "AlternativeText": "sample string 18",
  "FolderId": "1fb9e8e4-09c0-4b4b-8184-5fec9afa7f29",
  "ParentId": "61f550c9-e7a1-49b2-8d16-2a36cc6926d1",
  "Provider": "sample string 21",
  "Url": "sample string 22",
  "ThumbnailUrl": "sample string 23",
  "Thumbnails": {
    "Title": "sample string 1",
    "Url": "sample string 2",
    "Width": 3
  }
}

Post OpenGraphImage

Add OpenGraphImage relation to newsitems item.

Copy


                                        POST /api/news/newsitems({key})/OpenGraphImage/$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 OpenGraphImage

Delete set of related items of type OpenGraphImage from newsitems item.

Copy


                                        DELETE /api/news/newsitems({key})/OpenGraphImage/$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 OpenGraphImage by relatedKey

Delete relation of type OpenGraphImage from newsitems item.

Copy


                                        DELETE /api/news/newsitems({key})/OpenGraphImage({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.