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-04-17T17:18:34.7781029Z",
"PublicationDate": "2026-04-17T17:18:34.7781029Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-04-17T17:18:34.7781029Z",
"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": "6f7b9be7-d7ce-4367-91b7-845d96fa2824",
"targets": "cff105b8-01ea-449b-862a-779224cf7f14",
"regionscountries": "817427bb-9ccd-4733-a3d2-495e52ac486b",
"stakeholders": "2804b438-9b6e-4ad3-8488-8e677eb6fa00",
"targetaudiences": "a18c802c-cc80-45d6-a164-a5207107c447",
"Category": "0a630f9d-77f4-4738-b7d8-a5ed618c60ad",
"Tags": "6c2041d2-a2b4-4ca8-84ea-cfa085d20061",
"departmentaltargets": "1f9434a8-0a49-494e-9da1-bb427d3946b3",
"events": "f3a53453-f614-40f4-9cee-affb7c6908cb",
"publishingoffices": "8d826345-35fd-4a91-943f-bcdb3a5d5014",
"Parts": "sample string 25",
"FolderId": "02457834-d1ba-4e10-a9d6-8924fd1a4c9b",
"ParentId": "64c209bd-7a96-4429-baf9-894c458e42bb",
"Provider": "sample string 28",
"Url": "sample string 29",
"ThumbnailUrl": "sample string 30",
"IsDamMedia": true
},
{
"LastModified": "2026-04-17T17:18:34.7781029Z",
"PublicationDate": "2026-04-17T17:18:34.7781029Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-04-17T17:18:34.7781029Z",
"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": "6f7b9be7-d7ce-4367-91b7-845d96fa2824",
"targets": "cff105b8-01ea-449b-862a-779224cf7f14",
"regionscountries": "817427bb-9ccd-4733-a3d2-495e52ac486b",
"stakeholders": "2804b438-9b6e-4ad3-8488-8e677eb6fa00",
"targetaudiences": "a18c802c-cc80-45d6-a164-a5207107c447",
"Category": "0a630f9d-77f4-4738-b7d8-a5ed618c60ad",
"Tags": "6c2041d2-a2b4-4ca8-84ea-cfa085d20061",
"departmentaltargets": "1f9434a8-0a49-494e-9da1-bb427d3946b3",
"events": "f3a53453-f614-40f4-9cee-affb7c6908cb",
"publishingoffices": "8d826345-35fd-4a91-943f-bcdb3a5d5014",
"Parts": "sample string 25",
"FolderId": "02457834-d1ba-4e10-a9d6-8924fd1a4c9b",
"ParentId": "64c209bd-7a96-4429-baf9-894c458e42bb",
"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-04-17T17:18:34.7781029Z",
"PublicationDate": "2026-04-17T17:18:34.7781029Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-04-17T17:18:34.7781029Z",
"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": "8205df86-6d1b-4772-9c7d-891641b429ef",
"targets": "21080c51-1be2-4125-a4f9-d9a77205c4c5",
"regionscountries": "aeee3f8a-0d1e-4eef-abc8-a08a8cf9d347",
"stakeholders": "7b2cc000-ef4e-498b-9531-65dcf70f769c",
"targetaudiences": "cb8860e2-f29f-48af-a9c9-bc5cc597a598",
"Category": "cbba2ea1-4623-4154-8eba-f51542d453a9",
"Tags": "24d8b494-6596-4436-ad0e-43c36c837950",
"departmentaltargets": "31bb7d16-effa-45de-8e79-f33f254bc6c1",
"events": "1cb3177f-cc08-4597-a18c-5f8158cfbb50",
"publishingoffices": "4b971a00-8990-49f6-806b-208c1739af88",
"Parts": "sample string 25",
"FolderId": "adef97f4-149d-4409-9449-7f8ddcd452d0",
"ParentId": "36c13993-d3b5-4ef6-958c-cd97a4647ab1",
"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": "445b972b-5380-4a53-b4b0-0919acfbb9c7"
}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-04-17T17:18:34.7781029Z",
"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": "9919dadb-92df-4dc9-a5c1-515f6ed539cd",
"targets": "030b81e3-9632-495f-bf5b-06d267479fe2",
"regionscountries": "a8ab3f78-abbc-4df3-99b5-957244c8559f",
"stakeholders": "3b0994c5-f159-4540-8059-9940526454be",
"targetaudiences": "f2da755e-905f-45bf-a4c5-aa36cd0d3aac",
"Category": "f89ab24a-1679-475c-b40a-7d95311c2427",
"Tags": "d5ff031c-871f-456c-ac46-eecc378ceb29",
"departmentaltargets": "f475d01f-8aad-4e47-b114-375d3bd1930c",
"events": "a538487b-a7b2-46ea-a964-ad220c7a34be",
"publishingoffices": "ef3cfef8-03ee-4d38-9be8-6ffc61c1f8b6",
"Parts": "sample string 19",
"FolderId": "ff98223a-41ae-4839-963a-3aacd93bc86c",
"ParentId": "fb99ffa0-6c00-4a92-9ee5-208e03163e58"
}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-04-17T17:18:34.7781029Z",
"PublicationDate": "2026-04-17T17:18:34.7781029Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-04-17T17:18:34.7781029Z",
"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": "f3e2856f-2d2f-48c5-ba58-d9b923d22867",
"targets": "69852eb1-6d79-46b3-9834-ac49f7e4709b",
"regionscountries": "eaef1e13-fe66-4203-87dd-2663b202786a",
"stakeholders": "8b07e152-0293-4de1-9fbb-05ca03377a6d",
"targetaudiences": "7ddb7476-4559-4128-b8a0-f7c69953b03a",
"Category": "a976ff6b-c530-4d66-8bda-a6e38ff229ec",
"Tags": "8e8c2656-af0d-4cc7-9076-aa84e2fb3e88",
"departmentaltargets": "dc35e87e-bbb8-4a04-b148-99ccd8a65881",
"events": "9578263c-e6a2-4883-8fa9-4d5afc4d4f7e",
"publishingoffices": "01dddf15-ddba-4262-a128-d96d7a4ac305",
"Parts": "sample string 25",
"FolderId": "3900e47f-6e3b-4d5a-9015-06e9765f5016",
"ParentId": "6f5cc9fe-30c9-4539-a8db-2a260ca12161",
"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-04-17T17:18:34.7781029Z",
"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": "e7896fb1-d425-45fb-9e0d-06acd013041e",
"targets": "d126b62f-8d5d-49c6-a088-04e06dbc7f0f",
"regionscountries": "6c15f20e-f0ed-49af-8f24-e57f73a89fdf",
"stakeholders": "4325d1b3-ba15-466a-bebb-0b7d8ac3b997",
"targetaudiences": "a30d7ce4-9db0-4716-9c60-6edae223ad11",
"Category": "db2bf059-c6d4-4411-beae-eb1d07398647",
"Tags": "1b047890-6ba4-48e7-905e-1356454af2f5",
"departmentaltargets": "20e611d0-86bd-41f6-a8d5-7ec066f012b6",
"events": "b08703fd-640b-42a7-8a78-b5571ac8ad79",
"publishingoffices": "f7b1501f-c853-4c29-8320-e87f32543420",
"Parts": "sample string 19",
"FolderId": "0bf9aa96-f58b-48c5-a573-1cca79149134",
"ParentId": "6f5d264c-4a2b-4d63-9cc5-d53cc9ee5be9"
}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-04-17T17:18:34.7781029Z",
"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": "d3d13ef1-58ed-4e95-bfa2-f47448f1a775",
"targets": "064140ee-df8e-43b7-ab24-67c627059c6a",
"regionscountries": "524a0a46-2727-4514-a5a1-25d86ded6925",
"stakeholders": "590f20cb-d9c4-4d2d-b48b-5562eea6f507",
"targetaudiences": "73e2395a-d099-47dc-bc0e-b52c3e72322a",
"Category": "0ac172e6-a6b9-4c44-9e18-e8129716c60f",
"Tags": "25ba29ca-9665-4055-8340-ffb6e825ca80",
"departmentaltargets": "38cb4889-3bdb-46d0-bb88-cfbba6cca427",
"events": "27fd08cd-ac6e-4cc0-b497-9fe18f1c18f1",
"publishingoffices": "636bfa4b-6af2-4677-9cc4-7b568e426b99",
"Parts": "sample string 19",
"FolderId": "b1be510e-2417-48e2-9dc7-5e481fd5e831",
"ParentId": "0c2d4908-9d6b-43ed-aaf1-dd7d605a59c8"
}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.