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-05-07T12:11:16.5058939Z",
"PublicationDate": "2026-05-07T12:11:16.5058939Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-05-07T12:11:16.5058939Z",
"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": "a9369b70-9f72-4f3a-ac92-b7f71c6a14fb",
"targets": "c0d68f5d-f95b-43ad-a897-855008a22ee9",
"regionscountries": "37aea18f-c5fc-4507-a223-724793aa2e0e",
"stakeholders": "ca8e4679-183f-4830-9ba8-887bae746dd2",
"targetaudiences": "a758de9c-5cca-4d0a-85ae-6107b575d805",
"Category": "6f0c82ee-b947-4dcc-8f1c-973f53c7e68e",
"Tags": "8213c690-7675-4f4a-a65e-882441c84885",
"departmentaltargets": "16627e78-7196-4667-b3d2-54c138754499",
"events": "db5e644c-c6e7-48e5-a3d8-510c65d1cf5a",
"publishingoffices": "1703e290-5ecb-49a8-aded-ca3d55042a6c",
"Parts": "sample string 25",
"FolderId": "4fcfde88-2586-44cc-9e3b-d9615e56e8ce",
"ParentId": "492f666e-7170-4022-bdfc-c18a5c819a40",
"Provider": "sample string 28",
"Url": "sample string 29",
"ThumbnailUrl": "sample string 30",
"IsDamMedia": true
},
{
"LastModified": "2026-05-07T12:11:16.5058939Z",
"PublicationDate": "2026-05-07T12:11:16.5058939Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-05-07T12:11:16.5058939Z",
"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": "a9369b70-9f72-4f3a-ac92-b7f71c6a14fb",
"targets": "c0d68f5d-f95b-43ad-a897-855008a22ee9",
"regionscountries": "37aea18f-c5fc-4507-a223-724793aa2e0e",
"stakeholders": "ca8e4679-183f-4830-9ba8-887bae746dd2",
"targetaudiences": "a758de9c-5cca-4d0a-85ae-6107b575d805",
"Category": "6f0c82ee-b947-4dcc-8f1c-973f53c7e68e",
"Tags": "8213c690-7675-4f4a-a65e-882441c84885",
"departmentaltargets": "16627e78-7196-4667-b3d2-54c138754499",
"events": "db5e644c-c6e7-48e5-a3d8-510c65d1cf5a",
"publishingoffices": "1703e290-5ecb-49a8-aded-ca3d55042a6c",
"Parts": "sample string 25",
"FolderId": "4fcfde88-2586-44cc-9e3b-d9615e56e8ce",
"ParentId": "492f666e-7170-4022-bdfc-c18a5c819a40",
"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-05-07T12:11:16.5058939Z",
"PublicationDate": "2026-05-07T12:11:16.5058939Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-05-07T12:11:16.5058939Z",
"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": "1b14d0e1-90d9-4c4c-b40f-10e3c21c1819",
"targets": "ac925fce-7767-4a79-861c-d72a08622bae",
"regionscountries": "88c7a6fb-3dc7-4072-9169-20eb14882639",
"stakeholders": "d765b302-3565-4d4a-b2a9-6a1dfaf437b7",
"targetaudiences": "d52ef4b2-15af-42b9-8dc6-dcd34375bb2e",
"Category": "a3d51794-6460-4d39-b45b-fe1fe6eaf05a",
"Tags": "213d086c-0f45-45d7-84fd-9fc40090879f",
"departmentaltargets": "348e41c0-99aa-40d9-acb0-527b6b84eae4",
"events": "de2ce6ee-68b4-4292-990a-2745e8f1d2f0",
"publishingoffices": "950ac302-3ed2-4f0b-8fd1-1a7ac3020bd6",
"Parts": "sample string 25",
"FolderId": "c6001daf-db55-4d2e-9aa0-9b5d66beaec3",
"ParentId": "ab5c1f48-6ba3-4e57-9034-d65eab0cd209",
"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": "f71f40f6-aa72-48d9-b053-1e32a20f8fdb"
}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-05-07T12:11:16.5058939Z",
"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": "5dab5e65-b16f-4e13-8f61-0a560c3df220",
"targets": "1d332de4-21d4-451e-8d6c-3daa5547c1fc",
"regionscountries": "5741eea6-967f-4b78-b520-693cd6adb5bc",
"stakeholders": "0baac8bf-c8d4-43f0-8b61-f3bfc75edcbe",
"targetaudiences": "b8840d25-aa5c-496c-8340-182f8e9927ad",
"Category": "3794f5dc-b086-454a-8dc5-4f596ed1b525",
"Tags": "eb20e5bd-8d90-46f4-907b-385de91f0b09",
"departmentaltargets": "651c2fed-dac3-4d0f-8203-249951d8930e",
"events": "57d07d4a-1fcf-4ce7-b710-4fc1c4a05e9c",
"publishingoffices": "7be81585-f2d5-4ce2-bd77-68879bce18e0",
"Parts": "sample string 19",
"FolderId": "61dfa0f1-d98d-431c-ab42-335f46acf95e",
"ParentId": "35213d14-6a3e-44c8-b421-e8dc78598cf3"
}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-05-07T12:11:16.5058939Z",
"PublicationDate": "2026-05-07T12:11:16.5058939Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-05-07T12:11:16.5058939Z",
"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": "6d3b7637-bf2b-441d-a811-2fa74c45ed9c",
"targets": "98481679-6321-43e7-8554-e08bb7f2a12c",
"regionscountries": "e26d3158-bdaa-4cba-93ec-98e99d00f558",
"stakeholders": "f28fe18d-0492-43aa-ab1f-a769f40d369a",
"targetaudiences": "9c929819-9877-4c6c-bafe-b6d9d7e687b2",
"Category": "16cc2024-737a-4986-91ba-ddd9e4ae8eb4",
"Tags": "d326cdc1-1395-49d2-a133-6de3ee81d75d",
"departmentaltargets": "23d7bd53-713f-4a14-9d91-db61d22da261",
"events": "a5f9b64b-0b53-4933-8a7e-093e3ad72b48",
"publishingoffices": "b8db0989-72a0-4874-b010-20b5e93a32c4",
"Parts": "sample string 25",
"FolderId": "1a405549-dc60-4978-ae59-7089ed0e9f7b",
"ParentId": "3bd2c586-8fa0-4d2e-a14d-050c9ddae206",
"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-05-07T12:11:16.5058939Z",
"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": "c9141151-db80-4d86-9f5a-fca99e1e1db2",
"targets": "1a1fc4ff-58a7-42a2-baed-c2eed35b938e",
"regionscountries": "ddc74779-f90d-42a1-a621-2b8b71ad6ab6",
"stakeholders": "80141514-bb89-4137-889b-dd57de202479",
"targetaudiences": "497fe9d3-9ca1-4e72-8980-0c0dcf0540af",
"Category": "bb6201c4-85ab-4a3f-b044-0283b8d37d3f",
"Tags": "cfafcbb3-d593-4db4-807c-7a90a5023f30",
"departmentaltargets": "cd54e8f8-32c3-44cf-b587-fb9d01533a1b",
"events": "7fdb2aa6-583b-4dc9-891a-3fd27b042679",
"publishingoffices": "cc21aeb2-cac2-44d9-9f11-d5a99a02b83b",
"Parts": "sample string 19",
"FolderId": "a2f7bc03-c95e-4256-8b87-527f009b6c30",
"ParentId": "c846be7f-8c33-457f-80d3-d40d0c6587bc"
}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-05-07T12:11:16.5058939Z",
"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": "a568f145-cfff-4794-b73f-dba0ae24ddbf",
"targets": "434fd928-161d-4226-ab42-9d016b5bb5cc",
"regionscountries": "f015a8b2-95f2-419d-ae8c-8aa174be5ef6",
"stakeholders": "26125583-4f4d-4357-b111-32297b6f5107",
"targetaudiences": "7b465bd8-3e79-4e6c-b6ed-8c64c8fcde49",
"Category": "a3faf342-7c86-41bf-b2a0-4253c354ebe3",
"Tags": "a8331b5f-13ac-45ed-b2f4-1d9973cec3c2",
"departmentaltargets": "e67018f8-50fa-48b1-8c59-65a62873b8dd",
"events": "1e843472-db6e-40bd-a844-373d6784ef50",
"publishingoffices": "717c516a-8d4f-42e0-aa77-0dec89be3f1c",
"Parts": "sample string 19",
"FolderId": "13b31a20-e13c-40cd-97a5-6e2f69666a20",
"ParentId": "0333368a-ca72-40b6-a372-3e3a3e3288ba"
}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.