RESTful API
News
News Alerts Funding Liquor Off-road vehicle map

Images

Get images

Returns a set of data items of type images.

Copy GET /api/news/images
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

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": "3ce17a75-6736-4b74-bd7f-76ff220f1ffd",
    "Tags": "a9022526-5503-4b20-b890-122370bd479a",
    "Width": 16,
    "Height": 17,
    "AlternativeText": "sample string 18",
    "FolderId": "6e5a2737-130c-4d26-ab92-28878e7cf7f9",
    "ParentId": "58e8034e-e3ef-46a5-8da9-d8557b880b30",
    "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": "3ce17a75-6736-4b74-bd7f-76ff220f1ffd",
    "Tags": "a9022526-5503-4b20-b890-122370bd479a",
    "Width": 16,
    "Height": 17,
    "AlternativeText": "sample string 18",
    "FolderId": "6e5a2737-130c-4d26-ab92-28878e7cf7f9",
    "ParentId": "58e8034e-e3ef-46a5-8da9-d8557b880b30",
    "Provider": "sample string 21",
    "Url": "sample string 22",
    "ThumbnailUrl": "sample string 23",
    "Thumbnails": {
      "Title": "sample string 1",
      "Url": "sample string 2",
      "Width": 3
    }
  }
]

Get images by key

Gets images item by id.

