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-02-10T11:12:39.0761105Z",
"PublicationDate": "2026-02-10T11:12:39.0761105Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-02-10T11:12:39.0761105Z",
"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": "1fd844bf-2d4f-4c6a-99b5-be02fb2ab1ec",
"targets": "39a9b00e-9d9b-40e1-92db-cf0357a71b2d",
"regionscountries": "219d2419-c676-417f-8de9-bd890ab4706a",
"stakeholders": "062fa610-355e-437a-a49d-b2d1cdc517a6",
"targetaudiences": "868aa525-85ce-4325-be08-f72b37c34410",
"Category": "e290b742-8c77-4032-9c2b-996768c0fdda",
"Tags": "9235e05a-e4cc-41b3-afda-a7d88f6a40c4",
"departmentaltargets": "fe9090c6-5bf7-4c7c-9916-8e991def37b3",
"events": "eeec3e89-d862-4b75-b7a6-92106d607839",
"publishingoffices": "30cb8841-d23b-4c3f-b9a9-6560dc217f76",
"Parts": "sample string 25",
"FolderId": "2a0c11a7-652e-4454-a328-d12355175ac4",
"ParentId": "363674f8-d562-4c96-9eb4-9d4e0f2541bf",
"Provider": "sample string 28",
"Url": "sample string 29",
"ThumbnailUrl": "sample string 30",
"IsDamMedia": true
},
{
"LastModified": "2026-02-10T11:12:39.0761105Z",
"PublicationDate": "2026-02-10T11:12:39.0761105Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-02-10T11:12:39.0761105Z",
"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": "1fd844bf-2d4f-4c6a-99b5-be02fb2ab1ec",
"targets": "39a9b00e-9d9b-40e1-92db-cf0357a71b2d",
"regionscountries": "219d2419-c676-417f-8de9-bd890ab4706a",
"stakeholders": "062fa610-355e-437a-a49d-b2d1cdc517a6",
"targetaudiences": "868aa525-85ce-4325-be08-f72b37c34410",
"Category": "e290b742-8c77-4032-9c2b-996768c0fdda",
"Tags": "9235e05a-e4cc-41b3-afda-a7d88f6a40c4",
"departmentaltargets": "fe9090c6-5bf7-4c7c-9916-8e991def37b3",
"events": "eeec3e89-d862-4b75-b7a6-92106d607839",
"publishingoffices": "30cb8841-d23b-4c3f-b9a9-6560dc217f76",
"Parts": "sample string 25",
"FolderId": "2a0c11a7-652e-4454-a328-d12355175ac4",
"ParentId": "363674f8-d562-4c96-9eb4-9d4e0f2541bf",
"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-02-10T11:12:39.0761105Z",
"PublicationDate": "2026-02-10T11:12:39.0761105Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-02-10T11:12:39.0761105Z",
"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": "7d84fab2-e777-4a3a-bb3f-3d8a5253431c",
"targets": "424eb01a-f16b-4a82-9b19-ed9ae63ec9e2",
"regionscountries": "f7a225b4-afec-4e23-8aac-f7d79c28f656",
"stakeholders": "a53c9b17-b3d5-4257-9b1e-0ea323964df9",
"targetaudiences": "28a1e5bf-8dff-4373-a01d-74e2257a9808",
"Category": "9e296cc8-b5f6-4562-9a70-2cf67bcfa2e5",
"Tags": "124b253d-5e40-489d-ba82-fd5ef498bb17",
"departmentaltargets": "5611a42d-8de4-4e24-bbcb-e68ac0a841ca",
"events": "6beae545-c657-4143-a9df-6fa5c4ab2b56",
"publishingoffices": "e5e299ee-2ade-4468-a8ab-93368199c214",
"Parts": "sample string 25",
"FolderId": "289bb267-de30-4183-a7c5-cd679a7e737e",
"ParentId": "7f121f5a-08c2-469d-9da6-daa270d38b6e",
"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": "2e58874a-bbf4-4ed8-993a-1f118e071a61"
}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-02-10T11:12:39.0761105Z",
"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": "96f1d2ed-3112-497f-a504-1cfc9d870332",
"targets": "1bdcf560-f63c-4559-90e6-9fbf5cd21a4c",
"regionscountries": "d5844aca-7db2-4d42-a982-06fe4460f779",
"stakeholders": "a6247d10-1563-4c8f-aa46-77a40513b35e",
"targetaudiences": "7e29b01b-fe4c-43d9-8817-b86a8ec97596",
"Category": "112ad97c-aec3-44c6-8a28-217733b26960",
"Tags": "49190439-26ec-4b8f-85aa-3502f4407fcc",
"departmentaltargets": "c00a0bc4-898a-4787-97f9-e77389113825",
"events": "e2ead244-abc6-407e-8204-9b1f3c70ed8d",
"publishingoffices": "767a6811-1a10-451e-8970-c6a53653a73a",
"Parts": "sample string 19",
"FolderId": "e11bfb56-23c0-4c1d-8051-fa126a1ad1dc",
"ParentId": "69668120-81e0-4d5f-889a-96cdb80af833"
}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-02-10T11:12:39.0761105Z",
"PublicationDate": "2026-02-10T11:12:39.0761105Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-02-10T11:12:39.0761105Z",
"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": "4170a59f-4b8c-4d4f-8d06-c0dbab3c2ba1",
"targets": "1428321a-f7ac-4f56-8d89-97cd27ee5c7b",
"regionscountries": "354da2b9-1df6-4a39-8ac2-6766b4e72f9e",
"stakeholders": "249be49f-2ccd-4756-a835-75c1db0ba307",
"targetaudiences": "79007264-58bb-41b0-a358-5a22d415b62a",
"Category": "158de063-b445-4945-9b9e-3325515515d8",
"Tags": "3057892e-da41-4a10-bd0f-839b0687e0d9",
"departmentaltargets": "cfe68711-329f-4a5c-a724-ad71ce01e021",
"events": "7bbb175a-ff0a-4bd1-bba4-440386dea094",
"publishingoffices": "46b5a9d7-d2c4-49f5-a618-f30a7140395c",
"Parts": "sample string 25",
"FolderId": "19ec8a55-db64-4ebf-8c5a-4888f7467e4b",
"ParentId": "eb05093d-1b19-4d55-9854-532ade114f0c",
"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-02-10T11:12:39.0761105Z",
"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": "d5ab67d1-d66c-4e1a-ac99-014d976ffa1a",
"targets": "04a89613-1ec5-410c-9726-7c87b7274feb",
"regionscountries": "cfa580c3-4131-4aad-9563-8b6f8f551d22",
"stakeholders": "6cb51c3a-fa93-4ef7-af4d-81eef960491a",
"targetaudiences": "0545de4e-3a9b-412c-bf81-e59e1f82aec1",
"Category": "64f77fbd-f6b3-4cc6-a7a4-f8044586da62",
"Tags": "2064b8ab-4933-4e83-9137-79442b9169ad",
"departmentaltargets": "f84b5a8d-fcfa-4e57-959a-29bf39ba3e73",
"events": "73aa6910-ca23-4f06-96ed-cab6af9f7487",
"publishingoffices": "edd0548e-ae5c-45eb-9a94-e6ff9c959697",
"Parts": "sample string 19",
"FolderId": "df61332a-22c0-4874-9906-3f0308f7be3c",
"ParentId": "91d28848-7488-48fc-b3ba-a105c435c2b3"
}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-02-10T11:12:39.0761105Z",
"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": "482a4e0f-8b96-4fe8-93a6-955bb88c5307",
"targets": "cd8428ab-b167-4d44-a68a-cb880db54d55",
"regionscountries": "a19bd6df-794c-4ff2-9f7f-69fc869045d7",
"stakeholders": "a95cab5f-14a8-4f43-a1f0-d6930bf11f64",
"targetaudiences": "2df95522-8921-4111-9459-cd84f896fe40",
"Category": "e9e782a6-9d69-4485-9909-77fe002cafc1",
"Tags": "0990728e-ceaf-40c5-9445-6078189c24ad",
"departmentaltargets": "2959f070-71f3-495b-81d5-3fdb9e998daa",
"events": "0a9f96c8-83f4-4664-b3a0-a8818ef134c5",
"publishingoffices": "35ca2494-1d0f-4c7e-ada7-0291d31dc619",
"Parts": "sample string 19",
"FolderId": "5e442806-11ef-457d-9553-466398d186e4",
"ParentId": "675207f6-fff3-45f8-84ce-c4d460fb6e5b"
}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.