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 | |
| JoomlaArticleId | System.String | 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-10-14T01:34:44.0864674Z",
"PublicationDate": "2026-10-14T01:34:44.0864674Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-10-14T01:34:44.0864674Z",
"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": "d63a6149-6252-468f-a533-c2166947eb0b",
"targets": "972fb8dc-8a58-4009-9992-2d9faf5359fd",
"regionscountries": "e9b241c3-a50e-4297-804e-9ba75d7cb52e",
"stakeholders": "7946f039-f86f-4334-b9d6-cad2381b6a81",
"targetaudiences": "81e2764b-f0c0-4db0-81e4-a3e9e59a5d95",
"JoomlaArticleId": "sample string 20",
"Category": "d47f8d2e-d88c-4196-bc1e-892a59c320ba",
"Tags": "b1372821-2cf5-41e4-80e5-b6cc5035b97d",
"departmentaltargets": "75059211-61c2-46ea-8067-d05cb1d702b1",
"events": "2ca7209b-0ebd-487e-9785-03f841f0ac4c",
"publishingoffices": "7818ba0f-df4f-4932-beef-b1a2fbd24c8d",
"Parts": "sample string 26",
"FolderId": "8f1f4604-2e14-4092-808c-a266cf976812",
"ParentId": "d24da309-320f-4629-af3d-5fed4a1a675c",
"Provider": "sample string 29",
"Url": "sample string 30",
"ThumbnailUrl": "sample string 31",
"IsDamMedia": true
},
{
"LastModified": "2026-10-14T01:34:44.0864674Z",
"PublicationDate": "2026-10-14T01:34:44.0864674Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-10-14T01:34:44.0864674Z",
"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": "d63a6149-6252-468f-a533-c2166947eb0b",
"targets": "972fb8dc-8a58-4009-9992-2d9faf5359fd",
"regionscountries": "e9b241c3-a50e-4297-804e-9ba75d7cb52e",
"stakeholders": "7946f039-f86f-4334-b9d6-cad2381b6a81",
"targetaudiences": "81e2764b-f0c0-4db0-81e4-a3e9e59a5d95",
"JoomlaArticleId": "sample string 20",
"Category": "d47f8d2e-d88c-4196-bc1e-892a59c320ba",
"Tags": "b1372821-2cf5-41e4-80e5-b6cc5035b97d",
"departmentaltargets": "75059211-61c2-46ea-8067-d05cb1d702b1",
"events": "2ca7209b-0ebd-487e-9785-03f841f0ac4c",
"publishingoffices": "7818ba0f-df4f-4932-beef-b1a2fbd24c8d",
"Parts": "sample string 26",
"FolderId": "8f1f4604-2e14-4092-808c-a266cf976812",
"ParentId": "d24da309-320f-4629-af3d-5fed4a1a675c",
"Provider": "sample string 29",
"Url": "sample string 30",
"ThumbnailUrl": "sample string 31",
"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 | |
| JoomlaArticleId | System.String | 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-10-14T01:34:44.0864674Z",
"PublicationDate": "2026-10-14T01:34:44.0864674Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-10-14T01:34:44.0864674Z",
"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": "e17dde84-4f74-4a6f-8774-9cbfab5a8315",
"targets": "38cc5b94-1809-4d05-88e0-14e509bf57fc",
"regionscountries": "86b97610-ead5-4ffc-ab3b-203cc5845b8f",
"stakeholders": "0b2329c9-4569-49e0-8c99-ae6272ad3989",
"targetaudiences": "0114a34c-de98-4e1c-88c3-95a8bceffb84",
"JoomlaArticleId": "sample string 20",
"Category": "201ab57e-df5e-4f52-8105-ff1eb215bb0e",
"Tags": "76218b27-d247-4ee1-8289-25c05eeb66e7",
"departmentaltargets": "ccd8dedb-cfc6-4629-bf2f-8e8d4490bb90",
"events": "ea343b9d-4b6f-4527-9b76-d7d69a26060e",
"publishingoffices": "c82e678c-0ba8-47d6-a104-c0e76ba6c726",
"Parts": "sample string 26",
"FolderId": "5ed73b5b-ff5a-443a-8541-8d3951f69a8d",
"ParentId": "a1a4e860-d19d-410f-b35d-931e7b8db1ab",
"Provider": "sample string 29",
"Url": "sample string 30",
"ThumbnailUrl": "sample string 31",
"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": "4e5f9a94-76e2-4b5b-a718-3a70eaa22e75"
}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 | |
| JoomlaArticleId | System.String | 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-10-14T01:34:44.0864674Z",
"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": "5f5ed1a8-5f5a-4b55-94d8-43cd590adf21",
"targets": "4f85eebe-9e10-483c-b3d6-6bcd82b8183f",
"regionscountries": "ae356b12-f417-4b67-acb3-20208576a29a",
"stakeholders": "aa67215a-d01c-4d3f-a5fd-78cc22ea4fc6",
"targetaudiences": "3637e211-e9bc-4924-b292-a8c1f7151c1e",
"JoomlaArticleId": "sample string 14",
"Category": "d23ee856-6a2a-4efd-bc40-ffe8917908df",
"Tags": "d499af2b-34e3-4e9c-b195-b783c950338d",
"departmentaltargets": "6b05fd1d-edd3-4dee-b9b4-18a090bf174a",
"events": "e21c919c-15ae-44d1-996e-ca3b8aa1740d",
"publishingoffices": "6ef4eeb2-ddd6-49d9-9a24-215d1e67fcca",
"Parts": "sample string 20",
"FolderId": "092146ae-701d-44ff-b763-c18e66248fb1",
"ParentId": "819c7ac4-35ea-4e56-abea-5a9e92bab26e"
}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 | |
| JoomlaArticleId | System.String | 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-10-14T01:34:44.0864674Z",
"PublicationDate": "2026-10-14T01:34:44.0864674Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-10-14T01:34:44.0864674Z",
"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": "db0a7f18-7073-43ba-9db0-55df744d3a0a",
"targets": "01b24578-88ab-4d87-bf65-893d0c740e1c",
"regionscountries": "33345fd4-fe90-4554-9997-32c15e845d62",
"stakeholders": "fa4ed087-496b-424a-a29c-42a1f752beb0",
"targetaudiences": "141d52e5-65b1-4872-bfba-e921ba7d6d06",
"JoomlaArticleId": "sample string 20",
"Category": "6686b674-e638-4563-96eb-f369f40d646e",
"Tags": "78200300-21e3-418d-acfa-1c74a96558a7",
"departmentaltargets": "6f7ae1ab-3cba-435c-b2d6-5ccf55b82a86",
"events": "b55597b2-45e8-43c6-8c6b-41fa734d117a",
"publishingoffices": "5d82ecfb-2246-45d1-8498-71ca206bb1b4",
"Parts": "sample string 26",
"FolderId": "7bd9ef90-e5c4-40ea-afae-a976df821aeb",
"ParentId": "276d7421-395c-48cf-b7c7-e7c5668c2f09",
"Provider": "sample string 29",
"Url": "sample string 30",
"ThumbnailUrl": "sample string 31",
"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 | |
| JoomlaArticleId | System.String | 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-10-14T01:34:44.0864674Z",
"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": "830e01c8-4cf6-47c5-9177-25c3fe13e697",
"targets": "eeba3725-2b09-464c-ba9f-7cde9fe8887f",
"regionscountries": "6a17fde7-d87a-4116-ad0a-8cd34bfe7668",
"stakeholders": "0101fc54-d107-4c39-8916-47f3b88544f4",
"targetaudiences": "e478d768-9792-4569-a32c-a1eb5a738e83",
"JoomlaArticleId": "sample string 14",
"Category": "32e78b2c-292c-45dd-bdb0-43468cd37df6",
"Tags": "15f8a09d-cb44-4f17-9ae1-40ef3dd2bce9",
"departmentaltargets": "5e7535be-edae-4bb7-b1fe-27a383eebe02",
"events": "46e78dd4-b8e3-4127-98d0-ab07877f37fe",
"publishingoffices": "c233911a-21d9-4428-892c-11463f18d521",
"Parts": "sample string 20",
"FolderId": "7e21ef19-c374-4e51-a87c-7641342784d9",
"ParentId": "af8915d6-8764-4281-8e69-5a22111df355"
}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 | |
| JoomlaArticleId | System.String | 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-10-14T01:34:44.0864674Z",
"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": "0ba67f26-8aca-4e64-a018-5c07418964cd",
"targets": "e613e868-3ae3-4eaf-b3a1-2008efbe0761",
"regionscountries": "199e86b2-7933-4cd4-97ed-7cfc278a68c8",
"stakeholders": "0ce9531f-d756-427e-96b6-3c2c7a14374c",
"targetaudiences": "56c3506a-3375-4462-9848-03b6e245a305",
"JoomlaArticleId": "sample string 14",
"Category": "7d936cf3-e94f-486e-b15a-dc2f7647c890",
"Tags": "ac4a4705-6017-4ca6-bf09-6f93e7f10463",
"departmentaltargets": "774cebda-738f-4a6a-8a0e-c7344fbb91d1",
"events": "18b7b0de-7d75-4147-ad4e-8f8d356d01a3",
"publishingoffices": "98636c5d-6e57-46c6-8ec1-d51c13a72b96",
"Parts": "sample string 20",
"FolderId": "acaa0824-4188-46ee-b0f9-49f63828ef29",
"ParentId": "19936f93-5721-4f04-ac01-93ab3a8fd52e"
}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.