Returns a set of data items of type documents.
GET /api/whoreference/documents
None
None
None.
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 | |
| SystemSourceKey | System.String | Read only: False | |
| Ordinal | System.Single | Read only: False | |
| UrlName | System.String | Read only: False | |
| ItemDefaultUrl | System.String | Read only: True | |
| Author | System.String | Read only: False | |
| Extension | System.String | Read only: True | |
| MimeType | System.String | Read only: True | |
| TotalSize | System.Int64 | Read only: True | |
| healthtopics | System.Guid | Read only: False | |
| targets | System.Guid | Read only: False | |
| regionscountries | System.Guid | Read only: False | |
| stakeholders | System.Guid | Read only: False | |
| targetaudiences | System.Guid | Read only: False | |
| Category | System.Guid | Read only: False | |
| Tags | System.Guid | Read only: False | |
| departmentaltargets | System.Guid | Read only: False | |
| events | System.Guid | Read only: False | |
| publishingoffices | 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 | |
| IsDamMedia | System.Boolean | Read only: True |
application/json
[
{
"LastModified": "2025-10-18T19:17:24.295992Z",
"PublicationDate": "2025-10-18T19:17:24.295992Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2025-10-18T19:17:24.295992Z",
"IncludeInSitemap": true,
"SystemSourceKey": "sample string 7",
"Ordinal": 8.1,
"UrlName": "sample string 9",
"ItemDefaultUrl": "sample string 10",
"Author": "sample string 11",
"Extension": "sample string 12",
"MimeType": "sample string 13",
"TotalSize": 14,
"healthtopics": "19970481-50eb-45e0-901d-dac5cd92f0fe",
"targets": "aedad3a7-ed69-461d-bd00-51e67f2b3d69",
"regionscountries": "5972ca27-3997-48ce-ba99-71b5def596e1",
"stakeholders": "6372d9b8-4edd-4184-b3c8-3c348c3564e2",
"targetaudiences": "f9f889a6-a980-4924-9191-b51c1713abe3",
"Category": "1205a979-3cf6-46a4-9e03-f692f884fc79",
"Tags": "57f857fd-9ed5-4845-97a5-9e1f0da9b022",
"departmentaltargets": "39203d7e-8b92-44e6-bd37-2c7dcc0a1811",
"events": "1425b658-68d6-4ec8-a627-a5e947c25412",
"publishingoffices": "6806f75d-9c3f-460e-b0f0-eb36c5854708",
"Parts": "sample string 25",
"FolderId": "85906cf4-e804-45ab-a957-51724e2a9de2",
"ParentId": "fb04c462-d209-41bb-8b26-5e86f6d2ea17",
"Provider": "sample string 28",
"Url": "sample string 29",
"ThumbnailUrl": "sample string 30",
"IsDamMedia": true
},
{
"LastModified": "2025-10-18T19:17:24.295992Z",
"PublicationDate": "2025-10-18T19:17:24.295992Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2025-10-18T19:17:24.295992Z",
"IncludeInSitemap": true,
"SystemSourceKey": "sample string 7",
"Ordinal": 8.1,
"UrlName": "sample string 9",
"ItemDefaultUrl": "sample string 10",
"Author": "sample string 11",
"Extension": "sample string 12",
"MimeType": "sample string 13",
"TotalSize": 14,
"healthtopics": "19970481-50eb-45e0-901d-dac5cd92f0fe",
"targets": "aedad3a7-ed69-461d-bd00-51e67f2b3d69",
"regionscountries": "5972ca27-3997-48ce-ba99-71b5def596e1",
"stakeholders": "6372d9b8-4edd-4184-b3c8-3c348c3564e2",
"targetaudiences": "f9f889a6-a980-4924-9191-b51c1713abe3",
"Category": "1205a979-3cf6-46a4-9e03-f692f884fc79",
"Tags": "57f857fd-9ed5-4845-97a5-9e1f0da9b022",
"departmentaltargets": "39203d7e-8b92-44e6-bd37-2c7dcc0a1811",
"events": "1425b658-68d6-4ec8-a627-a5e947c25412",
"publishingoffices": "6806f75d-9c3f-460e-b0f0-eb36c5854708",
"Parts": "sample string 25",
"FolderId": "85906cf4-e804-45ab-a957-51724e2a9de2",
"ParentId": "fb04c462-d209-41bb-8b26-5e86f6d2ea17",
"Provider": "sample string 28",
"Url": "sample string 29",
"ThumbnailUrl": "sample string 30",
"IsDamMedia": true
}
]Gets documents item by id.
GET /api/whoreference/documents({key})
| Name | Description | Type | Additional Information |
| key | System.Guid | Required |
None
None.
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 | |
| SystemSourceKey | System.String | Read only: False | |
| Ordinal | System.Single | Read only: False | |
| UrlName | System.String | Read only: False | |
| ItemDefaultUrl | System.String | Read only: True | |
| Author | System.String | Read only: False | |
| Extension | System.String | Read only: True | |
| MimeType | System.String | Read only: True | |
| TotalSize | System.Int64 | Read only: True | |
| healthtopics | System.Guid | Read only: False | |
| targets | System.Guid | Read only: False | |
| regionscountries | System.Guid | Read only: False | |
| stakeholders | System.Guid | Read only: False | |
| targetaudiences | System.Guid | Read only: False | |
| Category | System.Guid | Read only: False | |
| Tags | System.Guid | Read only: False | |
| departmentaltargets | System.Guid | Read only: False | |
| events | System.Guid | Read only: False | |
| publishingoffices | 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 | |
| IsDamMedia | System.Boolean | Read only: True |
application/json
{
"LastModified": "2025-10-18T19:17:24.295992Z",
"PublicationDate": "2025-10-18T19:17:24.295992Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2025-10-18T19:17:24.295992Z",
"IncludeInSitemap": true,
"SystemSourceKey": "sample string 7",
"Ordinal": 8.1,
"UrlName": "sample string 9",
"ItemDefaultUrl": "sample string 10",
"Author": "sample string 11",
"Extension": "sample string 12",
"MimeType": "sample string 13",
"TotalSize": 14,
"healthtopics": "52d621e6-febd-48b1-8abf-5544cb48b873",
"targets": "278c4f94-e07b-4770-94f9-809a7449769c",
"regionscountries": "8c719a74-1614-4acb-a9ea-81379558d416",
"stakeholders": "199ddd9e-288a-42f5-92d1-0da97897e479",
"targetaudiences": "5778ad5f-06e0-44a9-994d-548a31823d07",
"Category": "ffe4a09c-9460-4791-aa29-9d3677b39f9a",
"Tags": "e80ee545-8d45-4b37-9f4c-69ba1e00d6f2",
"departmentaltargets": "4c16c0df-dd3f-42cc-9906-16c5d0102678",
"events": "14122e46-056c-44ba-bcbe-5285ed392bf1",
"publishingoffices": "811664d1-1965-4b9f-8f0a-112d31189fe4",
"Parts": "sample string 25",
"FolderId": "fee30712-477e-4bcf-a3a8-53baebb652d5",
"ParentId": "17ca4448-4baa-4482-b18f-5424a565d54a",
"Provider": "sample string 28",
"Url": "sample string 29",
"ThumbnailUrl": "sample string 30",
"IsDamMedia": true
}Gets Id property from documents item.
GET /api/whoreference/documents({key})/property
| Name | Description | Type | Additional Information |
| key | System.Guid | Required | |
| property | System.String | Required |
None
None.
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 |
application/json
{
"Id": "dfd90005-c4aa-4115-b614-3ec9c71448fa"
}Creates a documents item.
POST /api/whoreference/documents
None
| 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 | |
| SystemSourceKey | System.String | Read only: False | |
| Ordinal | System.Single | Read only: False | |
| UrlName | System.String | Read only: False | |
| ItemDefaultUrl | System.String | Read only: True | |
| Author | System.String | Read only: False | |
| Extension | System.String | Read only: True | |
| MimeType | System.String | Read only: True | |
| TotalSize | System.Int64 | Read only: True | |
| healthtopics | System.Guid | Read only: False | |
| targets | System.Guid | Read only: False | |
| regionscountries | System.Guid | Read only: False | |
| stakeholders | System.Guid | Read only: False | |
| targetaudiences | System.Guid | Read only: False | |
| Category | System.Guid | Read only: False | |
| Tags | System.Guid | Read only: False | |
| departmentaltargets | System.Guid | Read only: False | |
| events | System.Guid | Read only: False | |
| publishingoffices | 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 | |
| IsDamMedia | System.Boolean | Read only: True |
application/json
{
"PublicationDate": "2025-10-18T19:17:24.295992Z",
"Title": "sample string 2",
"Description": "sample string 3",
"IncludeInSitemap": true,
"SystemSourceKey": "sample string 5",
"Ordinal": 6.1,
"UrlName": "sample string 7",
"Author": "sample string 8",
"healthtopics": "2dca3299-014b-4330-9c78-7d66023c7a04",
"targets": "7d3e0aca-c243-4b79-b075-7a2bda60b294",
"regionscountries": "5e1798f6-933f-4902-beac-f560be053219",
"stakeholders": "d5129aee-3ba8-4b3f-9deb-be9953cdfda6",
"targetaudiences": "fae533fd-1e4d-4626-a68b-a949015290cf",
"Category": "8b076734-b03f-47f6-a3c4-b346638ecda3",
"Tags": "1b36ab38-0c94-470a-bd33-ddb6231cf12b",
"departmentaltargets": "ae2bd2d3-f454-4180-9645-59db05ab84a9",
"events": "d1777432-97c8-4749-823d-677b9de017fe",
"publishingoffices": "b32543a2-2061-4014-a46c-cf272935b9ed",
"Parts": "sample string 19",
"FolderId": "c8eb34fc-c922-4cdb-92bb-2bbdff23260a",
"ParentId": "d71f723d-d293-4e0b-bfc2-4587fc6d27d1"
}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 | |
| SystemSourceKey | System.String | Read only: False | |
| Ordinal | System.Single | Read only: False | |
| UrlName | System.String | Read only: False | |
| ItemDefaultUrl | System.String | Read only: True | |
| Author | System.String | Read only: False | |
| Extension | System.String | Read only: True | |
| MimeType | System.String | Read only: True | |
| TotalSize | System.Int64 | Read only: True | |
| healthtopics | System.Guid | Read only: False | |
| targets | System.Guid | Read only: False | |
| regionscountries | System.Guid | Read only: False | |
| stakeholders | System.Guid | Read only: False | |
| targetaudiences | System.Guid | Read only: False | |
| Category | System.Guid | Read only: False | |
| Tags | System.Guid | Read only: False | |
| departmentaltargets | System.Guid | Read only: False | |
| events | System.Guid | Read only: False | |
| publishingoffices | 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 | |
| IsDamMedia | System.Boolean | Read only: True |
application/json
{
"LastModified": "2025-10-18T19:17:24.295992Z",
"PublicationDate": "2025-10-18T19:17:24.295992Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2025-10-18T19:17:24.295992Z",
"IncludeInSitemap": true,
"SystemSourceKey": "sample string 7",
"Ordinal": 8.1,
"UrlName": "sample string 9",
"ItemDefaultUrl": "sample string 10",
"Author": "sample string 11",
"Extension": "sample string 12",
"MimeType": "sample string 13",
"TotalSize": 14,
"healthtopics": "4a33d3f5-3405-4190-9492-426d41d47a9a",
"targets": "3c97bcfb-9d0d-4878-82f4-551d3921cc19",
"regionscountries": "33045981-3edc-45f9-bae6-2d636fe0c104",
"stakeholders": "0e665ae3-c3bf-41b1-a221-3d18d38d7a0d",
"targetaudiences": "87bd415b-03cb-466b-862f-b9db23d115d8",
"Category": "2ef09907-d5d7-4955-b04a-ae8f15db0914",
"Tags": "e41cb92f-60df-4817-9918-f7c0ec52cf6a",
"departmentaltargets": "1db3a9a9-1612-4ea0-a4d8-223aa85923bb",
"events": "4e46c4cd-f951-40e9-b718-bf4a21b4002b",
"publishingoffices": "d11c8919-911f-4ff3-9ec3-d43facab2d5e",
"Parts": "sample string 25",
"FolderId": "73ac1723-b2cd-42c9-aacb-2f7fb9f96ddd",
"ParentId": "18c0b721-716c-47d1-9bc3-68d74d088c97",
"Provider": "sample string 28",
"Url": "sample string 29",
"ThumbnailUrl": "sample string 30",
"IsDamMedia": true
}Partial update for documents item.
PATCH /api/whoreference/documents({key})
| Name | Description | Type | Additional Information |
| key | System.Guid | Required |
| 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 | |
| SystemSourceKey | System.String | Read only: False | |
| Ordinal | System.Single | Read only: False | |
| UrlName | System.String | Read only: False | |
| ItemDefaultUrl | System.String | Read only: True | |
| Author | System.String | Read only: False | |
| Extension | System.String | Read only: True | |
| MimeType | System.String | Read only: True | |
| TotalSize | System.Int64 | Read only: True | |
| healthtopics | System.Guid | Read only: False | |
| targets | System.Guid | Read only: False | |
| regionscountries | System.Guid | Read only: False | |
| stakeholders | System.Guid | Read only: False | |
| targetaudiences | System.Guid | Read only: False | |
| Category | System.Guid | Read only: False | |
| Tags | System.Guid | Read only: False | |
| departmentaltargets | System.Guid | Read only: False | |
| events | System.Guid | Read only: False | |
| publishingoffices | 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 | |
| IsDamMedia | System.Boolean | Read only: True |
application/json
{
"PublicationDate": "2025-10-18T19:17:24.295992Z",
"Title": "sample string 2",
"Description": "sample string 3",
"IncludeInSitemap": true,
"SystemSourceKey": "sample string 5",
"Ordinal": 6.1,
"UrlName": "sample string 7",
"Author": "sample string 8",
"healthtopics": "9df72768-13f7-4165-8791-31d3afd5256b",
"targets": "13f4042d-8f75-4985-9ac7-ca6f2016d33f",
"regionscountries": "ab351dba-995f-4c8d-a942-c890f6fa7cca",
"stakeholders": "dfd4f660-96ba-40c4-aeda-261e5b12f1de",
"targetaudiences": "04b0642d-f02c-4810-a6b9-0f63979b3b74",
"Category": "3428d09c-1224-4b7c-9c35-a22b6d774785",
"Tags": "363ec36b-1d48-4c8f-891f-8c8178e037d3",
"departmentaltargets": "2679e633-56be-40c9-8a4f-d5ccea2896ba",
"events": "5847f987-2d60-4974-9713-21db2fb502e8",
"publishingoffices": "83b5ed0a-64fe-43b5-b99b-4fd9cfbc3c3c",
"Parts": "sample string 19",
"FolderId": "678cd12b-baa0-460d-94ea-83503c230208",
"ParentId": "3ac47c40-3b4b-436f-b3a8-3a8a7bc0a95f"
}Method can return success code: NoContent - 204 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.
None.
Full update for documents item.
PUT /api/whoreference/documents({key})
| Name | Description | Type | Additional Information |
| key | System.Guid | Required |
| 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 | |
| SystemSourceKey | System.String | Read only: False | |
| Ordinal | System.Single | Read only: False | |
| UrlName | System.String | Read only: False | |
| ItemDefaultUrl | System.String | Read only: True | |
| Author | System.String | Read only: False | |
| Extension | System.String | Read only: True | |
| MimeType | System.String | Read only: True | |
| TotalSize | System.Int64 | Read only: True | |
| healthtopics | System.Guid | Read only: False | |
| targets | System.Guid | Read only: False | |
| regionscountries | System.Guid | Read only: False | |
| stakeholders | System.Guid | Read only: False | |
| targetaudiences | System.Guid | Read only: False | |
| Category | System.Guid | Read only: False | |
| Tags | System.Guid | Read only: False | |
| departmentaltargets | System.Guid | Read only: False | |
| events | System.Guid | Read only: False | |
| publishingoffices | 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 | |
| IsDamMedia | System.Boolean | Read only: True |
application/json
{
"PublicationDate": "2025-10-18T19:17:24.295992Z",
"Title": "sample string 2",
"Description": "sample string 3",
"IncludeInSitemap": true,
"SystemSourceKey": "sample string 5",
"Ordinal": 6.1,
"UrlName": "sample string 7",
"Author": "sample string 8",
"healthtopics": "ae3a8ce9-2a7b-4f30-a47c-19db2e7d687f",
"targets": "fd404b22-aeba-49c9-adfd-2d2b5cc73c3e",
"regionscountries": "f8ad8044-6217-4fd6-9f75-3ba882cd44eb",
"stakeholders": "34d8ea23-0bfb-4212-b107-4a1e0fba7dc8",
"targetaudiences": "196dd3a4-b5d4-48b7-b31c-525da0f56d5d",
"Category": "09ff94b7-fd19-4e5f-af62-d571c871e0e8",
"Tags": "b844df89-1b32-4714-b9fd-cdcf6ab73d25",
"departmentaltargets": "880ab8aa-4073-4335-8782-4154ff7ed6a0",
"events": "601d435b-bc0f-441b-915d-a752b4a25bef",
"publishingoffices": "81c294db-7aea-4332-8a0c-6d61adb413c3",
"Parts": "sample string 19",
"FolderId": "1ace693d-ef57-4328-a728-1444652cbcd8",
"ParentId": "d2d4af15-5cdf-4bd8-85c3-9ceafedd1948"
}Method can return success code: NoContent - 204 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.
None.
Deletes a documents item by Id.
DELETE /api/whoreference/documents({key})
| Name | Description | Type | Additional Information |
| key | System.Guid | Required |
None
None.
Method can return success code: NoContent - 204 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.
None.