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

Documents

Get documents

Returns a set of data items of type documents.

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

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-04-29T15:19:08.7304726Z",
    "PublicationDate": "2024-04-29T15:19:08.7304726Z",
    "Title": "sample string 3",
    "Description": "sample string 4",
    "DateCreated": "2024-04-29T15:19:08.7304726Z",
    "IncludeInSitemap": true,
    "Ordinal": 7.1,
    "UrlName": "sample string 8",
    "Author": "sample string 9",
    "Extension": "sample string 10",
    "MimeType": "sample string 11",
    "TotalSize": 12,
    "Tags": "09ec0272-0f1b-4ce5-8089-db61f4a4a0ea",
    "Category": "fda688d0-99ae-4726-a622-8a71902698ba",
    "Parts": "sample string 15",
    "FolderId": "9ebbe49e-6da8-4dd5-b1d9-2c35bd732ea7",
    "ParentId": "ad608c41-76ee-4ce3-9b9b-2aff9ebbe4d9",
    "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-04-29T15:19:08.7304726Z",
    "PublicationDate": "2024-04-29T15:19:08.7304726Z",
    "Title": "sample string 3",
    "Description": "sample string 4",
    "DateCreated": "2024-04-29T15:19:08.7304726Z",
    "IncludeInSitemap": true,
    "Ordinal": 7.1,
    "UrlName": "sample string 8",
    "Author": "sample string 9",
    "Extension": "sample string 10",
    "MimeType": "sample string 11",
    "TotalSize": 12,
    "Tags": "09ec0272-0f1b-4ce5-8089-db61f4a4a0ea",
    "Category": "fda688d0-99ae-4726-a622-8a71902698ba",
    "Parts": "sample string 15",
    "FolderId": "9ebbe49e-6da8-4dd5-b1d9-2c35bd732ea7",
    "ParentId": "ad608c41-76ee-4ce3-9b9b-2aff9ebbe4d9",
    "Provider": "sample string 18",
    "Url": "sample string 19",
    "ThumbnailUrl": "sample string 20",
    "Thumbnails": {
      "Title": "sample string 1",
      "Url": "sample string 2",
      "Width": 3
    }
  }
]

Get documents by key

Gets documents item by id.

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

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-04-29T15:19:08.7304726Z",
  "PublicationDate": "2024-04-29T15:19:08.7304726Z",
  "Title": "sample string 3",
  "Description": "sample string 4",
  "DateCreated": "2024-04-29T15:19:08.7304726Z",
  "IncludeInSitemap": true,
  "Ordinal": 7.1,
  "UrlName": "sample string 8",
  "Author": "sample string 9",
  "Extension": "sample string 10",
  "MimeType": "sample string 11",
  "TotalSize": 12,
  "Tags": "b7c862ab-cc45-44db-bf4d-cf23c1b2ec94",
  "Category": "ebed28de-0a75-4587-a0ea-8d9e62fd6312",
  "Parts": "sample string 15",
  "FolderId": "7d12d461-567b-4475-b41b-64052e47b8ad",
  "ParentId": "70fb58b3-acff-41c1-84fa-03f2028f5cf6",
  "Provider": "sample string 18",
  "Url": "sample string 19",
  "ThumbnailUrl": "sample string 20",
  "Thumbnails": {
    "Title": "sample string 1",
    "Url": "sample string 2",
    "Width": 3
  }
}

Get property

Gets Id property from documents item.

Copy GET /api/news/documents({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": "79324248-d534-4c94-8742-0374f5e500e6"
}

Post documents

Creates a documents item.

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

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

Request Formats
Copy
application/json
{
  "PublicationDate": "2024-04-29T15:19:08.7304726Z",
  "Title": "sample string 2",
  "Description": "sample string 3",
  "IncludeInSitemap": true,
  "Ordinal": 5.1,
  "UrlName": "sample string 6",
  "Author": "sample string 7",
  "Tags": "c87a64f4-7ad5-4850-b25e-ae45414d6d29",
  "Category": "7045bc50-96f8-4add-a781-c00b28555c43",
  "Parts": "sample string 10",
  "FolderId": "6ca1ed85-b0c6-4a15-9e03-d389ad88140d",
  "ParentId": "b74262b9-8b9d-4cfe-8724-16602566ccb3"
}
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

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-04-29T15:19:08.7304726Z",
  "PublicationDate": "2024-04-29T15:19:08.7304726Z",
  "Title": "sample string 3",
  "Description": "sample string 4",
  "DateCreated": "2024-04-29T15:19:08.7304726Z",
  "IncludeInSitemap": true,
  "Ordinal": 7.1,
  "UrlName": "sample string 8",
  "Author": "sample string 9",
  "Extension": "sample string 10",
  "MimeType": "sample string 11",
  "TotalSize": 12,
  "Tags": "2855db46-fbdd-46d0-881e-11b57eea9e80",
  "Category": "0f43c217-c714-443d-8cf0-dcbbfeec5666",
  "Parts": "sample string 15",
  "FolderId": "c1792604-195a-416c-a9d5-d49f6a7a62a7",
  "ParentId": "a8ec26ec-e0f4-4b30-a444-e7e01589b2ce",
  "Provider": "sample string 18",
  "Url": "sample string 19",
  "ThumbnailUrl": "sample string 20",
  "Thumbnails": {
    "Title": "sample string 1",
    "Url": "sample string 2",
    "Width": 3
  }
}

