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": "2026-03-27T09:06:09.8512757Z",
"PublicationDate": "2026-03-27T09:06:09.8512757Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-03-27T09:06:09.8512757Z",
"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": "69051d02-c592-4246-a2ff-b206ba25b25c",
"targets": "168ab4f1-2356-4f5a-86f3-4f85582e463d",
"regionscountries": "b476304b-eb39-413a-a904-43ebc05679c4",
"stakeholders": "83cf867c-1ad4-499b-a5be-a91aa5f67716",
"targetaudiences": "b6213cf3-d71d-4987-931e-b92a09b159e0",
"Category": "8375aae7-f15d-4c96-98c6-16aa0ccc9490",
"Tags": "905f7a2e-affd-42f4-98d7-fa2347c89071",
"departmentaltargets": "ab1e4aa7-857f-4f99-84f1-433df107a234",
"events": "a1716536-f183-4999-8c63-c1d77a922229",
"publishingoffices": "23937582-05a1-4eaf-8d5a-64c01fa22fdf",
"Parts": "sample string 25",
"FolderId": "a1cf31e0-b435-4f14-ba34-ee72c18aa824",
"ParentId": "90d69292-d1e9-43e9-90f4-8eddf7dec946",
"Provider": "sample string 28",
"Url": "sample string 29",
"ThumbnailUrl": "sample string 30",
"IsDamMedia": true
},
{
"LastModified": "2026-03-27T09:06:09.8512757Z",
"PublicationDate": "2026-03-27T09:06:09.8512757Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-03-27T09:06:09.8512757Z",
"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": "69051d02-c592-4246-a2ff-b206ba25b25c",
"targets": "168ab4f1-2356-4f5a-86f3-4f85582e463d",
"regionscountries": "b476304b-eb39-413a-a904-43ebc05679c4",
"stakeholders": "83cf867c-1ad4-499b-a5be-a91aa5f67716",
"targetaudiences": "b6213cf3-d71d-4987-931e-b92a09b159e0",
"Category": "8375aae7-f15d-4c96-98c6-16aa0ccc9490",
"Tags": "905f7a2e-affd-42f4-98d7-fa2347c89071",
"departmentaltargets": "ab1e4aa7-857f-4f99-84f1-433df107a234",
"events": "a1716536-f183-4999-8c63-c1d77a922229",
"publishingoffices": "23937582-05a1-4eaf-8d5a-64c01fa22fdf",
"Parts": "sample string 25",
"FolderId": "a1cf31e0-b435-4f14-ba34-ee72c18aa824",
"ParentId": "90d69292-d1e9-43e9-90f4-8eddf7dec946",
"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": "2026-03-27T09:06:09.8512757Z",
"PublicationDate": "2026-03-27T09:06:09.8512757Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-03-27T09:06:09.8512757Z",
"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": "57b106e1-f100-4640-a759-6242d0a79322",
"targets": "f12075f8-b648-45f3-809c-f148d26c8968",
"regionscountries": "8fcd0e11-4c6e-483f-a82b-2eb65e8cfbde",
"stakeholders": "3e2e0fe9-2605-4d80-8af8-250b467bc9b4",
"targetaudiences": "49e71b8e-5045-4684-afdf-51b3684865f7",
"Category": "733add8f-8318-4573-9205-cf1a43bf6ebb",
"Tags": "f6ea7a80-cbcb-47b6-afcc-cd115f9ef316",
"departmentaltargets": "b97f0adb-6d4f-4298-99db-f3dbff718a80",
"events": "6dae1b7d-0b1f-431f-a49c-410650c6eadc",
"publishingoffices": "a46312f5-4723-4be6-b816-5a12d5b78644",
"Parts": "sample string 25",
"FolderId": "7f89339a-4001-4f0c-9fbe-9416122b4ef4",
"ParentId": "120a2201-5739-4f97-9029-35b281e800c8",
"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": "64e06a04-4092-4eb4-b7c9-ff2b0c0a34d6"
}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": "2026-03-27T09:06:09.8512757Z",
"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": "d7bc5889-4b01-44d0-a911-d14e7747d4f5",
"targets": "98584537-0c74-443e-bec2-c2f4b22405f8",
"regionscountries": "e69b72aa-9452-4d28-be19-776205c12022",
"stakeholders": "bead8175-2f79-4eae-89a6-ed9ab7c5e6b8",
"targetaudiences": "bff64f71-2685-4768-8800-c9e520851213",
"Category": "47806383-bf25-48ef-92b5-cb282bcdd392",
"Tags": "31c3a85d-6cb8-4b51-8fad-6c2af6fb0f9b",
"departmentaltargets": "6adcd83b-54ce-4de6-94c8-bfe8ee1d7e4f",
"events": "181b0d66-7927-45e0-a56f-f8128b92c3a1",
"publishingoffices": "a98de25b-5ba8-4a0f-89dc-cf3e3965770c",
"Parts": "sample string 19",
"FolderId": "6839a1b6-19ad-498d-be22-f49714cad1d7",
"ParentId": "eb22494a-c519-4f78-ac58-62934094e0a2"
}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": "2026-03-27T09:06:09.8512757Z",
"PublicationDate": "2026-03-27T09:06:09.8512757Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-03-27T09:06:09.8512757Z",
"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": "b4490ac4-9128-44b0-ba49-612b56d62a4e",
"targets": "d46ddfb2-0bba-4706-a9cf-9d109157ebbb",
"regionscountries": "b1255387-a8e2-4d59-98dc-938759dce354",
"stakeholders": "6cea80e9-eda2-4f60-8f6c-a93fed7b2410",
"targetaudiences": "94b2edac-7ca9-4521-956a-e867ba687190",
"Category": "ac51a2af-debd-498d-b543-f0172dd6f4fc",
"Tags": "a2cd1897-b9d6-461e-86ab-4d9e2152fcdb",
"departmentaltargets": "c8196a63-cbf8-4fe2-bb80-e3226592876b",
"events": "51f26821-f31d-47a9-9a44-db05c0582f7b",
"publishingoffices": "d6d6d573-d338-4aa9-b76d-419202079eab",
"Parts": "sample string 25",
"FolderId": "fd024e0b-8099-4d57-8a64-ee063a53b6fb",
"ParentId": "4a6a94e6-3d3e-44cc-8924-34f8b0d62006",
"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": "2026-03-27T09:06:09.8512757Z",
"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": "3298df07-46d0-49d7-b679-e7d0848492c1",
"targets": "5ff4360b-19d3-4c1a-8006-b4887d3c97bd",
"regionscountries": "e070e4f8-c387-4a80-a0dd-bde1700423e1",
"stakeholders": "7c18106c-bdd1-442d-9b38-15ff5a655240",
"targetaudiences": "882ba3c0-63bf-4c41-8cf6-7a8c3048b9e4",
"Category": "1327fc0a-73af-445a-bf3c-a4e39925a55b",
"Tags": "0a20c90a-0f1e-445a-ab6d-1d9843342d63",
"departmentaltargets": "1cf14a67-8d3c-4084-abde-4111f00a2ae5",
"events": "33fb37d2-96dc-44a1-b930-aca453249f29",
"publishingoffices": "cdcd6a4b-0322-4893-bd5a-37ba4c72f73a",
"Parts": "sample string 19",
"FolderId": "97dda4b2-e1c7-4a1e-b3e3-7a56514b1bd5",
"ParentId": "3b83855a-2405-499f-b5ae-f1ecbfe3bf14"
}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": "2026-03-27T09:06:09.8512757Z",
"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": "db548226-0876-4835-a576-6dffa7af72b6",
"targets": "f7d91b86-e46d-45cf-91e1-0b6abe847d80",
"regionscountries": "dcfb1d6f-6c41-4859-9481-2729e7bc5438",
"stakeholders": "d282ea8e-6f6e-4f74-9b62-49dd25768545",
"targetaudiences": "8c1c0d74-403b-439e-bf60-4523cacd38ce",
"Category": "4c3cdd3c-5ae5-4465-857e-ce3253303952",
"Tags": "7bb46805-df5e-4388-8704-f90c533883ec",
"departmentaltargets": "fec527f9-8924-4903-b970-c969c8fb9d60",
"events": "e7c12d6d-11c6-4dac-9c6e-2a5f0852b2b3",
"publishingoffices": "6fb859af-265a-4a87-9653-4ae8e4ced912",
"Parts": "sample string 19",
"FolderId": "374253c6-61f8-427b-a087-3b6e3c281bd2",
"ParentId": "ab9b123a-059e-4141-bd10-b725cccff364"
}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.