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

Forms

Get forms

Returns a set of data items of type forms.

Copy GET /api/default/forms
Request Informaion

URI Parameters

None

Body Parameters

None

Request Formats

None.

Response Informaion

Resource Description

Method can return success code: OK - 200 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Name Description Type Additional Information
LastModified

System.DateTimeOffset

Read only: True
Selected by default: True

PublicationDate

System.DateTimeOffset

Read only: False
Selected by default: True

Title

System.String

Read only: False
Selected by default: True

Description

System.String

Read only: False
Selected by default: True

DateCreated

System.DateTimeOffset

Read only: True
Selected by default: True

IncludeInSitemap

System.Boolean

Read only: False
Selected by default: True

SystemSourceKey

System.String

Read only: False
Selected by default: True

Category

System.Guid

Read only: False
Selected by default: False

Tags

System.Guid

Read only: False
Selected by default: False

AllowComments

System.Boolean

Read only: False
Selected by default: True

Rules

System.String

Read only: False
Selected by default: True

SuccessMessage

System.String

Read only: False
Selected by default: True

Renderer

System.String

Read only: False
Selected by default: True

Name

System.String

Read only: False
Selected by default: True

Provider

System.String

Read only: True
Selected by default: True

Comments

Telerik.Sitefinity.Services.Comments.CommentContract

Read only: True
Selected by default: False

Resource Format

Response Formats
Copy
application/json
[
  {
    "LastModified": "2026-09-18T20:19:47.7241154Z",
    "PublicationDate": "2026-09-18T20:19:47.7241154Z",
    "Title": "sample string 3",
    "Description": "sample string 4",
    "DateCreated": "2026-09-18T20:19:47.7241154Z",
    "IncludeInSitemap": true,
    "SystemSourceKey": "sample string 7",
    "Category": "fdd87f16-d47d-4e72-b06d-face66d520d4",
    "Tags": "39b19a9b-4cd1-482e-a07d-382f7dfc3cc8",
    "AllowComments": true,
    "Rules": "sample string 11",
    "SuccessMessage": "sample string 12",
    "Renderer": "sample string 13",
    "Name": "sample string 14",
    "Provider": "sample string 15",
    "Comments": {
      "Name": "sample string 1",
      "Message": "sample string 2",
      "DateCreated": "2026-09-18T20:19:47.7241154+00:00",
      "ProfilePictureUrl": "sample string 4",
      "ProfilePictureThumbnailUrl": "sample string 5"
    }
  },
  {
    "LastModified": "2026-09-18T20:19:47.7241154Z",
    "PublicationDate": "2026-09-18T20:19:47.7241154Z",
    "Title": "sample string 3",
    "Description": "sample string 4",
    "DateCreated": "2026-09-18T20:19:47.7241154Z",
    "IncludeInSitemap": true,
    "SystemSourceKey": "sample string 7",
    "Category": "fdd87f16-d47d-4e72-b06d-face66d520d4",
    "Tags": "39b19a9b-4cd1-482e-a07d-382f7dfc3cc8",
    "AllowComments": true,
    "Rules": "sample string 11",
    "SuccessMessage": "sample string 12",
    "Renderer": "sample string 13",
    "Name": "sample string 14",
    "Provider": "sample string 15",
    "Comments": {
      "Name": "sample string 1",
      "Message": "sample string 2",
      "DateCreated": "2026-09-18T20:19:47.7241154+00:00",
      "ProfilePictureUrl": "sample string 4",
      "ProfilePictureThumbnailUrl": "sample string 5"
    }
  }
]

Get forms by key

Gets forms item by id.

Copy GET /api/default/forms({key})
Request Informaion

URI Parameters

Name Description Type Additional Information
key

System.Guid

Required

Body Parameters

None

Request Formats

None.

Response Informaion

Resource Description

Method can return success code: OK - 200 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Name Description Type Additional Information
LastModified

System.DateTimeOffset

Read only: True
Selected by default: True

PublicationDate

System.DateTimeOffset

Read only: False
Selected by default: True

Title

System.String

Read only: False
Selected by default: True

Description

System.String

Read only: False
Selected by default: True

DateCreated

System.DateTimeOffset

Read only: True
Selected by default: True

IncludeInSitemap

System.Boolean

Read only: False
Selected by default: True

SystemSourceKey

System.String

Read only: False
Selected by default: True

Category

System.Guid

Read only: False
Selected by default: False

Tags

System.Guid

Read only: False
Selected by default: False

AllowComments

System.Boolean

Read only: False
Selected by default: True

Rules

System.String

Read only: False
Selected by default: True

SuccessMessage

System.String

Read only: False
Selected by default: True

Renderer

System.String

Read only: False
Selected by default: True

Name

System.String

Read only: False
Selected by default: True

Provider

System.String

Read only: True
Selected by default: True

Comments

