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-09T06:45:26.6321382Z",
"PublicationDate": "2026-01-09T06:45:26.6321382Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-01-09T06:45:26.6321382Z",
"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": "ae3385d6-ecf8-41ae-b504-bce737bff037",
"targets": "a4b13502-196e-4356-97ff-ca071bf1a351",
"regionscountries": "633b7975-921e-4af7-afe5-c05f0355f402",
"stakeholders": "1d0034ab-beb1-4323-9e22-d5c828d96f38",
"targetaudiences": "4878ce8a-6445-4cd8-8700-7d03d9d67d52",
"Category": "74c86295-6889-4cee-9f26-7268822724af",
"Tags": "fe20de9c-54cb-4035-8340-1e363c87010e",
"departmentaltargets": "acb2f8f3-44c7-42e2-82ad-0120aaa53775",
"events": "771a7b58-f8f5-4242-aa8c-6762fa6b7995",
"publishingoffices": "346f4db1-e28e-46e0-bb4f-955f2de42aab",
"Parts": "sample string 25",
"FolderId": "5c1fac04-1124-4e8c-ae5b-186bd828b2ab",
"ParentId": "b6d3249d-359f-48b1-8202-4c56b1d61914",
"Provider": "sample string 28",
"Url": "sample string 29",
"ThumbnailUrl": "sample string 30",
"IsDamMedia": true
},
{
"LastModified": "2026-01-09T06:45:26.6321382Z",
"PublicationDate": "2026-01-09T06:45:26.6321382Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-01-09T06:45:26.6321382Z",
"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": "ae3385d6-ecf8-41ae-b504-bce737bff037",
"targets": "a4b13502-196e-4356-97ff-ca071bf1a351",
"regionscountries": "633b7975-921e-4af7-afe5-c05f0355f402",
"stakeholders": "1d0034ab-beb1-4323-9e22-d5c828d96f38",
"targetaudiences": "4878ce8a-6445-4cd8-8700-7d03d9d67d52",
"Category": "74c86295-6889-4cee-9f26-7268822724af",
"Tags": "fe20de9c-54cb-4035-8340-1e363c87010e",
"departmentaltargets": "acb2f8f3-44c7-42e2-82ad-0120aaa53775",
"events": "771a7b58-f8f5-4242-aa8c-6762fa6b7995",
"publishingoffices": "346f4db1-e28e-46e0-bb4f-955f2de42aab",
"Parts": "sample string 25",
"FolderId": "5c1fac04-1124-4e8c-ae5b-186bd828b2ab",
"ParentId": "b6d3249d-359f-48b1-8202-4c56b1d61914",
"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-09T06:45:26.6321382Z",
"PublicationDate": "2026-01-09T06:45:26.6321382Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-01-09T06:45:26.6321382Z",
"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": "e637ab11-f076-47c7-a76f-e3d576cdea3c",
"targets": "1fcb9724-16dd-4230-a6f6-5910e47529d6",
"regionscountries": "9da94189-051a-4946-8bcb-0a2e45acb516",
"stakeholders": "9107aa2b-2fdf-496b-a6fd-cf0d06af91b2",
"targetaudiences": "5590d1eb-dbf4-4ffd-9f39-15730459262c",
"Category": "1ee66462-71eb-4bc7-b009-937268327b61",
"Tags": "580439b0-0dd2-4a9b-9534-ef19573bb482",
"departmentaltargets": "7727b3a0-6b24-49e1-a2ee-f2ce2d85f3ac",
"events": "c53a7804-12a7-4f34-a5d1-4c0e3c136ae6",
"publishingoffices": "67deee32-825e-41d9-9cb8-ea4e0aec0a29",
"Parts": "sample string 25",
"FolderId": "505dc3b5-a859-4c55-9a66-f5b4c56f952b",
"ParentId": "f4ed7f9e-a5c8-4533-a06f-08bff7535b60",
"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": "5b3378c2-331f-4c65-a7f1-e6e0858a7f9b"
}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-09T06:45:26.6321382Z",
"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": "ffb34c7c-e371-40e2-b11b-891749615a26",
"targets": "a8aa975f-9cc7-46f3-b836-82575be829fd",
"regionscountries": "f8e331a8-00ef-4baf-b939-df301ef35525",
"stakeholders": "490afe1d-3306-476e-8cb2-98ca89636f6e",
"targetaudiences": "968f1331-dc9b-4c10-bdf3-1fd33d2992fb",
"Category": "41516190-8d8c-449f-b203-cad471b9f821",
"Tags": "b0a89047-4c26-4e78-84c1-ddb56b7b3cfa",
"departmentaltargets": "b91499b6-d735-4089-bf18-6e1821e15aad",
"events": "974be945-cf9c-4a68-837e-f86a122b53b4",
"publishingoffices": "4069d3c1-6ffe-4714-bc74-485f82935d9a",
"Parts": "sample string 19",
"FolderId": "5661d168-f4e1-4f0f-9c54-7114a016f9a4",
"ParentId": "0dd06e18-72df-4016-bfae-d9a98f2dcf3c"
}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-09T06:45:26.6321382Z",
"PublicationDate": "2026-01-09T06:45:26.6321382Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2026-01-09T06:45:26.6321382Z",
"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": "fa9f841e-4781-4adb-b1b1-b54d7dd4e370",
"targets": "a30d637c-20ac-43c5-a913-3da33a774dfc",
"regionscountries": "43917382-7420-4299-92d3-40955156a34a",
"stakeholders": "d86b9b6f-6ffd-4245-b07a-199f629ba44c",
"targetaudiences": "ac597c49-81cf-4c3d-bb9a-005dc0bb0110",
"Category": "f5b9c5b5-df71-4b98-b1da-6b13c20748eb",
"Tags": "31d54e57-8e91-47cf-b501-2351c029b0fd",
"departmentaltargets": "5fce0c21-7b76-459b-8d69-c6bee67ee2ea",
"events": "c39c789e-1bb6-4272-927d-b0f83d6d6b5c",
"publishingoffices": "94519408-ff15-47b3-949b-8630fe30f896",
"Parts": "sample string 25",
"FolderId": "8184fb60-b5f5-4af1-83a0-969ab9e0cd13",
"ParentId": "111b346e-d1e6-4c36-9b7e-65e46cc3ebaa",
"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-09T06:45:26.6321382Z",
"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": "32f2892b-2847-492a-ad44-8dc9895c4909",
"targets": "2231d107-173a-469f-a127-cc24d9201388",
"regionscountries": "4144da11-1c79-47be-84b1-18cf66b76145",
"stakeholders": "f61d10dc-1064-4392-9cff-2d1a37dceeb6",
"targetaudiences": "ad0ff592-ca56-4ed1-ab02-496ebf867ac6",
"Category": "318b63de-1a1d-4998-8a70-7b53af33d9b4",
"Tags": "0fc9a4a4-b01a-4a3f-8b92-18de6ac4f7ea",
"departmentaltargets": "0c626114-2653-4700-8e2c-d82362d2a59f",
"events": "1f4b0b13-3b0f-49c4-9eef-9305c036df60",
"publishingoffices": "66882e75-6ed9-4606-9036-59fe9f958e73",
"Parts": "sample string 19",
"FolderId": "34969cb6-5811-4666-b9e4-ae82b321054a",
"ParentId": "ab82e693-9b17-4f8b-898e-40cd5cf50c48"
}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-09T06:45:26.6321382Z",
"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": "ab06668d-7ad0-4671-9a76-8e7d4a2b62aa",
"targets": "92fb8626-8d67-4fe0-b7c5-abffb73f72a3",
"regionscountries": "ac4aebab-a2b6-4977-b3c8-1073f4299684",
"stakeholders": "2ccde507-333e-4604-b331-897148333273",
"targetaudiences": "2764ce4b-05b8-4de1-a4dc-6ad7dc24162c",
"Category": "d3ac7d8b-09f0-4193-aad3-3c318afa547a",
"Tags": "c0c1a88a-9cf2-453c-94d4-e8bf99faac82",
"departmentaltargets": "6dae8b1b-2698-4d0a-81d1-05ef526c6311",
"events": "148d2478-b4c4-451a-afe3-0b06087a2886",
"publishingoffices": "5d1004d9-b5c1-44b1-964c-beff012cd494",
"Parts": "sample string 19",
"FolderId": "64871286-31be-4a52-aa84-0833ad0d929b",
"ParentId": "0da3857a-d86d-4370-928d-1b940ab9747f"
}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.