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-01-09T09:20:41.0079538Z",
"PublicationDate": "2026-01-09T09:20:41.0079538Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-01-09T09:20:41.0079538Z",
"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": "932eb5ce-00fa-4725-b7f9-0cd62f0170f3",
"targets": "c4325216-0fdf-4cf9-986e-4c7362358a21",
"regionscountries": "49611a43-6d24-4b2c-963c-4e78c53306f4",
"stakeholders": "9ea1019a-e59d-42d8-b2f1-92023aeff0b6",
"targetaudiences": "58770754-039a-4980-a474-72c7f1d83479",
"Category": "ed6bfab2-a290-4ae8-9a4d-dbf466535c0b",
"Tags": "742607c8-759b-4b34-88f3-a12d598a990c",
"departmentaltargets": "b594b67c-bdc8-477c-a17f-99bcc1b02e5a",
"events": "1529a1f6-3d4d-4940-81ce-a7b348392a5b",
"publishingoffices": "6e752699-7887-4c93-93ca-8962a6f07b13",
"Parts": "sample string 25",
"FolderId": "643e1c43-473e-4827-adf3-c085f2ac315c",
"ParentId": "fb9e163a-a46f-4b37-bc49-5572fcd3260b",
"Provider": "sample string 28",
"Url": "sample string 29",
"ThumbnailUrl": "sample string 30",
"IsDamMedia": true
},
{
"LastModified": "2026-01-09T09:20:41.0079538Z",
"PublicationDate": "2026-01-09T09:20:41.0079538Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-01-09T09:20:41.0079538Z",
"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": "932eb5ce-00fa-4725-b7f9-0cd62f0170f3",
"targets": "c4325216-0fdf-4cf9-986e-4c7362358a21",
"regionscountries": "49611a43-6d24-4b2c-963c-4e78c53306f4",
"stakeholders": "9ea1019a-e59d-42d8-b2f1-92023aeff0b6",
"targetaudiences": "58770754-039a-4980-a474-72c7f1d83479",
"Category": "ed6bfab2-a290-4ae8-9a4d-dbf466535c0b",
"Tags": "742607c8-759b-4b34-88f3-a12d598a990c",
"departmentaltargets": "b594b67c-bdc8-477c-a17f-99bcc1b02e5a",
"events": "1529a1f6-3d4d-4940-81ce-a7b348392a5b",
"publishingoffices": "6e752699-7887-4c93-93ca-8962a6f07b13",
"Parts": "sample string 25",
"FolderId": "643e1c43-473e-4827-adf3-c085f2ac315c",
"ParentId": "fb9e163a-a46f-4b37-bc49-5572fcd3260b",
"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-01-09T09:20:41.0079538Z",
"PublicationDate": "2026-01-09T09:20:41.0079538Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-01-09T09:20:41.0079538Z",
"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": "2b74907f-d0bb-4e79-8030-3a08f1ec460d",
"targets": "276b27a7-8894-4c36-b2b5-b9ae8c5e8bd6",
"regionscountries": "21d32ab3-c847-46c3-b374-05a7a17bfbae",
"stakeholders": "8f156120-37fa-444d-b47e-ff18fbec7849",
"targetaudiences": "f146383a-241e-486b-8436-22c10a1ad539",
"Category": "c7bc9edc-6c16-42fb-b9dc-4062b68dcb25",
"Tags": "0a8afeab-073e-461d-9e86-7b9e42611faf",
"departmentaltargets": "f4338e22-dbd2-4f85-aa63-bb3ca848721d",
"events": "1cf8c23c-cda7-463a-9143-7d67250e5ef1",
"publishingoffices": "e837d5a5-30fd-46bd-8cfa-b4598ada4d28",
"Parts": "sample string 25",
"FolderId": "1aa65add-390b-42ab-8342-922714d27857",
"ParentId": "be937a9e-e73c-45b5-9fda-5a2faf4b9967",
"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": "2d23a765-5951-40eb-9cce-1b4eac770e52"
}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-01-09T09:20:41.0079538Z",
"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": "c01f485a-adb2-4203-8f31-4a90a239d45f",
"targets": "244e9674-8e9f-4b8c-a29e-70d0714712f8",
"regionscountries": "4c5b7c18-cc9c-4de5-9f10-6080ab693cbc",
"stakeholders": "1e42b3ff-b46c-4007-b7ba-357f5736faf1",
"targetaudiences": "fb9d98e6-55cf-4cc1-b14c-2ae18112e360",
"Category": "ed6dff64-2a93-4c46-bce9-bc9728931c7d",
"Tags": "8107b4cd-797c-4f46-8d0b-f5473e7d21f3",
"departmentaltargets": "4b82d46c-c1f0-445c-a029-7b810cbe65e9",
"events": "4235af6c-e0d1-407c-9501-27746d3d9e71",
"publishingoffices": "ee86c82f-5b27-43bc-8f85-c4ff38bf8a37",
"Parts": "sample string 19",
"FolderId": "c5d7705d-9a8a-48ca-be4d-032d5d51e0d1",
"ParentId": "6c869284-67e9-4ca6-b4ee-667aa37cb92d"
}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-01-09T09:20:41.0079538Z",
"PublicationDate": "2026-01-09T09:20:41.0079538Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-01-09T09:20:41.0079538Z",
"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": "e6983e6a-69f6-485b-a8cb-f4c8a0dc84b9",
"targets": "8387d20e-bc32-4f93-9bfb-af724aa9976b",
"regionscountries": "bc6948d2-c543-4873-91d3-eb69def3185a",
"stakeholders": "cc53cfd5-334d-4353-99c4-f32ab2b88430",
"targetaudiences": "c3e05f5d-ac89-4bcb-b7be-6189d9637c49",
"Category": "592d7b29-019e-422e-86ab-c1474ee05ef0",
"Tags": "aecbcaff-0cab-442d-b76b-9b2c516e6c16",
"departmentaltargets": "db93ad27-7bc8-4851-b457-9e5e394500e2",
"events": "5c9070db-9b9c-48c6-b193-1b2680a29f47",
"publishingoffices": "4a5d5f88-b424-431f-8a52-1a53cfe5eee0",
"Parts": "sample string 25",
"FolderId": "97dfa646-5fd9-4fa3-b050-b9e8911d41c3",
"ParentId": "d7cf3725-245f-46ca-8c7f-811edd982242",
"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-01-09T09:20:41.0079538Z",
"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": "be02d10c-43e2-40a5-94c1-cc265784b64e",
"targets": "57c9c01d-7040-4478-8f63-de0827ae3245",
"regionscountries": "c1a65b18-cd53-468f-aff9-56c714e26d6f",
"stakeholders": "1798001c-6fe3-4a5f-bc0f-f00e12617975",
"targetaudiences": "e57024d6-6464-4e01-b900-f0b3bdb121be",
"Category": "366be2ab-8e1f-4ac5-9914-498da232a8b7",
"Tags": "90761dd2-f065-4bdd-a348-bcc728124d40",
"departmentaltargets": "21db4f65-e7ac-4e32-bfb2-36626acd094d",
"events": "1a2b62c3-d8be-4847-b3fb-1da772d02fde",
"publishingoffices": "c406563e-3563-4a3c-9ef6-9042b270a1a7",
"Parts": "sample string 19",
"FolderId": "990352af-63ed-48ad-913f-48d128db2861",
"ParentId": "821c7415-8b8d-42f3-847f-b6b092f4cd20"
}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-01-09T09:20:41.0079538Z",
"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": "576d6148-096d-4ed1-b154-6e76206e42fd",
"targets": "0dda5313-7136-4b5d-b932-a568a19e4201",
"regionscountries": "1f4bd1ae-b9bf-46f0-a3c7-dba0ba71e932",
"stakeholders": "9ede81a8-8f5b-4c57-9c5d-c1a06a27106b",
"targetaudiences": "d6f23e00-1f5c-4664-ac50-687ef970edeb",
"Category": "0d81e874-f670-4db1-95a8-3c2b0328a89d",
"Tags": "01eab5a5-30b5-49c8-a09d-9324f6ac3035",
"departmentaltargets": "78dce6e3-8c9f-44d7-977b-916c88de69b8",
"events": "1f5a4684-ea5d-42cf-a02b-831ad59aa149",
"publishingoffices": "6ace6f11-0822-4f64-a192-cded3d1cdd0d",
"Parts": "sample string 19",
"FolderId": "0b5292ab-5e44-466e-bfdb-911b8f36f9b3",
"ParentId": "078aa346-3039-499b-9f4b-c7ffe3e63b84"
}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.