Telerik.Sitefinity.Services.Comments.CommentContract

Read only: True
Selected by default: False

Resource Format

Response Formats
Copy
application/json
{
  "LastModified": "2026-09-18T20:19:47.7241154Z",
  "PublicationDate": "2026-09-18T20:19:47.7241154Z",
  "Title": "sample string 3",
  "Description": "sample string 4",
  "DateCreated": "2026-09-18T20:19:47.7241154Z",
  "IncludeInSitemap": true,
  "SystemSourceKey": "sample string 7",
  "Category": "bb722881-ee3f-4a85-80c2-bce7ee16fb8e",
  "Tags": "6ee95bff-fcf7-42b9-a746-5955555762b2",
  "AllowComments": true,
  "Rules": "sample string 11",
  "SuccessMessage": "sample string 12",
  "Renderer": "sample string 13",
  "Name": "sample string 14",
  "Provider": "sample string 15",
  "Comments": {
    "Name": "sample string 1",
    "Message": "sample string 2",
    "DateCreated": "2026-09-18T20:19:47.7241154+00:00",
    "ProfilePictureUrl": "sample string 4",
    "ProfilePictureThumbnailUrl": "sample string 5"
  }
}

Get property

Gets Id property from forms item.

Copy GET /api/default/forms({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": "5a4c28e6-50c4-4adb-80d2-484fda10a1a2"
}

Post forms

Creates a forms item.

Copy POST /api/default/forms
Request Informaion

URI Parameters

None

Body Parameters

Name Description Type Additional Information
LastModified

System.DateTimeOffset

Read only: True
Selected by default: True

PublicationDate

System.DateTimeOffset

Read only: False
Selected by default: True

Title

System.String

Read only: False
Selected by default: True

Description

System.String

Read only: False
Selected by default: True

DateCreated

System.DateTimeOffset

Read only: True
Selected by default: True

IncludeInSitemap

System.Boolean

Read only: False
Selected by default: True

SystemSourceKey

System.String

Read only: False
Selected by default: True

Category

System.Guid

Read only: False
Selected by default: False

Tags

System.Guid

Read only: False
Selected by default: False

AllowComments

System.Boolean

Read only: False
Selected by default: True

Rules

System.String

Read only: False
Selected by default: True

SuccessMessage

System.String

Read only: False
Selected by default: True

Renderer

System.String

Read only: False
Selected by default: True

Name

System.String

Read only: False
Selected by default: True

Provider

System.String

Read only: True
Selected by default: True

Comments

Telerik.Sitefinity.Services.Comments.CommentContract

Read only: True
Selected by default: False

Request Formats
Copy
application/json
{
  "PublicationDate": "2026-09-18T20:19:47.7241154Z",
  "Title": "sample string 2",
  "Description": "sample string 3",
  "IncludeInSitemap": true,
  "SystemSourceKey": "sample string 5",
  "Category": "88335544-d66d-4854-8c81-2c751250ef53",
  "Tags": "9ae6b1ba-cd52-46bc-84c7-b74527a8e99e",
  "AllowComments": true,
  "Rules": "sample string 9",
  "SuccessMessage": "sample string 10",
  "Renderer": "sample string 11",
  "Name": "sample string 12"
}
Response Informaion

Resource Description

Method can return success code: Created - 201 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Name Description Type Additional Information
LastModified

System.DateTimeOffset

Read only: True
Selected by default: True

PublicationDate

System.DateTimeOffset

Read only: False
Selected by default: True

Title

System.String

Read only: False
Selected by default: True

Description

System.String

Read only: False
Selected by default: True

DateCreated

System.DateTimeOffset

Read only: True
Selected by default: True

IncludeInSitemap

System.Boolean

Read only: False
Selected by default: True

SystemSourceKey

System.String

Read only: False
Selected by default: True

Category

System.Guid

Read only: False
Selected by default: False

Tags

System.Guid

Read only: False
Selected by default: False

AllowComments

System.Boolean

Read only: False
Selected by default: True

Rules

System.String

Read only: False
Selected by default: True

SuccessMessage

System.String

Read only: False
Selected by default: True

Renderer

System.String

Read only: False
Selected by default: True

Name

System.String

Read only: False
Selected by default: True

Provider

System.String

Read only: True
Selected by default: True

Comments

Telerik.Sitefinity.Services.Comments.CommentContract

Read only: True
Selected by default: False

Resource Format

Response Formats
Copy
application/json
{
  "LastModified": "2026-09-18T20:19:47.7241154Z",
  "PublicationDate": "2026-09-18T20:19:47.7241154Z",
  "Title": "sample string 3",
  "Description": "sample string 4",
  "DateCreated": "2026-09-18T20:19:47.7241154Z",
  "IncludeInSitemap": true,
  "SystemSourceKey": "sample string 7",
  "Category": "ddccdfaa-a084-4a7d-b5cd-1007ccae6159",
  "Tags": "67a83020-94e7-4009-8c1b-6c627e09dd90",
  "AllowComments": true,
  "Rules": "sample string 11",
  "SuccessMessage": "sample string 12",
  "Renderer": "sample string 13",
  "Name": "sample string 14",
  "Provider": "sample string 15",
  "Comments": {
    "Name": "sample string 1",
    "Message": "sample string 2",
    "DateCreated": "2026-09-18T20:19:47.7241154+00:00",
    "ProfilePictureUrl": "sample string 4",
    "ProfilePictureThumbnailUrl": "sample string 5"
  }
}

Patch forms by key

Partial update for forms item.

Copy PATCH /api/default/forms({key})
Request Informaion

URI Parameters

Name Description Type Additional Information
key

System.Guid

Required

Body Parameters

Name Description Type Additional Information
LastModified

System.DateTimeOffset

Read only: True
Selected by default: True

PublicationDate

System.DateTimeOffset

Read only: False
Selected by default: True

Title

System.String

Read only: False
Selected by default: True

Description

System.String

Read only: False
Selected by default: True

DateCreated

System.DateTimeOffset

Read only: True
Selected by default: True

IncludeInSitemap

System.Boolean

Read only: False
Selected by default: True

SystemSourceKey

System.String

Read only: False
Selected by default: True

Category

System.Guid

Read only: False
Selected by default: False

Tags

System.Guid

Read only: False
Selected by default: False

AllowComments

System.Boolean

Read only: False
Selected by default: True

Rules

System.String

Read only: False
Selected by default: True

SuccessMessage

System.String

Read only: False
Selected by default: True

Renderer

System.String

Read only: False
Selected by default: True

Name

System.String

Read only: False
Selected by default: True

Provider

System.String

Read only: True
Selected by default: True

Comments

Telerik.Sitefinity.Services.Comments.CommentContract

Read only: True
Selected by default: False

Request Formats
Copy
application/json
{
  "PublicationDate": "2026-09-18T20:19:47.7241154Z",
  "Title": "sample string 2",
  "Description": "sample string 3",
  "IncludeInSitemap": true,
  "SystemSourceKey": "sample string 5",
  "Category": "2b3b38ae-2c92-4c49-bf48-909f24839461",
  "Tags": "8d3ead8f-3669-4fc4-b90b-e68256e0e15d",
  "AllowComments": true,
  "Rules": "sample string 9",
  "SuccessMessage": "sample string 10",
  "Renderer": "sample string 11",
  "Name": "sample string 12"
}
Response Informaion

Resource Description

Method can return success code: NoContent - 204 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Resource Format

Response Formats

None.

Put forms by key

Full update for forms item.

Copy PUT /api/default/forms({key})
Request Informaion

URI Parameters

Name Description Type Additional Information
key

System.Guid

Required

Body Parameters

Name Description Type Additional Information
LastModified

System.DateTimeOffset

Read only: True
Selected by default: True

PublicationDate

System.DateTimeOffset

Read only: False
Selected by default: True

Title

System.String

Read only: False
Selected by default: True

Description

System.String

Read only: False
Selected by default: True

DateCreated

System.DateTimeOffset

Read only: True
Selected by default: True

IncludeInSitemap

System.Boolean

Read only: False
Selected by default: True

SystemSourceKey

System.String

Read only: False
Selected by default: True

Category

System.Guid

Read only: False
Selected by default: False

Tags

System.Guid

Read only: False
Selected by default: False

AllowComments

System.Boolean

Read only: False
Selected by default: True

Rules

System.String

Read only: False
Selected by default: True

SuccessMessage

System.String

Read only: False
Selected by default: True

Renderer

System.String

Read only: False
Selected by default: True

Name

System.String

Read only: False
Selected by default: True

Provider

System.String

Read only: True
Selected by default: True

Comments

Telerik.Sitefinity.Services.Comments.CommentContract

Read only: True
Selected by default: False

Request Formats
Copy
application/json
{
  "PublicationDate": "2026-09-18T20:19:47.7241154Z",
  "Title": "sample string 2",
  "Description": "sample string 3",
  "IncludeInSitemap": true,
  "SystemSourceKey": "sample string 5",
  "Category": "73dea4bd-bbc2-4f48-b840-b196f8bb2a27",
  "Tags": "6ffc1e17-5d5d-4c3b-9311-90ff954a5cfc",
  "AllowComments": true,
  "Rules": "sample string 9",
  "SuccessMessage": "sample string 10",
  "Renderer": "sample string 11",
  "Name": "sample string 12"
}
Response Informaion

Resource Description

Method can return success code: NoContent - 204 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Resource Format

Response Formats

None.

Delete forms by key

Deletes a forms item by Id.

Copy DELETE /api/default/forms({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.