Patch documents by key

Partial update for documents item.

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

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

Request Formats
Copy
application/json
{
  "PublicationDate": "2024-04-29T15:19:08.7304726Z",
  "Title": "sample string 2",
  "Description": "sample string 3",
  "IncludeInSitemap": true,
  "Ordinal": 5.1,
  "UrlName": "sample string 6",
  "Author": "sample string 7",
  "Tags": "abf0c6dd-0f75-4daf-a8d7-4b9592cf4704",
  "Category": "bc0fd692-1f3e-4920-bcba-71a4d9ccb26f",
  "Parts": "sample string 10",
  "FolderId": "3fea196f-211e-4f38-8bba-af79741335b2",
  "ParentId": "f16f213e-60a5-4c19-98e2-8d195db2b58e"
}
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 documents by key

Full update for documents item.

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

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

Request Formats
Copy
application/json
{
  "PublicationDate": "2024-04-29T15:19:08.7304726Z",
  "Title": "sample string 2",
  "Description": "sample string 3",
  "IncludeInSitemap": true,
  "Ordinal": 5.1,
  "UrlName": "sample string 6",
  "Author": "sample string 7",
  "Tags": "0c83eca1-4044-47f7-8709-744d7561037f",
  "Category": "2467b5b6-c94c-4fe2-a3fc-fd2a5f7aa450",
  "Parts": "sample string 10",
  "FolderId": "6bb41595-f655-4272-b47c-8817d5200ce6",
  "ParentId": "e78bb380-71b2-4ba6-9466-73887524449a"
}
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 documents by key

Deletes a documents item by Id.

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

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

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-04-29T15:19:08.7304726Z",
    "PublicationDate": "2024-04-29T15:19:08.7304726Z",
    "Title": "sample string 3",
    "Description": "sample string 4",
    "DateCreated": "2024-04-29T15:19:08.7304726Z",
    "IncludeInSitemap": true,
    "UrlName": "sample string 7",
    "MaxSize": 8,
    "MaxItemSize": 9,
    "BlobStorageProvider": "sample string 10",
    "OutputCacheProfile": "sample string 11",
    "ClientCacheProfile": "sample string 12",
    "CoverId": "89d19cbb-d4b4-4c5a-a32c-0dc222e4a05c",
    "ThumbnailProfiles": "sample string 14",
    "ParentId": "6c92ce45-289a-465a-afa5-65f55be8a334",
    "Provider": "sample string 16",
    "ChildrenCount": 17
  },
  {
    "LastModified": "2024-04-29T15:19:08.7304726Z",
    "PublicationDate": "2024-04-29T15:19:08.7304726Z",
    "Title": "sample string 3",
    "Description": "sample string 4",
    "DateCreated": "2024-04-29T15:19:08.7304726Z",
    "IncludeInSitemap": true,
    "UrlName": "sample string 7",
    "MaxSize": 8,
    "MaxItemSize": 9,
    "BlobStorageProvider": "sample string 10",
    "OutputCacheProfile": "sample string 11",
    "ClientCacheProfile": "sample string 12",
    "CoverId": "89d19cbb-d4b4-4c5a-a32c-0dc222e4a05c",
    "ThumbnailProfiles": "sample string 14",
    "ParentId": "6c92ce45-289a-465a-afa5-65f55be8a334",
    "Provider": "sample string 16",
    "ChildrenCount": 17
  }
]

Get Parent by relatedKey

Returns a related item of type Parent from documents item.

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

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-04-29T15:19:08.7304726Z",
  "PublicationDate": "2024-04-29T15:19:08.7304726Z",
  "Title": "sample string 3",
  "Description": "sample string 4",
  "DateCreated": "2024-04-29T15:19:08.7304726Z",
  "IncludeInSitemap": true,
  "UrlName": "sample string 7",
  "MaxSize": 8,
  "MaxItemSize": 9,
  "BlobStorageProvider": "sample string 10",
  "OutputCacheProfile": "sample string 11",
  "ClientCacheProfile": "sample string 12",
  "CoverId": "82bcb5e9-36ea-46f2-a1cf-21279b90078b",
  "ThumbnailProfiles": "sample string 14",
  "ParentId": "0d23d812-d088-41bd-b847-40b3adcc217a",
  "Provider": "sample string 16",
  "ChildrenCount": 17
}

Post Parent

Add Parent relation to documents item.

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

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

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