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-12-10T03:09:47.7465162Z",
"PublicationDate": "2025-12-10T03:09:47.7465162Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2025-12-10T03:09:47.7465162Z",
"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": "c36c7172-90fb-42b0-95a8-33fe86e9026f",
"targets": "e0520b7f-81e5-4eff-9a80-2edbe501dca7",
"regionscountries": "2c12bd24-2912-4270-a532-2b056d1df2c3",
"stakeholders": "6e07dd7a-876e-45ab-8e0e-c6e30c14eca7",
"targetaudiences": "00448b78-5726-49b5-9534-fda2199505bb",
"Category": "e58c9870-a385-4a11-88da-2e2361f5bf33",
"Tags": "c26ae403-cdba-4ead-a615-17ebdb472fdc",
"departmentaltargets": "cfef21d4-31cc-43db-8386-40bf85885bc1",
"events": "9a971e2a-b775-4d5a-a563-a7dc987e3f21",
"publishingoffices": "955c8bba-bb33-43e0-bb07-f902edcc89e0",
"Parts": "sample string 25",
"FolderId": "4c8f603e-5b8f-490f-9c5a-cb0f1abfdd6c",
"ParentId": "03dab554-a6cc-443d-b63f-030697abc97b",
"Provider": "sample string 28",
"Url": "sample string 29",
"ThumbnailUrl": "sample string 30",
"IsDamMedia": true
},
{
"LastModified": "2025-12-10T03:09:47.7465162Z",
"PublicationDate": "2025-12-10T03:09:47.7465162Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2025-12-10T03:09:47.7465162Z",
"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": "c36c7172-90fb-42b0-95a8-33fe86e9026f",
"targets": "e0520b7f-81e5-4eff-9a80-2edbe501dca7",
"regionscountries": "2c12bd24-2912-4270-a532-2b056d1df2c3",
"stakeholders": "6e07dd7a-876e-45ab-8e0e-c6e30c14eca7",
"targetaudiences": "00448b78-5726-49b5-9534-fda2199505bb",
"Category": "e58c9870-a385-4a11-88da-2e2361f5bf33",
"Tags": "c26ae403-cdba-4ead-a615-17ebdb472fdc",
"departmentaltargets": "cfef21d4-31cc-43db-8386-40bf85885bc1",
"events": "9a971e2a-b775-4d5a-a563-a7dc987e3f21",
"publishingoffices": "955c8bba-bb33-43e0-bb07-f902edcc89e0",
"Parts": "sample string 25",
"FolderId": "4c8f603e-5b8f-490f-9c5a-cb0f1abfdd6c",
"ParentId": "03dab554-a6cc-443d-b63f-030697abc97b",
"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-12-10T03:09:47.7465162Z",
"PublicationDate": "2025-12-10T03:09:47.7465162Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2025-12-10T03:09:47.7465162Z",
"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": "6ded4bad-bdf6-4470-85e3-721e4b180d9b",
"targets": "a934de74-4e6d-4298-abd0-5608ac379c8b",
"regionscountries": "655cc779-1c7b-4cfe-8917-3c403d303c62",
"stakeholders": "93fba41d-a86b-4fbc-87f6-62fad8d610bb",
"targetaudiences": "22f9f5ef-21fc-462d-9ef4-f60c514f1ed5",
"Category": "b2366141-9c19-4b60-a8bb-f73bc9d95ded",
"Tags": "a4cba326-fbd7-47d4-8138-781e225b338d",
"departmentaltargets": "f5993c6d-f5e3-40e0-8253-369d8603837f",
"events": "f09edbba-a532-4c75-9814-0e67b81953e6",
"publishingoffices": "71b71a98-968a-4914-89c8-9299a7b4c0d7",
"Parts": "sample string 25",
"FolderId": "c943e86b-4c9c-431e-8f4f-2668a9ca4d74",
"ParentId": "cd9879b6-3d59-49f9-9680-3e25768f127c",
"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": "dd32bff5-e64d-48ca-bea2-9668e9f9f264"
}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-12-10T03:09:47.7465162Z",
"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": "6bba2415-b29f-4fca-8f48-3d06c6ab6f1a",
"targets": "d142ac76-671c-463f-86bf-21dd63ffe303",
"regionscountries": "d827d463-d4f7-4b93-aaac-b372dc3d730c",
"stakeholders": "77d95148-9257-4734-87ae-2852e9bb82a3",
"targetaudiences": "dc1e06b3-d32f-4baf-a454-6b04afb61325",
"Category": "2f8c39bc-4255-4721-aa38-62c04780753b",
"Tags": "4fe5be8e-c30e-4c23-ae6c-92ef01b17863",
"departmentaltargets": "c04e037a-6186-4514-9b3c-5860fa99c271",
"events": "2e586c0e-2077-47f7-9a12-ec831a6eedfc",
"publishingoffices": "1a7c157e-6cef-4993-878b-4a00c2ad21d8",
"Parts": "sample string 19",
"FolderId": "127c0ef5-5e2b-4867-b9e0-ef49328bb4cc",
"ParentId": "7bf642d4-aa07-455f-be6a-4cb68af40943"
}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-12-10T03:09:47.7465162Z",
"PublicationDate": "2025-12-10T03:09:47.7465162Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2025-12-10T03:09:47.7465162Z",
"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": "07a93f85-595b-4bc7-ae30-d94dc082e080",
"targets": "af5e9ae2-7242-40e2-a171-7a1d0e302522",
"regionscountries": "4523b7ce-8914-4574-9a83-48d4aba35be9",
"stakeholders": "53474a33-3b30-431f-87a8-bcd3ae3a5fdc",
"targetaudiences": "bf26bcd0-07ac-4adf-b826-7c416eac152c",
"Category": "1718e1fa-c33f-49b5-a868-63aeb22dd2bd",
"Tags": "11ead6ec-c9e5-4113-8400-d59f155ebf3c",
"departmentaltargets": "797dbf3c-5ab0-4905-9de7-fcd1fcceeb17",
"events": "55391a83-c728-4b87-8950-458af8f0d99d",
"publishingoffices": "ff97f200-5126-4ca0-8a0e-25a77962afd0",
"Parts": "sample string 25",
"FolderId": "d28ead51-4e1a-4a95-bc4d-f40048108844",
"ParentId": "5fbc14b0-00d1-4786-a5b6-ba5e68d4b7e1",
"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-12-10T03:09:47.7465162Z",
"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": "dd8b2850-62ef-4069-9447-bca9716201b0",
"targets": "33119e94-d72c-4406-ae0a-c68713c8bf80",
"regionscountries": "a668b011-b175-4583-beed-4883c1cfc1f0",
"stakeholders": "0014bf31-5b87-4fa0-ba54-061ae8b4f3cd",
"targetaudiences": "475d8c2a-1b3a-4be0-a23d-35fca26b3a55",
"Category": "cbcb8c0b-8dff-4bc0-9a45-016038009eee",
"Tags": "24b4fd0a-a587-43d8-bf05-1a0fdbe83083",
"departmentaltargets": "74201cc3-a125-4ebd-a039-b0b039a35480",
"events": "5aa1d05b-32b8-4519-98e0-72996cdd28ab",
"publishingoffices": "1906ac6b-bd80-4a82-bc26-07c9b30bff8f",
"Parts": "sample string 19",
"FolderId": "3aa88bff-69d8-4b04-81a4-e63f13e621a7",
"ParentId": "d7c66c60-6d15-4873-94ff-fd3f782e4bc2"
}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-12-10T03:09:47.7465162Z",
"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": "11578734-09ac-4637-a590-2c5a26a8f096",
"targets": "3cf1282b-e395-4003-9220-526feff14db4",
"regionscountries": "86722f83-ac31-4e3b-890b-a31393643642",
"stakeholders": "dfbd4ab1-7b41-4d41-9fcc-9a796c86714a",
"targetaudiences": "feac7a77-99a3-4ef3-856e-a97fe73eb2fb",
"Category": "f7a5574d-0ed0-475d-8136-ee1ab7bd6a05",
"Tags": "ae383933-5409-446e-aa81-baa026e4a676",
"departmentaltargets": "fa1c4816-8402-4224-b2b7-629245820039",
"events": "2d5c9494-6d83-4c1e-8a79-2e7591e693d5",
"publishingoffices": "0422571f-6334-4070-b30b-d45ad9b8b6ac",
"Parts": "sample string 19",
"FolderId": "6d5bad51-438a-4cae-b898-71a5578a0354",
"ParentId": "d6fd8557-179c-4ab0-9016-e1b969014895"
}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.