Copy GET /api/news/images({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

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": "425c7864-c678-4634-974e-7173dad538fe",
  "Tags": "b252fd96-ba94-46c8-81fd-2fc1a1a89440",
  "Width": 16,
  "Height": 17,
  "AlternativeText": "sample string 18",
  "FolderId": "48d66897-f68f-4f17-aeec-c315508310e5",
  "ParentId": "9582d172-a61e-460d-a108-489086e69de8",
  "Provider": "sample string 21",
  "Url": "sample string 22",
  "ThumbnailUrl": "sample string 23",
  "Thumbnails": {
    "Title": "sample string 1",
    "Url": "sample string 2",
    "Width": 3
  }
}

Get property

Gets Id property from images item.

Copy GET /api/news/images({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": "aa5fba8d-a507-4b0b-85b8-bda9523c4be8"
}

Post images

Creates a images item.

Copy POST /api/news/images
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

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

Request Formats
Copy
application/json
{
  "PublicationDate": "2024-12-20T18:57:05.5456891Z",
  "Title": "sample string 2",
  "Description": "sample string 3",
  "IncludeInSitemap": true,
  "Ordinal": 5.1,
  "UrlName": "sample string 6",
  "Author": "sample string 7",
  "LongTextCaption": "sample string 8",
  "Category": "ccd910fc-7069-483d-a683-89f79ec1ab54",
  "Tags": "a7d42736-7ec0-4fc7-bcb4-4d79ac448d11",
  "AlternativeText": "sample string 11",
  "FolderId": "c67a4669-78c8-4921-b277-29a6895d583c",
  "ParentId": "03796a3e-8add-4dbf-a68c-e1cfa163c187"
}
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

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": "cc64ccb6-cc2c-41e6-ad59-9440a8e929d1",
  "Tags": "b4039266-b6ef-475e-bb15-89aab7b386af",
  "Width": 16,
  "Height": 17,
  "AlternativeText": "sample string 18",
  "FolderId": "8bf75c45-1dc6-4f17-9027-d898b5d441e6",
  "ParentId": "d670cd77-21de-46be-a8fe-d5bb0431de4f",
  "Provider": "sample string 21",
  "Url": "sample string 22",
  "ThumbnailUrl": "sample string 23",
  "Thumbnails": {
    "Title": "sample string 1",
    "Url": "sample string 2",
    "Width": 3
  }
}

Patch images by key

Partial update for images item.

Copy PATCH /api/news/images({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

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

Request Formats
Copy
application/json
{
  "PublicationDate": "2024-12-20T18:57:05.5456891Z",
  "Title": "sample string 2",
  "Description": "sample string 3",
  "IncludeInSitemap": true,
  "Ordinal": 5.1,
  "UrlName": "sample string 6",
  "Author": "sample string 7",
  "LongTextCaption": "sample string 8",
  "Category": "e2fea56d-4666-4eb6-b67a-ea5f2b4b4966",
  "Tags": "163d5bd4-d5e4-410e-876b-e64dd437af4d",
  "AlternativeText": "sample string 11",
  "FolderId": "32dd2dd6-8830-4ee4-bf40-cf06ac7a693e",
  "ParentId": "a2bedb02-cab2-4b14-a0cf-45ab9ff4c78c"
}
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 images by key

Full update for images item.

Copy PUT /api/news/images({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

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

Request Formats
Copy
application/json
{
  "PublicationDate": "2024-12-20T18:57:05.5456891Z",
  "Title": "sample string 2",
  "Description": "sample string 3",
  "IncludeInSitemap": true,
  "Ordinal": 5.1,
  "UrlName": "sample string 6",
  "Author": "sample string 7",
  "LongTextCaption": "sample string 8",
  "Category": "d5bccff1-e0c5-4bce-bb22-281cc0ec24cd",
  "Tags": "1ea9f02d-5e7c-4cf4-9fc4-6a94c7a3cfe7",
  "AlternativeText": "sample string 11",
  "FolderId": "208502e4-44f8-4579-8ead-0ef4370da90a",
  "ParentId": "c0378ba4-c5d3-489a-9514-06b1a039a419"
}
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 images by key

Deletes a images item by Id.

Copy DELETE /api/news/images({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 images item.

Copy GET /api/news/images({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

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

MaxSize

System.Int64

Read only: False

MaxItemSize

System.Int64

Read only: False

BlobStorageProvider

System.String

Read only: False

OutputCacheProfile

System.String

Read only: False

ClientCacheProfile

System.String

Read only: False

CoverId

System.Guid

Read only: False

ThumbnailProfiles

System.String

Read only: False

ResizeOnUpload

System.Boolean

Read only: False

NewSize

System.String

Read only: False

ParentId

System.Guid

Read only: False

Provider

System.String

Read only: True

ChildrenCount

System.Int32

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,
    "UrlName": "sample string 7",
    "MaxSize": 8,
    "MaxItemSize": 9,
    "BlobStorageProvider": "sample string 10",
    "OutputCacheProfile": "sample string 11",
    "ClientCacheProfile": "sample string 12",
    "CoverId": "c65c7ee6-05bc-467b-af1b-cecfa1bab3f1",
    "ThumbnailProfiles": "sample string 14",
    "ResizeOnUpload": true,
    "NewSize": "sample string 16",
    "ParentId": "df638f77-b182-4bd6-a7cf-52cbcb1ee8be",
    "Provider": "sample string 18",
    "ChildrenCount": 19
  },
  {
    "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,
    "UrlName": "sample string 7",
    "MaxSize": 8,
    "MaxItemSize": 9,
    "BlobStorageProvider": "sample string 10",
    "OutputCacheProfile": "sample string 11",
    "ClientCacheProfile": "sample string 12",
    "CoverId": "c65c7ee6-05bc-467b-af1b-cecfa1bab3f1",
    "ThumbnailProfiles": "sample string 14",
    "ResizeOnUpload": true,
    "NewSize": "sample string 16",
    "ParentId": "df638f77-b182-4bd6-a7cf-52cbcb1ee8be",
    "Provider": "sample string 18",
    "ChildrenCount": 19
  }
]

Get Parent by relatedKey

Returns a related item of type Parent from images item.

Copy GET /api/news/images({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

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

MaxSize

System.Int64

Read only: False

MaxItemSize

System.Int64

Read only: False

BlobStorageProvider

System.String

Read only: False

OutputCacheProfile

System.String

Read only: False

ClientCacheProfile

System.String

Read only: False

CoverId

System.Guid

Read only: False

ThumbnailProfiles

System.String

Read only: False

ResizeOnUpload

System.Boolean

Read only: False

NewSize

System.String

Read only: False

ParentId

System.Guid

Read only: False

Provider

System.String

Read only: True

ChildrenCount

System.Int32

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,
  "UrlName": "sample string 7",
  "MaxSize": 8,
  "MaxItemSize": 9,
  "BlobStorageProvider": "sample string 10",
  "OutputCacheProfile": "sample string 11",
  "ClientCacheProfile": "sample string 12",
  "CoverId": "f9112fd6-f649-4f92-b1cf-54b8c07752dc",
  "ThumbnailProfiles": "sample string 14",
  "ResizeOnUpload": true,
  "NewSize": "sample string 16",
  "ParentId": "b3095457-8f62-4dfb-b740-497be01b1ac8",
  "Provider": "sample string 18",
  "ChildrenCount": 19
}

Post Parent

Add Parent relation to images item.

Copy POST /api/news/images({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 images item.

Copy DELETE /api/news/images({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 images item.

Copy DELETE /api/news/images({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.