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-01T16:09:43.987633Z",
"PublicationDate": "2026-06-01T16:09:43.987633Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-06-01T16:09:43.987633Z",
"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": "1f7f6e68-814e-4d90-8094-ae524b3a28c3",
"targets": "cd643e8c-5ed4-4086-b4d3-01b12003b6d9",
"regionscountries": "85eae720-44ec-4d8d-a339-65f58533550e",
"stakeholders": "cc948b0d-3642-4484-8681-8b3f23b2b57c",
"targetaudiences": "c0693d1b-dae3-481d-88fb-260967a2975b",
"Category": "2748454e-0d3e-42ef-a943-801b223b3467",
"Tags": "d9ab31ee-37e0-4b9a-a0c1-e726b30e0bdd",
"departmentaltargets": "c112bada-edf1-4e8e-9e75-19a44867df15",
"events": "ee2309e6-41ad-46bc-9f02-66198c099cab",
"publishingoffices": "c39b5c3e-505a-46e0-8c31-1da7792d25ec",
"Parts": "sample string 25",
"FolderId": "30533986-f99c-4cd2-8407-7b9f29e18766",
"ParentId": "02a63020-db71-4373-9cf2-3d2fa1c01d7a",
"Provider": "sample string 28",
"Url": "sample string 29",
"ThumbnailUrl": "sample string 30",
"IsDamMedia": true
},
{
"LastModified": "2026-06-01T16:09:43.987633Z",
"PublicationDate": "2026-06-01T16:09:43.987633Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-06-01T16:09:43.987633Z",
"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": "1f7f6e68-814e-4d90-8094-ae524b3a28c3",
"targets": "cd643e8c-5ed4-4086-b4d3-01b12003b6d9",
"regionscountries": "85eae720-44ec-4d8d-a339-65f58533550e",
"stakeholders": "cc948b0d-3642-4484-8681-8b3f23b2b57c",
"targetaudiences": "c0693d1b-dae3-481d-88fb-260967a2975b",
"Category": "2748454e-0d3e-42ef-a943-801b223b3467",
"Tags": "d9ab31ee-37e0-4b9a-a0c1-e726b30e0bdd",
"departmentaltargets": "c112bada-edf1-4e8e-9e75-19a44867df15",
"events": "ee2309e6-41ad-46bc-9f02-66198c099cab",
"publishingoffices": "c39b5c3e-505a-46e0-8c31-1da7792d25ec",
"Parts": "sample string 25",
"FolderId": "30533986-f99c-4cd2-8407-7b9f29e18766",
"ParentId": "02a63020-db71-4373-9cf2-3d2fa1c01d7a",
"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-01T16:09:43.987633Z",
"PublicationDate": "2026-06-01T16:09:43.987633Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-06-01T16:09:43.987633Z",
"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": "ef70b346-2873-41ff-ab99-9bdbf21aec5a",
"targets": "d4d95fc5-924c-45d1-8c95-b72794290503",
"regionscountries": "f12bfe48-5355-4f06-b388-b635a46d4c05",
"stakeholders": "3afa3199-847b-4073-89e3-383658403249",
"targetaudiences": "a0499d45-f406-4f03-8ea2-6d046bc648bb",
"Category": "d5aa4194-22af-439f-810d-8ce0d6cffa95",
"Tags": "1c06ff5e-8b1a-4284-8c82-ae3829ffe270",
"departmentaltargets": "63204566-af9a-4d19-a9ce-f71794d93f79",
"events": "a3a535d1-06c7-441e-936c-c4280982246b",
"publishingoffices": "7514836b-dc68-47a0-8568-90b606dcf48c",
"Parts": "sample string 25",
"FolderId": "c22f587f-df73-44b9-b567-33a488865331",
"ParentId": "48c773ae-17fb-4738-81f6-561bd3dc6718",
"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": "2eab0317-d7f4-4a94-97e5-08b0a057ffbb"
}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-01T16:09:43.987633Z",
"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": "e0e2f842-a80d-4b46-afdd-6e9f55148ac9",
"targets": "11fca19e-6d90-4851-8825-53c388e45d11",
"regionscountries": "5f9ce75a-1d78-4425-a17a-9418a304bfb0",
"stakeholders": "1b70e727-255d-43ea-a7ca-4360c3a408b2",
"targetaudiences": "7688b29b-f798-48e8-83fa-d35ecd0b0e0b",
"Category": "7619dded-6d0c-4099-ac88-95f6493922bc",
"Tags": "27d13958-81b9-4f7e-bace-4867483d7d98",
"departmentaltargets": "9bca0cc2-0fe5-4a1f-8856-0f696a37ee62",
"events": "bc5f8e8a-d539-4a8e-99ae-82af4f410aa6",
"publishingoffices": "43021458-dfe9-4f24-bb8a-59e547008c1e",
"Parts": "sample string 19",
"FolderId": "73e3a087-d28f-48d0-ac5f-0409da771f50",
"ParentId": "97d2e6bf-c88a-434f-a139-5d5f4136826a"
}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-01T16:09:43.987633Z",
"PublicationDate": "2026-06-01T16:09:43.987633Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-06-01T16:09:43.987633Z",
"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": "811c1af8-729d-4ef7-8852-fa86ac5c5d59",
"targets": "b08b009e-3dda-433d-bf27-65f96a188351",
"regionscountries": "ecf0f675-904b-4454-b545-a4d5e1454649",
"stakeholders": "926f9b19-6f35-42a8-baae-e6b1b3d01531",
"targetaudiences": "d1657bbf-d4ea-46b7-bf8b-cacc619082be",
"Category": "aa80af26-d6d1-48c8-bb6b-9a5901170119",
"Tags": "850141d5-a594-4909-bcd1-de367ac910eb",
"departmentaltargets": "70a1e84e-2b95-4ff4-b8b8-dcd0e22f053e",
"events": "9ddbbeab-e8ef-431d-9c13-951dc03192b6",
"publishingoffices": "17770f5a-56fa-43ef-8df4-89e2d8ac8f56",
"Parts": "sample string 25",
"FolderId": "0f72f4b5-1a07-4777-beb9-55196130926e",
"ParentId": "29cf9656-66e3-4575-be5f-f46f8bb8754e",
"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-01T16:09:43.987633Z",
"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": "9b7d122e-40e0-433c-8843-102e810f4c54",
"targets": "fcdf27aa-ad43-4ea5-80f9-68ef9b61eff8",
"regionscountries": "7f8432d6-9dc6-48b5-8fe8-1ac98f4efc89",
"stakeholders": "9ba86a0c-5cd2-415f-ad68-c3b987dd3439",
"targetaudiences": "58ce9bad-94ca-46e7-bbe0-7604dce2ec51",
"Category": "de0a58e7-1a69-4487-afac-01c76beba4ab",
"Tags": "8faace35-3e45-4139-88db-74780dd8771c",
"departmentaltargets": "020828c1-3827-4ebf-b8a9-167a00e7866b",
"events": "f10735d5-cf88-4dd1-9331-ae151254b698",
"publishingoffices": "ac16f77c-956f-4bf1-bd37-8b04bcb6f762",
"Parts": "sample string 19",
"FolderId": "8f870452-424d-4fa6-af25-406cac94b1d2",
"ParentId": "aa75b171-5672-49e5-a335-95767cf60176"
}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-01T16:09:43.987633Z",
"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": "bfae60c9-8755-4a52-83ae-bb1a167213c6",
"targets": "e6e3f384-5a2d-4c15-80b1-84094f5bfcff",
"regionscountries": "640125e4-ac26-4e1f-aed4-27df21ae3df2",
"stakeholders": "a0cb3860-9c8d-4eda-adfd-cd3160bfddf5",
"targetaudiences": "4cff84e8-07ec-471f-96cc-cc8cc6dcfd8d",
"Category": "8a8212a6-eceb-4113-a6e6-0cca947cfa8c",
"Tags": "d2f9bbdb-1a53-4197-ba02-a2ccc5552ba1",
"departmentaltargets": "50233143-f0e7-48a9-9373-530065383036",
"events": "6e303eff-e721-4bde-a404-f8af2fc5470c",
"publishingoffices": "b5515c9d-8733-4ec7-8e74-b38527672299",
"Parts": "sample string 19",
"FolderId": "1a76effd-52ce-4a4f-99f9-1dad6d16cb9f",
"ParentId": "d4f067ff-931e-4b33-bad7-6c6bde0588fb"
}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.