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-27T16:37:26.5163755Z",
"PublicationDate": "2026-06-27T16:37:26.5163755Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-06-27T16:37:26.5163755Z",
"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": "7486cc89-7e14-4c82-b01a-caeea08308d0",
"targets": "fb07b647-eef5-436d-be1f-79938b26c5c8",
"regionscountries": "053f16f1-b75d-4e05-a7bf-4c830ed4566e",
"stakeholders": "836ba281-01ff-4256-969d-a06bb9109ac1",
"targetaudiences": "dccce02b-76db-4fc4-9e6a-fa599f1dd5f6",
"Category": "8b62288c-274a-419f-8dcc-7e7dc3be1ab4",
"Tags": "86210e63-3fa3-4b9f-accb-1a7c3a1470e3",
"departmentaltargets": "f0eab099-667f-448f-9aed-90be8d4766c6",
"events": "4f465d35-4319-4456-af99-bdbf717f477e",
"publishingoffices": "1affb02b-37e0-403b-a280-0b1a04e18b93",
"Parts": "sample string 25",
"FolderId": "8c95ac2b-d019-4a53-8fba-d9cefad3687f",
"ParentId": "4a33b6e6-639b-43d4-8723-194ebae4e846",
"Provider": "sample string 28",
"Url": "sample string 29",
"ThumbnailUrl": "sample string 30",
"IsDamMedia": true
},
{
"LastModified": "2026-06-27T16:37:26.5163755Z",
"PublicationDate": "2026-06-27T16:37:26.5163755Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-06-27T16:37:26.5163755Z",
"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": "7486cc89-7e14-4c82-b01a-caeea08308d0",
"targets": "fb07b647-eef5-436d-be1f-79938b26c5c8",
"regionscountries": "053f16f1-b75d-4e05-a7bf-4c830ed4566e",
"stakeholders": "836ba281-01ff-4256-969d-a06bb9109ac1",
"targetaudiences": "dccce02b-76db-4fc4-9e6a-fa599f1dd5f6",
"Category": "8b62288c-274a-419f-8dcc-7e7dc3be1ab4",
"Tags": "86210e63-3fa3-4b9f-accb-1a7c3a1470e3",
"departmentaltargets": "f0eab099-667f-448f-9aed-90be8d4766c6",
"events": "4f465d35-4319-4456-af99-bdbf717f477e",
"publishingoffices": "1affb02b-37e0-403b-a280-0b1a04e18b93",
"Parts": "sample string 25",
"FolderId": "8c95ac2b-d019-4a53-8fba-d9cefad3687f",
"ParentId": "4a33b6e6-639b-43d4-8723-194ebae4e846",
"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-27T16:37:26.5320143Z",
"PublicationDate": "2026-06-27T16:37:26.5320143Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-06-27T16:37:26.5320143Z",
"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": "68281ddb-df50-42bc-bb33-c9a502665101",
"targets": "7d67ed83-4b3d-4bd7-a266-9957aeb88da9",
"regionscountries": "b77b6a3b-89c1-4507-9871-6a88cd0a10f4",
"stakeholders": "c2b87627-de8c-4b89-b5d5-90e801a0ebe5",
"targetaudiences": "fe1d6b38-ffcd-4881-bd8e-9c7559678978",
"Category": "fc588499-3270-4622-ace5-9a951cab0b70",
"Tags": "4f3e5e80-b961-4467-8127-d1c0cf098158",
"departmentaltargets": "cd460dd2-5f1e-4e70-9cda-f4b7858eef08",
"events": "d27e71b5-b98d-457a-a927-1a367b6c69d9",
"publishingoffices": "9fee005f-c6e9-4b5e-ba68-66497a386bf6",
"Parts": "sample string 25",
"FolderId": "2cc05fad-4b97-47df-9ac5-93ecbc596ff4",
"ParentId": "86887aa5-865f-4c67-a351-2ad92f108565",
"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": "7aff60a1-5651-4917-83b3-b87a36e89d61"
}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-27T16:37:26.5320143Z",
"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": "026f994e-9e71-485f-a342-825f789cecaf",
"targets": "dd3e2ada-05e4-404a-ba62-92ba646514d7",
"regionscountries": "ce381e17-ce6b-4c34-a0ba-3b5e82f3cd4c",
"stakeholders": "44862d90-4048-453d-ba75-fb5480a61de2",
"targetaudiences": "651f0278-a58c-47bc-9580-d08348f43aaa",
"Category": "0cf1cbd5-db98-48ad-bc4e-7e2db09efe3d",
"Tags": "69867cac-efbb-47ed-b58d-640278164e21",
"departmentaltargets": "670d4135-7824-4037-81f0-96132f8fd893",
"events": "cee8c100-61b1-48ba-8dae-a418e4c19186",
"publishingoffices": "86c38aaa-f9db-44fb-a66a-6ee80c9f92cf",
"Parts": "sample string 19",
"FolderId": "b313ce55-76ee-4adc-97d8-ea81e7a87600",
"ParentId": "3e55c392-9059-44d6-9df5-e66031c8b6c7"
}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-27T16:37:26.5320143Z",
"PublicationDate": "2026-06-27T16:37:26.5320143Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-06-27T16:37:26.5320143Z",
"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": "0dff12a8-0fab-4345-b682-c3bdf804ffd1",
"targets": "4e7aef94-450d-4965-ac2b-6c3f03d822db",
"regionscountries": "bf78d593-72b2-488d-b151-00dcfcfeabd6",
"stakeholders": "238124bc-7542-4e25-ae6b-0d746c980e68",
"targetaudiences": "73a72ff2-6356-4273-be56-710f77cc9e5b",
"Category": "bdabca2a-b49e-4995-b673-490413b63008",
"Tags": "7677ab0f-1981-42d0-9fb0-aea17fd2d1f3",
"departmentaltargets": "007e11bd-b423-48b5-88de-aece643890c3",
"events": "d867cba3-d271-4c5d-acb2-6e3345cc1cb7",
"publishingoffices": "103be7d6-8482-409d-afa9-60d844f99aa1",
"Parts": "sample string 25",
"FolderId": "7d182361-9131-4a24-874a-7a0b7c48e15a",
"ParentId": "071b7af2-843c-42e8-ba74-3117f0d44827",
"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-27T16:37:26.5320143Z",
"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": "4434ebdb-46cb-4905-bf69-be0fdd67ee01",
"targets": "d3415e22-d031-4374-919f-2b2afbe257d8",
"regionscountries": "c50a57b5-a9f9-43fa-98a1-1aab9d7e6465",
"stakeholders": "f25dd5ca-b490-4c41-8766-181d4d88b7e2",
"targetaudiences": "d08fc22f-a39d-4b3c-af0e-4c4256d0b6f7",
"Category": "23623945-0572-4674-b6f6-5d9a4be74e57",
"Tags": "8787dc9a-7410-41ce-b673-495395c155cb",
"departmentaltargets": "21919992-3605-4434-ba6c-e744dff1f482",
"events": "9907cefd-b978-4bd0-ad87-fbbc07128d23",
"publishingoffices": "608eb93a-6195-4797-a82e-0346603930c9",
"Parts": "sample string 19",
"FolderId": "dcd9e491-087f-4d09-90bc-9a221d89cd67",
"ParentId": "3fb94047-b243-4829-8b54-cacf8640fb79"
}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-27T16:37:26.5320143Z",
"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": "903c7168-96fe-49fc-937c-e33b73c2d000",
"targets": "14e43c8c-7382-4090-b027-00816ecff58e",
"regionscountries": "577918dc-3dcf-4e23-a347-07b52d6bdf91",
"stakeholders": "b579592c-1372-4889-b3e0-4deb9c23b386",
"targetaudiences": "b97fced9-20d9-45c1-977e-cd4b4116c52b",
"Category": "0e045e2f-eafe-4e71-9fda-6961d902a0db",
"Tags": "d3ca076e-882c-4c7a-8420-1c243f258426",
"departmentaltargets": "d2fb9eee-cfd9-4dc0-8ee5-dac7836db482",
"events": "06e9247d-e32f-484f-bf2b-b51411ba714d",
"publishingoffices": "2f77ca2c-4b95-44b6-8f70-3febeefb38fe",
"Parts": "sample string 19",
"FolderId": "95514676-53e6-42f1-8652-c32dfc772747",
"ParentId": "17af00fd-0ad9-4731-904e-bca0de365260"
}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.