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-10T15:00:05.0064611Z",
"PublicationDate": "2026-02-10T15:00:05.0064611Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-02-10T15:00:05.0064611Z",
"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": "cbc1e854-8e34-4b32-ab3a-e9c61927fa2d",
"targets": "239edc97-7574-4223-b788-952b3ae966b8",
"regionscountries": "b803735c-8ea3-4e60-9ee6-1abe046cec51",
"stakeholders": "a54f0764-8ae9-4d44-8301-32b9fdf43b01",
"targetaudiences": "a72a43e3-490c-439a-a14f-8d1871d24c01",
"Category": "f08a6e89-f443-4fe7-912a-1a1e3710c7ec",
"Tags": "41a4c3c6-af40-4569-9f43-15f4120cb576",
"departmentaltargets": "41a6af80-a068-405d-94fc-aac604e62a25",
"events": "27513f49-b715-4f24-a747-1329c43197dd",
"publishingoffices": "0ac1bc30-9a56-4448-80f6-9fe5e362eafc",
"Parts": "sample string 25",
"FolderId": "14efdc1c-1295-443d-a9d1-009791070d55",
"ParentId": "7ef75e4a-268c-44b4-89f0-c10b4d4860c4",
"Provider": "sample string 28",
"Url": "sample string 29",
"ThumbnailUrl": "sample string 30",
"IsDamMedia": true
},
{
"LastModified": "2026-02-10T15:00:05.0064611Z",
"PublicationDate": "2026-02-10T15:00:05.0064611Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-02-10T15:00:05.0064611Z",
"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": "cbc1e854-8e34-4b32-ab3a-e9c61927fa2d",
"targets": "239edc97-7574-4223-b788-952b3ae966b8",
"regionscountries": "b803735c-8ea3-4e60-9ee6-1abe046cec51",
"stakeholders": "a54f0764-8ae9-4d44-8301-32b9fdf43b01",
"targetaudiences": "a72a43e3-490c-439a-a14f-8d1871d24c01",
"Category": "f08a6e89-f443-4fe7-912a-1a1e3710c7ec",
"Tags": "41a4c3c6-af40-4569-9f43-15f4120cb576",
"departmentaltargets": "41a6af80-a068-405d-94fc-aac604e62a25",
"events": "27513f49-b715-4f24-a747-1329c43197dd",
"publishingoffices": "0ac1bc30-9a56-4448-80f6-9fe5e362eafc",
"Parts": "sample string 25",
"FolderId": "14efdc1c-1295-443d-a9d1-009791070d55",
"ParentId": "7ef75e4a-268c-44b4-89f0-c10b4d4860c4",
"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-10T15:00:05.0064611Z",
"PublicationDate": "2026-02-10T15:00:05.0064611Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-02-10T15:00:05.0064611Z",
"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": "35d8fbf4-f913-4b60-b336-5b9b1399b305",
"targets": "9878b8e4-3952-499e-b40a-355a3aa28281",
"regionscountries": "275275f4-952a-40e3-a040-0bd7acb4c0ad",
"stakeholders": "dd3dae22-c01b-4975-aa5e-6d00b691cd56",
"targetaudiences": "a6065d36-90d8-4dfd-a465-42256f4a4f58",
"Category": "a95271df-e93e-456c-8cf0-20cd1824e924",
"Tags": "30f75c18-4231-496b-ac2c-9b536fb99671",
"departmentaltargets": "3820a269-c2b7-4d48-934e-9b51fbd7bf13",
"events": "49e3d566-04de-487d-aeab-69a32ef946b6",
"publishingoffices": "c4c6c60d-1fc1-4ed2-856a-d22cd62781f9",
"Parts": "sample string 25",
"FolderId": "51a44df1-b50f-401a-bdcf-3f0ffef99df1",
"ParentId": "40db7d81-5fd1-47f1-8889-bc3866caf19c",
"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": "703f41ea-713f-4fef-b90a-dcb203da181e"
}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-10T15:00:05.0064611Z",
"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": "ffd2d18c-53d4-4a60-9c1c-1eb4b9483db0",
"targets": "92c02073-f9e6-4b59-bfde-d138804d63bf",
"regionscountries": "48e2b869-8eaa-4263-a583-45db828fb08b",
"stakeholders": "b018bf8d-d5a7-474e-9ffb-187b616b3729",
"targetaudiences": "6c9060ca-fdba-41ac-9227-00e1ef6d0e5e",
"Category": "5150e8f5-879d-4e17-8ed2-4782b6686a5b",
"Tags": "b3c47975-06da-473f-9818-99cd1c0a2a43",
"departmentaltargets": "dcf412da-e241-42d9-a68d-3b1ea86122a5",
"events": "54a248a1-3037-4244-923a-c9bf97679c78",
"publishingoffices": "3756d04f-a517-43d4-837c-1e859294ecf7",
"Parts": "sample string 19",
"FolderId": "d49163af-0ed3-4547-8728-f78b4f7662b7",
"ParentId": "f1caeff8-4e5e-4d16-ad45-7b1e9e5b61cb"
}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-10T15:00:05.0064611Z",
"PublicationDate": "2026-02-10T15:00:05.0064611Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-02-10T15:00:05.0064611Z",
"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": "0e79c6a7-618d-4962-bf98-ca879bc90bd7",
"targets": "4081016a-2431-4be1-939c-d6b5520175dc",
"regionscountries": "544d3244-3dd3-4b43-9ccd-bf47453c90f8",
"stakeholders": "9bd38fa4-f310-48b5-907d-f9f3c96b4a7b",
"targetaudiences": "bfdfb824-da59-4bac-9ab8-609bfc33f234",
"Category": "73342ea3-2d56-4f6e-bd6e-33a6808835b3",
"Tags": "ba4ba5b1-3981-4bc4-b52a-301fa531b756",
"departmentaltargets": "879f2a6b-1899-4f30-84de-fdcefe78477b",
"events": "017188c8-809e-4f07-84c7-aca441308d2d",
"publishingoffices": "28753747-5865-487e-b56a-7ad69261df94",
"Parts": "sample string 25",
"FolderId": "742e327b-12a6-438e-a5c6-ffd94f338a35",
"ParentId": "7dd4fceb-38b2-4ad0-a1a0-cbb804ae9499",
"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-10T15:00:05.0064611Z",
"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": "a1cd5517-5ff8-443f-9817-8d6c1b6e2ea6",
"targets": "04c48a9d-fd00-4aec-aaa2-e5a53d604a63",
"regionscountries": "4b7e5a7f-1695-4932-8377-c6ac8ffa40e1",
"stakeholders": "bbcdd406-ab8b-4515-9c28-ba11b88e526a",
"targetaudiences": "ea5c1df7-acba-4eaa-ae3b-5ba6658a2184",
"Category": "e9ccc35d-7274-4813-b78a-ccaf4cfd1487",
"Tags": "d0cbec0d-6cba-4161-b99a-8348a5b47853",
"departmentaltargets": "933b4c7e-6589-4c55-a05d-626093499b89",
"events": "97360327-e74e-4f19-9569-09a4fec45e6f",
"publishingoffices": "2f3a5b69-851c-4bc5-b0ba-91f301118758",
"Parts": "sample string 19",
"FolderId": "bb308cfd-5941-4b14-9700-414b7bb4cf95",
"ParentId": "81208394-2cb1-40b3-87e1-36f2d053dd72"
}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-10T15:00:05.0064611Z",
"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": "5ebd1f33-a065-4577-88b8-0b7d8892232d",
"targets": "58c90705-dc8e-42db-bc3d-b3ff83fb2cad",
"regionscountries": "3c41fb9a-697c-4bc0-8747-a9c27ca7eded",
"stakeholders": "344d8f4d-bd78-46ba-bc88-6b9f5ac02b3f",
"targetaudiences": "bf32d50a-0284-44de-8441-402d8743cb10",
"Category": "007f6127-c4d3-43fb-a3b7-099fb291afcd",
"Tags": "c4a954ed-8cf2-456a-a5bb-4da909400b04",
"departmentaltargets": "27270fe3-662d-4144-877b-4cbcc00902ac",
"events": "dad97685-d2c5-41eb-aa98-e7ac25ecbc31",
"publishingoffices": "0438745e-d54f-4f75-8cee-0a6a38d809e4",
"Parts": "sample string 19",
"FolderId": "57e5c092-4611-4897-a35f-58a3ae204a2c",
"ParentId": "3ff7c1d0-41fd-485e-ad8c-c610a5ff414b"
}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.