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-09-13T00:38:46.1758356Z",
"PublicationDate": "2025-09-13T00:38:46.1758356Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2025-09-13T00:38:46.1758356Z",
"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": "a710786c-3d32-40a5-a2d7-bc9b583631d4",
"targets": "b78a2b83-15a4-46ff-a170-4b4be977fa82",
"regionscountries": "59e03f9e-9e1f-486a-a2f4-55fe394c9f9d",
"stakeholders": "896256a2-08a5-4a2a-9ba1-d54f627c1384",
"targetaudiences": "33c07dc3-d641-479f-8941-2615edf00e97",
"Category": "14dfded2-4d32-457b-9e62-7c8edb314bf5",
"Tags": "0f145c54-e372-4ae5-8844-adbb0e3e8743",
"departmentaltargets": "e224188f-47bf-438d-b8e7-401920fc1d97",
"events": "6e38bf66-97a4-43a8-9ed4-22653b855c7e",
"publishingoffices": "b6d53777-e3f3-4b46-a01f-8982fc5bd998",
"Parts": "sample string 25",
"FolderId": "f382a146-6f09-45db-a976-eb63deb0ade1",
"ParentId": "412dd363-5457-4cbc-b471-a60071ca6033",
"Provider": "sample string 28",
"Url": "sample string 29",
"ThumbnailUrl": "sample string 30",
"IsDamMedia": true
},
{
"LastModified": "2025-09-13T00:38:46.1758356Z",
"PublicationDate": "2025-09-13T00:38:46.1758356Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2025-09-13T00:38:46.1758356Z",
"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": "a710786c-3d32-40a5-a2d7-bc9b583631d4",
"targets": "b78a2b83-15a4-46ff-a170-4b4be977fa82",
"regionscountries": "59e03f9e-9e1f-486a-a2f4-55fe394c9f9d",
"stakeholders": "896256a2-08a5-4a2a-9ba1-d54f627c1384",
"targetaudiences": "33c07dc3-d641-479f-8941-2615edf00e97",
"Category": "14dfded2-4d32-457b-9e62-7c8edb314bf5",
"Tags": "0f145c54-e372-4ae5-8844-adbb0e3e8743",
"departmentaltargets": "e224188f-47bf-438d-b8e7-401920fc1d97",
"events": "6e38bf66-97a4-43a8-9ed4-22653b855c7e",
"publishingoffices": "b6d53777-e3f3-4b46-a01f-8982fc5bd998",
"Parts": "sample string 25",
"FolderId": "f382a146-6f09-45db-a976-eb63deb0ade1",
"ParentId": "412dd363-5457-4cbc-b471-a60071ca6033",
"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-09-13T00:38:46.1758356Z",
"PublicationDate": "2025-09-13T00:38:46.1758356Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2025-09-13T00:38:46.1758356Z",
"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": "48c82672-d087-4e1c-a40c-9e84904561ed",
"targets": "dd442361-4ce4-47fa-8d98-52d466ae5719",
"regionscountries": "c47ecfe0-74e6-4871-b87f-e11c8f802303",
"stakeholders": "9198a370-e29e-4061-9a4e-e98e8e5c9d13",
"targetaudiences": "527db080-6e0b-42ef-ae65-ecad6169909e",
"Category": "17e53b51-8b1a-42b5-b604-b634a8fdbd66",
"Tags": "af1d2320-f784-4672-ba9f-9e5b162907f9",
"departmentaltargets": "eaed5248-0b95-466a-b868-c68bcc659007",
"events": "28c842c0-4e6b-4b6a-a922-5db367eb3091",
"publishingoffices": "c455df1f-e42d-4d77-a435-89477328ad9e",
"Parts": "sample string 25",
"FolderId": "b5f831ba-56e8-4ad4-a905-a83c0a102cc1",
"ParentId": "05bdc9b3-bcc2-4862-b24d-0d7d3c024c87",
"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": "99d1fef7-46c3-4873-9319-2552d5994549"
}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-09-13T00:38:46.1758356Z",
"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": "9df3905c-d55c-4bb5-8f8e-bb89f4432c80",
"targets": "981d518b-826e-47c5-8b2d-0862b492358d",
"regionscountries": "8d88b451-b190-40c7-adaf-c6714d65e8b9",
"stakeholders": "f62959aa-13f1-465f-b00f-58b0528a4848",
"targetaudiences": "05a5050f-2c1f-4fde-adf9-a63b2c9f624c",
"Category": "4adc0925-5caf-4a04-bdaf-dc0949b41ecb",
"Tags": "98563901-6c72-41df-88dc-be3c399e7541",
"departmentaltargets": "ae41bd9b-c207-4935-b8e1-efe050a62091",
"events": "cd97cf9d-20d5-48bf-a8e7-7c18e3f5ac97",
"publishingoffices": "c5414df4-2628-47fc-92bd-85e997e861a4",
"Parts": "sample string 19",
"FolderId": "715f5683-13ba-41bf-8d37-d1eb5cf2c56b",
"ParentId": "c09223ed-6f4e-45d6-8f6f-2dc20e487720"
}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-09-13T00:38:46.1758356Z",
"PublicationDate": "2025-09-13T00:38:46.1758356Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2025-09-13T00:38:46.1758356Z",
"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": "38d32908-1939-4545-916b-ed15f2aadaca",
"targets": "639a24f5-7a38-4cdd-949b-60b5a9347350",
"regionscountries": "7d8a63f5-2c75-4e5b-966c-d48868b37bc1",
"stakeholders": "bb1ac8cf-a063-461f-b4b3-3e0c781fbf28",
"targetaudiences": "1ecb29c9-6ff2-431e-a412-31a5d8896fc3",
"Category": "5566da4c-95db-43a3-88b9-ebde6e8d9e89",
"Tags": "f66c2aa6-8b5a-4592-90a7-edd0d415cf05",
"departmentaltargets": "9bdbc10b-ee13-450b-b05b-07ce435d760e",
"events": "60ba5362-1f4e-4ceb-bda7-587e470d8453",
"publishingoffices": "9ed27180-13ee-42f1-88b9-2b8664ff8ccc",
"Parts": "sample string 25",
"FolderId": "9fef85dd-f544-4f82-aff8-d7cbef1cab4f",
"ParentId": "ac990b5d-3abd-4ccd-b3e4-fb90c6925cfd",
"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-09-13T00:38:46.1758356Z",
"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": "0c3d1f40-f92b-42b8-955c-3d3db44e898d",
"targets": "4a8758b2-2601-47ef-8fe3-dbb4c05b65c8",
"regionscountries": "6a3b8a67-639d-4914-a5a0-65fad32be713",
"stakeholders": "cbe1cb2d-b392-4fc3-bac4-40c86c891620",
"targetaudiences": "b540279f-9d05-4844-8342-bf92ba676061",
"Category": "72477c8e-a18c-4d09-abdf-171bb72958c7",
"Tags": "ed261939-1eba-41ce-9e2a-b8356989c03c",
"departmentaltargets": "2d1b6fc7-f28a-4a63-9926-0db83c1e5d0a",
"events": "ff5d7791-ab14-40e0-b6ce-35b6e8765f26",
"publishingoffices": "de5d6152-8f1b-449f-825e-c666c6d88dc8",
"Parts": "sample string 19",
"FolderId": "9516c445-8fd0-4a41-92e9-a6519c0e09b3",
"ParentId": "c67f03b2-2cd9-45ce-b034-bd3cc4296e00"
}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-09-13T00:38:46.1758356Z",
"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": "8089120e-2a9d-44a0-a44d-1063094efac8",
"targets": "db172462-35fe-4862-bb20-fe2e724746e4",
"regionscountries": "00028963-10f7-44ab-81bf-e4665860b50b",
"stakeholders": "b3b4c2b5-fff0-4ba7-870d-d21ac334d637",
"targetaudiences": "ccc8079e-92fb-4091-a55c-30c3e080d881",
"Category": "a356f842-9c04-4db3-bc6a-14838d9f1a96",
"Tags": "bc2d1efb-7f55-4e70-88a0-ea8851e08f6b",
"departmentaltargets": "fe3baed7-f678-4f0c-9ab5-c8b12fa37712",
"events": "d54c62b9-688a-4101-8bbd-4f1bfb2d72d9",
"publishingoffices": "fed13a42-3226-4fbe-881a-276ba9dc20b4",
"Parts": "sample string 19",
"FolderId": "2407a1b4-15a2-44b3-9d1d-fd9b42e2657e",
"ParentId": "590f3a08-dc38-490a-9a57-10d465018282"
}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.