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-06-27T21:11:21.4310591Z",
"PublicationDate": "2026-06-27T21:11:21.4310591Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-06-27T21:11:21.4310591Z",
"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": "f96b5575-b0e3-42f5-8c61-abbedd9aa95d",
"targets": "390c5654-c022-4bf6-80a0-0aeb52e751cc",
"regionscountries": "ffabf291-258c-47c4-b7c9-05431b4000f4",
"stakeholders": "5c69609b-48dd-485f-9d84-030911a04e85",
"targetaudiences": "fe1137c4-6ed5-4235-ab19-875135647b61",
"Category": "6733b862-5404-42cc-9795-5d3453b8d238",
"Tags": "e34f52c9-b424-44b6-8f11-784487d78bc8",
"departmentaltargets": "d7b0ce23-dd66-4350-b861-9a45525b8c24",
"events": "9e8c224c-50b8-473c-a280-22f17c2efcf8",
"publishingoffices": "1856c50e-a0aa-43e9-9bab-bb3b02246d75",
"Parts": "sample string 25",
"FolderId": "50b661b0-6309-40eb-81ff-e6fec0ab6d2e",
"ParentId": "fe008f5b-c221-4296-99f7-c5d315d3da06",
"Provider": "sample string 28",
"Url": "sample string 29",
"ThumbnailUrl": "sample string 30",
"IsDamMedia": true
},
{
"LastModified": "2026-06-27T21:11:21.4310591Z",
"PublicationDate": "2026-06-27T21:11:21.4310591Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-06-27T21:11:21.4310591Z",
"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": "f96b5575-b0e3-42f5-8c61-abbedd9aa95d",
"targets": "390c5654-c022-4bf6-80a0-0aeb52e751cc",
"regionscountries": "ffabf291-258c-47c4-b7c9-05431b4000f4",
"stakeholders": "5c69609b-48dd-485f-9d84-030911a04e85",
"targetaudiences": "fe1137c4-6ed5-4235-ab19-875135647b61",
"Category": "6733b862-5404-42cc-9795-5d3453b8d238",
"Tags": "e34f52c9-b424-44b6-8f11-784487d78bc8",
"departmentaltargets": "d7b0ce23-dd66-4350-b861-9a45525b8c24",
"events": "9e8c224c-50b8-473c-a280-22f17c2efcf8",
"publishingoffices": "1856c50e-a0aa-43e9-9bab-bb3b02246d75",
"Parts": "sample string 25",
"FolderId": "50b661b0-6309-40eb-81ff-e6fec0ab6d2e",
"ParentId": "fe008f5b-c221-4296-99f7-c5d315d3da06",
"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-06-27T21:11:21.4310591Z",
"PublicationDate": "2026-06-27T21:11:21.4310591Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-06-27T21:11:21.4310591Z",
"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": "61b24bd6-6ac8-4bcf-9cf9-1b1d003240c3",
"targets": "34cab33a-023a-4e37-8e52-3df41535c750",
"regionscountries": "bce8f0d2-0acc-4a42-9915-aa46c721ffd5",
"stakeholders": "9cbdbd0a-9a8e-4afc-a90d-f4444dcbc22c",
"targetaudiences": "8236fa25-839b-495a-bed0-a020e387afc4",
"Category": "8415f6cd-e45c-489c-8c65-61cb50ce565c",
"Tags": "b099d0d9-74e6-4bd2-a8cd-3c2a2dbc4b26",
"departmentaltargets": "4c293564-4a87-4824-92b2-b9575d459360",
"events": "f338d7a4-e150-46f4-8bd4-b9ae1a6e4e06",
"publishingoffices": "2d837821-97d6-4b44-9465-f515731f8dfc",
"Parts": "sample string 25",
"FolderId": "44454d98-ef53-42ca-8ee9-58587fb5da07",
"ParentId": "258b3b50-8fba-4b58-9bf3-4cf8b232358c",
"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": "b3c8d400-b73a-49dd-8447-43233227c0d0"
}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-06-27T21:11:21.4310591Z",
"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": "970337b8-74df-47cf-b290-35336c91d2c3",
"targets": "12965145-b2c4-4f6c-a570-b14c86e86b09",
"regionscountries": "779787fc-a1d6-4112-a09d-fa6f92e43dc7",
"stakeholders": "d736e7c0-cde6-4249-83b9-2e8005db583a",
"targetaudiences": "5018dcd8-d62e-4f18-b41d-af28e6d0ad07",
"Category": "4d34c8ec-0833-412e-bfe1-b062bf6d7101",
"Tags": "6dff1d4e-2ad9-4436-aeec-ee3240a414cc",
"departmentaltargets": "9d355c84-237c-4ebf-9ac1-21a01000faa6",
"events": "5d5775c1-0e22-4c0e-92c9-4b7eaeb6313a",
"publishingoffices": "a0c21d8b-8e24-4edf-9702-b8ed8c2fd9d6",
"Parts": "sample string 19",
"FolderId": "de0143d7-1d5a-4fb8-995c-643727871db2",
"ParentId": "1e63d878-9491-4e0d-a7d4-ad91ed4b8eea"
}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-06-27T21:11:21.4310591Z",
"PublicationDate": "2026-06-27T21:11:21.4310591Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-06-27T21:11:21.4310591Z",
"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": "41c753a8-3b6a-443b-9397-fd811201db1b",
"targets": "a420eb9a-d0b4-40cd-9392-472ac38b0b55",
"regionscountries": "a3e186ab-b441-422a-a2bb-d5b16ade41a9",
"stakeholders": "28f9ea95-2590-4665-aeed-82351911c9ba",
"targetaudiences": "ff4add9c-4b84-417f-a675-b3fe5c143197",
"Category": "0e01e932-8bcc-4a69-a794-ca5f1d7ed368",
"Tags": "2a1ebd36-4d56-4ec6-a757-e1219ab1366a",
"departmentaltargets": "96a440ba-d44e-4d06-bbc9-e754d0db6f8c",
"events": "8777cb19-fb2d-4395-8834-10029ce22bac",
"publishingoffices": "e26e78c6-0e28-493c-b7a1-fc4546f708cf",
"Parts": "sample string 25",
"FolderId": "d69343c4-e04d-4d46-8235-061850228eaf",
"ParentId": "fcdcd4cf-68ba-4bb1-9eb8-7f6ffdb58292",
"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-06-27T21:11:21.4310591Z",
"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": "60426da1-135d-4d27-853c-2121014f66e1",
"targets": "babc7b50-67ee-4de1-b65a-3b36300d8934",
"regionscountries": "1e042962-ba83-4972-84b9-60573dc8a550",
"stakeholders": "cfe64faf-800a-4f15-a713-4ebe0d0d71b8",
"targetaudiences": "2a392fb0-380b-4f49-9996-ce1989e06bb5",
"Category": "9273e454-a218-4b4d-b69f-db2c33935148",
"Tags": "c6d458b8-e7c2-4af7-9138-05a6af02164d",
"departmentaltargets": "d51c0209-fc20-4368-bf67-13350d145033",
"events": "4a867140-8e89-4425-b3d9-1c2215b05e4a",
"publishingoffices": "70582727-b89f-4148-b4b8-ec53c6fa233e",
"Parts": "sample string 19",
"FolderId": "8dbba78b-3929-4352-bf67-be28be016e14",
"ParentId": "b9e6726a-8cf8-4f9a-893b-22623d6b0a1a"
}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-06-27T21:11:21.4310591Z",
"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": "5065cd40-9790-4937-bfb0-25e1b3063350",
"targets": "cb330f25-a436-4a57-9353-62c305f51653",
"regionscountries": "a13fd8d6-7897-48bb-9324-3dba89fbef0c",
"stakeholders": "091ecd93-a8bf-48cd-b63d-28a73940ef2d",
"targetaudiences": "5ed80329-ced8-4246-9da2-aadba901bd71",
"Category": "8b20dfcc-1902-4566-84c4-048f81366f75",
"Tags": "c0432fde-2132-4211-b705-b63af85dfedd",
"departmentaltargets": "a2fdbe47-e40c-4684-8182-3c5640c7562f",
"events": "ef65299e-2270-4f83-af90-d65d917f5244",
"publishingoffices": "3144f8ab-0aa9-4b2d-b81d-f3d35b3b0e4f",
"Parts": "sample string 19",
"FolderId": "8147bfdb-51c1-43c0-9141-5a99e7c849e3",
"ParentId": "43dd45a1-ec83-4b1e-b3d2-95b9f0726f26"
}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.