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

Hierarchical

Get hierarchy-taxa

Returns a set of data items of type hierarchy-taxa.

Copy GET /api/whoreference/hierarchy-taxa
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

Title

System.String

Read only: False
Selected by default: True

Description

System.String

Read only: False
Selected by default: True

Name

System.String

Read only: False
Selected by default: True

Synonyms

System.String

Read only: False
Selected by default: True

TaxonomyId

System.Guid

Read only: False
Selected by default: True

Ordinal

System.Single

Read only: False
Selected by default: True

UrlName

System.String

Read only: False
Selected by default: True

FullUrl

System.String

Read only: True
Selected by default: True

ParentId

System.Guid

Read only: False
Selected by default: True

Provider

System.String

Read only: True
Selected by default: True

AppliedTo

System.Int64

Read only: True
Selected by default: False

Comments

Telerik.Sitefinity.Services.Comments.CommentContract

Read only: True
Selected by default: False

Resource Format

Response Formats
Copy
application/json
[
  {
    "LastModified": "2026-07-20T11:13:49.6059987Z",
    "Title": "sample string 2",
    "Description": "sample string 3",
    "Name": "sample string 4",
    "Synonyms": "sample string 5",
    "TaxonomyId": "30906f34-ebe1-4469-9d4d-3a711cf2505f",
    "Ordinal": 7.1,
    "UrlName": "sample string 8",
    "FullUrl": "sample string 9",
    "ParentId": "4deebfc9-4891-4a25-bc5a-c7084d354098",
    "Provider": "sample string 11",
    "AppliedTo": 12,
    "Comments": {
      "Name": "sample string 1",
      "Message": "sample string 2",
      "DateCreated": "2026-07-20T11:13:49.6059987+00:00",
      "ProfilePictureUrl": "sample string 4",
      "ProfilePictureThumbnailUrl": "sample string 5"
    }
  },
  {
    "LastModified": "2026-07-20T11:13:49.6059987Z",
    "Title": "sample string 2",
    "Description": "sample string 3",
    "Name": "sample string 4",
    "Synonyms": "sample string 5",
    "TaxonomyId": "30906f34-ebe1-4469-9d4d-3a711cf2505f",
    "Ordinal": 7.1,
    "UrlName": "sample string 8",
    "FullUrl": "sample string 9",
    "ParentId": "4deebfc9-4891-4a25-bc5a-c7084d354098",
    "Provider": "sample string 11",
    "AppliedTo": 12,
    "Comments": {
      "Name": "sample string 1",
      "Message": "sample string 2",
      "DateCreated": "2026-07-20T11:13:49.6059987+00:00",
      "ProfilePictureUrl": "sample string 4",
      "ProfilePictureThumbnailUrl": "sample string 5"
    }
  }
]

Get hierarchy-taxa by key

Gets hierarchy-taxa item by id.

