RESTful API

Libraries

Get albums

Returns a set of data items of type albums.

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

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-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": "d0006cfc-62a9-48ba-82e4-ed7ad3c8a6fe",
    "ThumbnailProfiles": "sample string 14",
    "ResizeOnUpload": true,
    "NewSize": "sample string 16",
    "ParentId": "9aab9bb6-b2fd-446f-bf16-a6e7031404e0",
    "Provider": "sample string 18",
    "ChildrenCount": 19
  },
  {
    "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": "d0006cfc-62a9-48ba-82e4-ed7ad3c8a6fe",
    "ThumbnailProfiles": "sample string 14",
    "ResizeOnUpload": true,
    "NewSize": "sample string 16",
    "ParentId": "9aab9bb6-b2fd-446f-bf16-a6e7031404e0",
    "Provider": "sample string 18",
    "ChildrenCount": 19
  }
]

Get albums by key

Gets albums item by id.

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

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-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": "0d66f406-24c2-4f3d-a5bb-7852487c3775",
  "ThumbnailProfiles": "sample string 14",
  "ResizeOnUpload": true,
  "NewSize": "sample string 16",
  "ParentId": "c6d89f38-13a1-4fcf-b77e-1f4275707af1",
  "Provider": "sample string 18",
  "ChildrenCount": 19
}

Get property

Gets Id property from albums item.

Copy GET /api/news/albums({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": "de2ff96f-105f-4726-800b-f6508654293b"
}

Post albums

Creates a albums item.

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

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

Request Formats
Copy
application/json
{
  "PublicationDate": "2024-04-29T15:19:08.7304726Z",
  "Title": "sample string 2",
  "Description": "sample string 3",
  "IncludeInSitemap": true,
  "UrlName": "sample string 5",
  "MaxSize": 6,
  "MaxItemSize": 7,
  "BlobStorageProvider": "sample string 8",
  "OutputCacheProfile": "sample string 9",
  "ClientCacheProfile": "sample string 10",
  "CoverId": "458a518b-b715-4c93-80da-5126a2e09cd6",
  "ThumbnailProfiles": "sample string 12",
  "ResizeOnUpload": true,
  "NewSize": "sample string 14",
  "ParentId": "04a994c9-8278-4ea9-88de-16c384b6f5c9"
}
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

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-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": "7f2135a1-f16f-403c-aa9c-f184dcdcaca9",
  "ThumbnailProfiles": "sample string 14",
  "ResizeOnUpload": true,
  "NewSize": "sample string 16",
  "ParentId": "616d6b48-5f9f-436a-8976-3654559b3fe5",
  "Provider": "sample string 18",
  "ChildrenCount": 19
}

Patch albums by key

Partial update for albums item.

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

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

Request Formats
Copy
application/json
{
  "PublicationDate": "2024-04-29T15:19:08.7304726Z",
  "Title": "sample string 2",
  "Description": "sample string 3",
  "IncludeInSitemap": true,
  "UrlName": "sample string 5",
  "MaxSize": 6,
  "MaxItemSize": 7,
  "BlobStorageProvider": "sample string 8",
  "OutputCacheProfile": "sample string 9",
  "ClientCacheProfile": "sample string 10",
  "CoverId": "470bd5de-8d38-4de9-96d8-76869f102357",
  "ThumbnailProfiles": "sample string 12",
  "ResizeOnUpload": true,
  "NewSize": "sample string 14",
  "ParentId": "485270a1-0889-4c45-bcc6-61df2baf282b"
}
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 albums by key

Full update for albums item.

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

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

Request Formats
Copy
application/json
{
  "PublicationDate": "2024-04-29T15:19:08.7304726Z",
  "Title": "sample string 2",
  "Description": "sample string 3",
  "IncludeInSitemap": true,
  "UrlName": "sample string 5",
  "MaxSize": 6,
  "MaxItemSize": 7,
  "BlobStorageProvider": "sample string 8",
  "OutputCacheProfile": "sample string 9",
  "ClientCacheProfile": "sample string 10",
  "CoverId": "39ec5e06-db7c-4fcd-a42b-ec286fd1ec12",
  "ThumbnailProfiles": "sample string 12",
  "ResizeOnUpload": true,
  "NewSize": "sample string 14",
  "ParentId": "ec317dce-5445-4b6a-8566-7265756e4c0d"
}
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 albums by key

Deletes a albums item by Id.

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