Copy GET /api/whoreference/hierarchy-taxa({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

Title

System.String

Read only: False
Selected by default: True

Description

System.String

Read only: False
Selected by default: True

Name

System.String

Read only: False
Selected by default: True

Synonyms

System.String

Read only: False
Selected by default: True

TaxonomyId

System.Guid

Read only: False
Selected by default: True

Ordinal

System.Single

Read only: False
Selected by default: True

UrlName

System.String

Read only: False
Selected by default: True

FullUrl

System.String

Read only: True
Selected by default: True

ParentId

System.Guid

Read only: False
Selected by default: True

Provider

System.String

Read only: True
Selected by default: True

AppliedTo

System.Int64

Read only: True
Selected by default: False

Comments

Telerik.Sitefinity.Services.Comments.CommentContract

Read only: True
Selected by default: False

Resource Format

Response Formats
Copy
application/json
{
  "LastModified": "2026-07-20T11:13:49.6059987Z",
  "Title": "sample string 2",
  "Description": "sample string 3",
  "Name": "sample string 4",
  "Synonyms": "sample string 5",
  "TaxonomyId": "a9b749b4-8cf7-4ed1-8d21-b5c2d3ca3d48",
  "Ordinal": 7.1,
  "UrlName": "sample string 8",
  "FullUrl": "sample string 9",
  "ParentId": "4c7731a2-a322-487a-abea-b1ee7abddb22",
  "Provider": "sample string 11",
  "AppliedTo": 12,
  "Comments": {
    "Name": "sample string 1",
    "Message": "sample string 2",
    "DateCreated": "2026-07-20T11:13:49.6059987+00:00",
    "ProfilePictureUrl": "sample string 4",
    "ProfilePictureThumbnailUrl": "sample string 5"
  }
}

Get property

Gets Id property from hierarchy-taxa item.

Copy GET /api/whoreference/hierarchy-taxa({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": "b62e6db9-8f99-4ecd-a795-3a0806c5a4fc"
}

Post hierarchy-taxa

Creates a hierarchy-taxa item.

Copy POST /api/whoreference/hierarchy-taxa
Request Informaion

URI Parameters

None

Body Parameters

Name Description Type Additional Information
LastModified

System.DateTimeOffset

Read only: True
Selected by default: True

Title

System.String

Read only: False
Selected by default: True

Description

System.String

Read only: False
Selected by default: True

Name

System.String

Read only: False
Selected by default: True

Synonyms

System.String

Read only: False
Selected by default: True

TaxonomyId

System.Guid

Read only: False
Selected by default: True

Ordinal

System.Single

Read only: False
Selected by default: True

UrlName

System.String

Read only: False
Selected by default: True

FullUrl

System.String

Read only: True
Selected by default: True

ParentId

System.Guid

Read only: False
Selected by default: True

Provider

System.String

Read only: True
Selected by default: True

AppliedTo

System.Int64

Read only: True
Selected by default: False

Comments

Telerik.Sitefinity.Services.Comments.CommentContract

Read only: True
Selected by default: False

Request Formats
Copy
application/json
{
  "Title": "sample string 1",
  "Description": "sample string 2",
  "Name": "sample string 3",
  "Synonyms": "sample string 4",
  "TaxonomyId": "40a7555c-af9c-452b-951d-c6da44f5b515",
  "Ordinal": 6.1,
  "UrlName": "sample string 7",
  "ParentId": "5b6c298a-7580-48fb-970d-8c2d0a513c56"
}
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

Title

System.String

Read only: False
Selected by default: True

Description

System.String

Read only: False
Selected by default: True

Name

System.String

Read only: False
Selected by default: True

Synonyms

System.String

Read only: False
Selected by default: True

TaxonomyId

System.Guid

Read only: False
Selected by default: True

Ordinal

System.Single

Read only: False
Selected by default: True

UrlName

System.String

Read only: False
Selected by default: True

FullUrl

System.String

Read only: True
Selected by default: True

ParentId

System.Guid

Read only: False
Selected by default: True

Provider

System.String

Read only: True
Selected by default: True

AppliedTo

System.Int64

Read only: True
Selected by default: False

Comments

Telerik.Sitefinity.Services.Comments.CommentContract

Read only: True
Selected by default: False

Resource Format

Response Formats
Copy
application/json
{
  "LastModified": "2026-07-20T11:13:49.6059987Z",
  "Title": "sample string 2",
  "Description": "sample string 3",
  "Name": "sample string 4",
  "Synonyms": "sample string 5",
  "TaxonomyId": "cdc37853-dcaf-4498-8f42-cf62a9e13ac8",
  "Ordinal": 7.1,
  "UrlName": "sample string 8",
  "FullUrl": "sample string 9",
  "ParentId": "6c09a07c-389f-4c56-9a99-66ab5ceefd9f",
  "Provider": "sample string 11",
  "AppliedTo": 12,
  "Comments": {
    "Name": "sample string 1",
    "Message": "sample string 2",
    "DateCreated": "2026-07-20T11:13:49.6059987+00:00",
    "ProfilePictureUrl": "sample string 4",
    "ProfilePictureThumbnailUrl": "sample string 5"
  }
}

Patch hierarchy-taxa by key

Partial update for hierarchy-taxa item.

Copy PATCH /api/whoreference/hierarchy-taxa({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

Title

System.String

Read only: False
Selected by default: True

Description

System.String

Read only: False
Selected by default: True

Name

System.String

Read only: False
Selected by default: True

Synonyms

System.String

Read only: False
Selected by default: True

TaxonomyId

System.Guid

Read only: False
Selected by default: True

Ordinal

System.Single

Read only: False
Selected by default: True

UrlName

System.String

Read only: False
Selected by default: True

FullUrl

System.String

Read only: True
Selected by default: True

ParentId

System.Guid

Read only: False
Selected by default: True

Provider

System.String

Read only: True
Selected by default: True

AppliedTo

System.Int64

Read only: True
Selected by default: False

Comments

Telerik.Sitefinity.Services.Comments.CommentContract

Read only: True
Selected by default: False

Request Formats
Copy
application/json
{
  "Title": "sample string 1",
  "Description": "sample string 2",
  "Name": "sample string 3",
  "Synonyms": "sample string 4",
  "TaxonomyId": "3da5b34c-e6f2-425a-92c5-6fdf4dd4c18f",
  "Ordinal": 6.1,
  "UrlName": "sample string 7",
  "ParentId": "e9bb1470-4865-4aa2-9570-c08bf453789e"
}
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 hierarchy-taxa by key

Full update for hierarchy-taxa item.

Copy PUT /api/whoreference/hierarchy-taxa({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

Title

System.String

Read only: False
Selected by default: True

Description

System.String

Read only: False
Selected by default: True

Name

System.String

Read only: False
Selected by default: True

Synonyms

System.String

Read only: False
Selected by default: True

TaxonomyId

System.Guid

Read only: False
Selected by default: True

Ordinal

System.Single

Read only: False
Selected by default: True

UrlName

System.String

Read only: False
Selected by default: True

FullUrl

System.String

Read only: True
Selected by default: True

ParentId

System.Guid

Read only: False
Selected by default: True

Provider

System.String

Read only: True
Selected by default: True

AppliedTo

System.Int64

Read only: True
Selected by default: False

Comments

Telerik.Sitefinity.Services.Comments.CommentContract

Read only: True
Selected by default: False

Request Formats
Copy
application/json
{
  "Title": "sample string 1",
  "Description": "sample string 2",
  "Name": "sample string 3",
  "Synonyms": "sample string 4",
  "TaxonomyId": "4a63bfe6-07c5-40d3-b39d-af48697eeacb",
  "Ordinal": 6.1,
  "UrlName": "sample string 7",
  "ParentId": "e88a185d-8787-4e36-8281-437ed528fd56"
}
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 hierarchy-taxa by key

Deletes a hierarchy-taxa item by Id.

Copy DELETE /api/whoreference/hierarchy-taxa({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.