Table of contents

Schema: homepage

Frontend schema

This schema describes the content item that is returned from the content store.

analytics_identifier
string or null
A short identifier we send to Google Analytics for multi-valued fields. This means we avoid the truncated values we would get if we sent the path or slug of eg organisations.
base_path
string
A path only. Query string and/or fragment are not allowed.
content_id
string

content_purpose_document_supertype
string
DEPRECATED. Use `content_purpose_subgroup`.
content_purpose_subgroup
string
Document subgroup grouping documents by purpose. Narrows down the purpose defined in content_purpose_supergroup.
content_purpose_supergroup
string
Document supergroup grouping documents by a purpose
description
or null

details
object
change_history
array

document_type
string

Allowed values: homepage, service_manual_homepage
email_document_supertype
string
Document supertype grouping intended to power the Whitehall finders and email subscriptions
first_published_at
or null

government_document_supertype
string
Document supertype grouping intended to power the Whitehall finders and email subscriptions
links
object
available_translations
Link type automatically added by Publishing API
child_taxons
Link type automatically added by Publishing API
children
Link type automatically added by Publishing API
document_collections
Link type automatically added by Publishing API
level_one_taxons
Link type automatically added by Publishing API
part_of_step_navs
Link type automatically added by Publishing API
policies
Link type automatically added by Publishing API
policy_areas
A largely deprecated tag currently only used to power email alerts.
related_to_step_navs
Link type automatically added by Publishing API
topic_taxonomy_taxons
Link type automatically added by Publishing API
locale
string

Allowed values: ar, az, be, bg, bn, cs, cy, de, dr, el, en, es, es-419, et, fa, fr, he, hi, hu, hy, id, it, ja, ka, ko, lt, lv, ms, pl, ps, pt, ro, ru, si, sk, so, sq, sr, sw, ta, th, tk, tr, uk, ur, uz, vi, zh, zh-hk, zh-tw
navigation_document_supertype
string
Document type grouping powering the new taxonomy-based navigation pages
need_ids
array

phase
string
The service design phase of this content item - https://www.gov.uk/service-manual/phases
Allowed values: alpha, beta, live
public_updated_at
or null

publishing_app
string
The application that published this item.
Allowed values: calculators, calendars, collections-publisher, contacts, content-publisher, content-tagger, email-alert-frontend, external-link-tracker, feedback, frontend, hmrc-manuals-api, info-frontend, licencefinder, manuals-frontend, manuals-publisher, maslow, performanceplatform-big-screen-view, policy-publisher, publisher, rummager, search-admin, service-manual-publisher, share-sale-publisher, short-url-manager, smartanswers, specialist-publisher, static, tariff, travel-advice-publisher, whitehall
publishing_request_id
A unique identifier used to track publishing requests to rendered content
publishing_scheduled_at
or null

rendering_app
string
The application that renders this item.
Allowed values: calculators, calendars, collections, email-alert-frontend, email-campaign-frontend, feedback, finder-frontend, frontend, government-frontend, info-frontend, licencefinder, manuals-frontend, performanceplatform-big-screen-view, publicapi, rummager, service-manual-frontend, smartanswers, spotlight, static, tariff, whitehall-admin, whitehall-frontend
scheduled_publishing_delay_seconds
or null

schema_name
string

Allowed values: homepage
search_user_need_document_supertype
string
Document supertype grouping core and government documents
title
string

updated_at
string

user_journey_document_supertype
string
Document type grouping powering analytics of user journeys
user_need_document_supertype
string
DEPRECATED. Use `content_purpose_document_supertype`.
withdrawn_notice
object
explanation
string

withdrawn_at

View this schema on GitHub

Random example

{
  "analytics_identifier": null,
  "base_path": "/96c140bb-6f59-4bf3-ad0f-9f3dfe038aef/4e172723-8ded-42e3-92f7-d1f372af8d74/8a69a001-4a2b-4767-9ce6-c73dab373412",
  "content_id": "a1012a24-426f-4f9a-85fa-9da43386fb15",
  "content_purpose_document_supertype": "sagittis tempor in, suscipit Nam consectetur purus turpis sit amet, adipiscing tristique Mauris hendrerit, Lorem ultricies lectus vel Nam non eros. a molestie leo volutpat nibh. est. pellentesque Pellentesque dolor aliquet. sem orci massa Suspendisse finibus, risus mauris ac porttitor ac Ut tristique interdum. risus cursus interdum. eu ac libero. sed netus scelerisque. imperdiet egestas. Sed vel dolor nisl ac Aenean Ut vestibulum. fames bibendum. nibh malesuada habitant eu at sollicitudin lorem",
  "content_purpose_supergroup": "sed Mauris Aenean et libero. tempor consectetur nisl leo finibus, eu sem eros. Pellentesque tristique lectus pellentesque molestie dolor risus tristique",
  "description": "cursus vestibulum. mauris turpis nibh sagittis sit eu habitant sed ultricies egestas. bibendum. netus ac malesuada Lorem ac Sed elit. ac imperdiet suscipit leo in, Mauris vel Nam molestie tristique finibus, Duis scelerisque. tristique eu Ut est. tempor adipiscing libero. vel nibh. ipsum nisl risus sollicitudin pellentesque orci tempor eros. et massa Pellentesque fames senectus purus morbi sem interdum. aliquet. Nam consectetur volutpat",
  "details": {
    "change_history": [
      {
        "note": "sit nibh purus est. tristique sollicitudin cursus non nibh. leo scelerisque. sem mauris dolor Lorem tristique in, bibendum. lectus molestie Nam Ut ultricies sagittis Pellentesque Duis amet, netus sed vestibulum. a molestie adipiscing eu senectus ac libero. Mauris risus interdum. risus ipsum hendrerit, finibus, vel et at ac Nam eu elit. massa egestas. Suspendisse malesuada turpis nisl lorem interdum. habitant ac non Ut porttitor vel tempor Aenean Quisque et consectetur tempor dolor Sed ac imperdiet",
        "public_timestamp": "2018-09-07T17:29:04+00:00"
      },
      {
        "note": "hendrerit, habitant ipsum eu scelerisque. sed adipiscing dolor Aenean Ut volutpat massa et sollicitudin Duis vestibulum. amet, eu Suspendisse bibendum. leo eros. fames sem at nibh. Sed ac purus vel tempor ac non sit vel tristique Mauris senectus suscipit in, orci nisl Ut pellentesque porttitor Nam ac cursus tristique consectetur risus finibus, est. ac libero. egestas. imperdiet Nam molestie a et interdum. mauris Lorem dolor",
        "public_timestamp": "2018-08-10T04:52:10+00:00"
      },
      {
        "note": "sollicitudin morbi Ut Ut Pellentesque imperdiet vel dolor non ultricies libero. tempor tristique malesuada Duis ac Quisque tempor in, ac tristique molestie nibh. scelerisque. lorem netus sit ac risus sed volutpat lectus risus sagittis Lorem ipsum sem adipiscing massa fames aliquet. vestibulum. at eu nisl amet, senectus leo pellentesque eros. elit. Nam purus orci mauris hendrerit, ac",
        "public_timestamp": "2018-07-18T19:13:50+00:00"
      }
    ]
  },
  "document_type": "service_manual_homepage",
  "email_document_supertype": "Ut Nam non Aenean dolor adipiscing Sed hendrerit, interdum. vestibulum. ac non pellentesque porttitor Lorem Quisque mauris aliquet. orci interdum. et morbi ipsum purus tristique massa tristique ac volutpat risus elit. eu sed habitant sollicitudin netus nisl cursus fames scelerisque. ac molestie turpis tempor suscipit est. senectus bibendum. libero. imperdiet vel eros. sagittis dolor sem consectetur egestas. sit Nam malesuada at risus molestie lectus nibh. lorem vel finibus, et a eu leo Ut ac nibh Pellentesque Mauris Duis amet, ultricies in, Suspendisse",
  "first_published_at": "2018-09-02T19:41:22+00:00",
  "government_document_supertype": "orci vestibulum. vel egestas. molestie et a risus ipsum in, Duis tristique volutpat hendrerit, tristique consectetur ultricies adipiscing scelerisque. habitant libero. Sed ac",
  "links": {
    "document_collections": [
      {
        "api_path": "/3f72b3e2-668c-41e5-90f8-a1ebbe2707f1/fa0b9bf6-ab6f-44bd-b27e-ae6b28b9c586/70d89635-c6d9-4fa5-969c-565f5e70a1ff/050af085-1796-4dac-8e3c-c0592420ff76/66cb7ce9-8034-4778-887d-450860a651a3",
        "api_url": "http://example.com/686521d2-e0aa-4e68-918a-300ed3148f97/7ba44406-7712-48ac-8d4d-469e62a58121#41de8576b8e79ab8d66bd846a36fc3b6",
        "base_path": "/e252747e-62f1-412c-9652-e6929909a73c/6c2c4e13-8d98-44a4-b3d4-3699c4fa0e5a/462f4eb0-2183-4e7d-bfd6-38c08cc8ffbf/6c4ab88e-3e17-4eba-87be-b0e2e68d215d",
        "content_id": "a9fcf63d-856e-46f9-8140-bf63ec26caca",
        "links": {
        },
        "locale": "th",
        "title": "ipsum malesuada massa sollicitudin est. risus ac egestas. dolor dolor ac senectus eu sed"
      },
      {
        "analytics_identifier": null,
        "api_path": "/deb6dbf9-f124-4971-93fe-36d0f39181aa",
        "api_url": "http://example.com/d2935014-2abd-491c-8825-482237fce1e3#bb3e8a71d32949f4c5f2abe995e83788",
        "base_path": "/2e5dfd72-4532-4079-85a2-9c569f2f99dc/a45ca519-2457-4d08-b95f-51d482bc0379/7222b446-bc30-4369-a27e-a90dc6e307b1",
        "content_id": "5f45645e-2456-4bc9-ba7d-1b51eb88caec",
        "document_type": "ac sem sollicitudin purus risus Aenean imperdiet Pellentesque Suspendisse molestie scelerisque. vel et pellentesque non Ut Mauris lorem ac elit. lectus sagittis habitant a sit massa turpis ac Duis tempor nibh. et est. hendrerit, bibendum. nibh netus Lorem Nam eros. tempor Sed ipsum ac aliquet. leo tristique adipiscing non amet, porttitor ultricies fames vestibulum. risus volutpat dolor senectus dolor sed libero. interdum. at molestie morbi nisl tristique cursus suscipit mauris",
        "links": {
        },
        "locale": "he",
        "public_updated_at": "2018-08-04T10:34:30+00:00",
        "title": "nibh risus Sed finibus, Quisque sagittis Nam non malesuada in, turpis lectus leo et senectus tempor non et Duis volutpat elit."
      },
      {
        "api_path": "/74f256a2-781e-4bea-b117-b019e3b25fa1/1d85b2da-edf9-4c0d-9b05-50ae6c569380/19aea58c-0f82-41cb-a6e2-e33642e24a35",
        "api_url": "http://example.com/4fa63619-f9e0-41d9-95aa-3cc8ef7a0b44/15b9d41d-2794-46f3-8417-23deaaf77f80#500e67c060ec2f337cf529c09c2f59bd",
        "base_path": "/799cd24e-d704-4510-8329-53815b991c65/2c2f8bfc-de15-4a71-baa6-db15b0c0383f",
        "content_id": "4e20eafe-c6f3-46e4-a053-5d7299410d81",
        "links": {
        },
        "locale": "ms",
        "schema_name": "mauris ipsum cursus porttitor sed habitant morbi nibh in, sollicitudin Nam vestibulum. tristique interdum. ac interdum. Suspendisse libero. turpis et leo est. finibus, orci eros. Ut suscipit sagittis nibh. scelerisque. netus vel Mauris pellentesque elit. ac purus lectus Quisque lorem dolor aliquet. vel tempor risus molestie sem et Lorem malesuada a non at ac dolor eu Aenean bibendum. non egestas. senectus molestie fames ac nisl risus tristique massa sit Pellentesque hendrerit, ultricies consectetur tempor amet, imperdiet Sed volutpat eu Duis Nam Ut adipiscing",
        "title": "aliquet. porttitor tristique molestie finibus, nisl elit. tempor libero. suscipit Aenean senectus scelerisque. vestibulum. mauris sed vel lorem pellentesque Suspendisse ac in, est. imperdiet dolor turpis Nam a hendrerit, Pellentesque ac ac Lorem malesuada et nibh. interdum. sagittis bibendum. fames risus sem risus non dolor Duis interdum. nibh at orci volutpat ipsum sollicitudin Sed vel tristique Ut cursus habitant Quisque tempor massa ultricies adipiscing non consectetur morbi"
      },
      {
        "api_url": "http://example.com/942ae3c9-abdb-4bc2-ad57-775360656b62/5dcbde8e-aca3-4969-ae32-61538251e052/3e0a3e07-6ddf-4435-8fa4-af5520eafa29/4bad25db-dccc-4705-9723-4e1420f65481#a842935e7082c308181d47a8410a89b2",
        "base_path": "/d04b8adc-b0a3-4415-b579-5c712405e7ce/d873051f-2ed4-45af-a505-a27653e0a35c/6c05a929-8388-4874-8fcb-b1bb37d0af59",
        "content_id": "3a84678b-9cab-430a-b01d-b78da9ab3f79",
        "document_type": "ac",
        "links": {
        },
        "locale": "fr",
        "title": "ac sem sollicitudin sagittis vestibulum. dolor lectus eu a Pellentesque Mauris vel non eros. tempor scelerisque. imperdiet leo pellentesque lorem aliquet. massa vel dolor at porttitor morbi Suspendisse ac molestie risus est. molestie senectus Ut eu Ut Duis Nam risus elit. ipsum in, cursus fames ac nisl netus amet, nibh. purus turpis Lorem habitant Quisque suscipit malesuada consectetur ultricies tristique ac interdum. egestas. hendrerit, tristique non bibendum. sed sit Aenean Sed orci Nam libero. et interdum. finibus, mauris et tempor adipiscing nibh volutpat",
        "web_url": "http://example.com/5163a2a5-e4b7-40ad-b9ca-e01e3aee1d37/8af3c2a0-2c38-4edf-887c-fb72c823dd29/eee18ae9-6a1f-405c-8ed0-8e1b557a3a36/b2acabd3-7cb3-4afb-9940-27e9f587fe87/327fc39a-ef36-46a4-857d-27105c681fc9#08cab7684b5a97dde90c4177af11e854"
      },
      {
        "analytics_identifier": "non sagittis purus in, amet, est. aliquet. sollicitudin at molestie tempor sit fames bibendum. ac massa vel et suscipit Pellentesque vestibulum. nibh. orci Sed nisl Nam et lorem Duis scelerisque. tristique risus Lorem habitant imperdiet senectus adipiscing elit. cursus nibh Ut lectus vel interdum. Mauris volutpat Aenean libero. turpis hendrerit, ac non eu pellentesque Ut leo ipsum tristique dolor ultricies a finibus, Quisque ac mauris dolor molestie malesuada tempor morbi netus porttitor sed Suspendisse consectetur sem eros. eu Nam risus interdum. ac egestas.",
        "api_path": "/a10e4dac-6f4f-4457-8545-c0824e8db2b9/7da8abdc-12f9-4eaa-b5b7-1ff2951c5de0/230fcff9-34cb-4428-b843-e9f9efc336d9/92b00310-7414-43e7-a87d-fbb4eab83c6c",
        "base_path": "/c5d1f266-1d43-49b9-b4f3-81e89544f402/f1fa6524-c381-4a21-a05b-c5a481456615",
        "content_id": "085f1f0f-ef5c-4137-854c-0b664d3eaab1",
        "document_type": "turpis volutpat purus adipiscing ac est. suscipit vel bibendum. massa porttitor tempor malesuada vel Duis lorem libero. imperdiet senectus mauris sit ipsum tristique Quisque elit. egestas. a Nam morbi Mauris habitant non interdum. sed pellentesque sem leo eros. fames et ac Ut Nam Sed risus tempor risus",
        "locale": "hu",
        "public_updated_at": null,
        "title": "sed ultricies imperdiet risus vestibulum. porttitor nibh. Nam non volutpat malesuada nibh Lorem eros. aliquet. ac Suspendisse pellentesque cursus Nam eu Mauris egestas. at ipsum Duis Pellentesque interdum. libero. vel bibendum. senectus Ut habitant vel sagittis nisl netus Quisque fames tempor dolor lorem sem",
        "web_url": "http://example.com/dff0028a-8c33-4ef2-97f4-122ba8b3eb75/445efdb4-b1e4-4763-a38f-d91b60b522a8/c90fd205-3bb2-41d0-a567-69eaa7b05f97#762b1fc68ace04780274ed741b6d2658"
      },
      {
        "analytics_identifier": null,
        "api_path": "/a6b0d881-1e4a-48c5-a48f-91a74ac509a1/dd6b6c29-6095-4396-9eef-76994f170658",
        "api_url": "http://example.com/d952a68c-f0da-40da-b9bb-191cd05b8b85/1436f573-6bc3-4f52-a035-f39a89af85c9#b7f8fe93f9503c14702d1a6539395f79",
        "base_path": "/b85680f6-b4ca-4a0a-8c8a-f7da3c92df98/8042fad6-0e48-46ea-b8d7-22766d04d81f/9984f282-87b6-4a4a-b69d-85d4e9aab66c/e43d8c7c-1db1-4522-a60b-44cb38780718",
        "content_id": "986145e1-cd91-4c3c-a010-9c2d896a2c08",
        "links": {
        },
        "locale": "fa",
        "schema_name": "ac consectetur egestas. vel imperdiet ipsum massa Mauris Sed libero. orci nisl tristique interdum. a et et tempor molestie netus tempor malesuada lorem dolor leo habitant suscipit nibh. sem mauris fames ac scelerisque. Suspendisse adipiscing eu sagittis hendrerit, ac Aenean lectus est. Lorem sed Nam dolor vestibulum. tristique purus bibendum. non Ut sit nibh non senectus Pellentesque ac risus aliquet. turpis vel Quisque eu volutpat elit. finibus, molestie interdum.",
        "title": "finibus, aliquet. Nam"
      },
      {
        "api_path": "/9c8c807e-de69-45aa-bfff-839c75b16101/b1ce7555-82a1-482d-8411-aa52af2f4b16/5122d777-0f21-45cd-8731-fa1a7cdaf85a/abdd1388-e06e-46f2-b79c-4b53aab8cd4b/c86fde38-afb4-4b95-a9ec-fd05dcd0d877",
        "api_url": "http://example.com/a258d582-6f7b-4687-9144-4e7dcec690ec/23a99492-6939-4f01-9b94-31a3c1595853/0e3ca0a4-c072-4233-a2ea-8a3f0c456a11#a1e90f3b0551a1b8bd93ffc7d0bd48d2",
        "base_path": "/e911fbf8-95f9-453d-b4ac-712add927817/3f326f60-3940-40bf-93a4-28d7efbb3c43/d7641c63-7942-4cdb-9064-7c3cfb04d408/cde45255-a0d6-4ee9-899b-49efe269a94f/b4277a6b-f0cc-4836-b8af-cd342650e9c6",
        "content_id": "c60d6351-e1ad-4fc1-adc5-75f07bb1365c",
        "locale": "zh-hk",
        "schema_name": "est. molestie interdum. vestibulum. at sed Quisque nibh. ipsum leo vel Sed mauris ac eu orci ac non nisl purus netus Ut fames nibh eros. amet, sit Aenean libero. sollicitudin scelerisque. interdum. lorem elit. tempor vel lectus risus senectus volutpat risus morbi cursus Nam pellentesque Mauris adipiscing tristique dolor a egestas. non ultricies",
        "title": "ultricies tempor cursus tempor turpis lorem bibendum. Suspendisse malesuada amet, ac vestibulum. in, ipsum Pellentesque sed eu scelerisque. Ut netus ac Nam senectus ac vel elit. Aenean porttitor pellentesque risus non interdum. finibus, egestas. est. consectetur tristique at purus Ut nibh suscipit mauris et risus et dolor ac eu non dolor lectus imperdiet habitant a fames interdum. volutpat nisl tristique hendrerit, sagittis nibh. morbi Mauris Sed sem eros. Duis aliquet. libero. orci Lorem Nam sit leo adipiscing vel Quisque massa sollicitudin molestie molestie"
      },
      {
        "api_path": "/b3cc36df-b520-4925-83a7-7729f4f00178",
        "api_url": "http://example.com/410a6479-ca00-46c8-abda-a1e562bce027/1b1d846c-1ff6-429f-ac60-232222637a6f/73e221ba-3e8e-4103-9656-824956bcd2ec/5806fb4a-61fb-4f8f-8a66-66fa61d7dbea#a75dc2aee1459ad931d6c6375b7e9b40",
        "base_path": "/c30eeb14-e40b-47a8-8f88-54667e4b6bcf/74859bbe-75c6-4efe-a2cf-968b7077874d/4ccc3169-8c35-42af-a209-406b2bd07ff6/d7c5496f-7d15-4049-9a93-4a490626ca5a",
        "content_id": "74c1fcdd-777e-489f-aa66-3ec7dd988d11",
        "locale": "uz",
        "public_updated_at": null,
        "title": "habitant in, lectus bibendum. molestie turpis libero. leo egestas. cursus imperdiet risus a tristique massa tempor malesuada orci tristique molestie tempor nibh. sollicitudin netus senectus hendrerit, nisl Nam sed ac adipiscing Pellentesque elit. Lorem Nam sagittis est. dolor eu lorem aliquet. Ut risus purus amet, nibh ac vel Ut suscipit volutpat consectetur sit vel scelerisque. ac ipsum eu fames et ultricies mauris eros. interdum. sem at Aenean pellentesque interdum. morbi Duis ac Mauris Sed non Quisque",
        "web_url": "http://example.com/63869363-2ebc-478d-843c-d9709caae3a9/edcc8638-09b5-41d5-95a2-82e620dd869b/cf2e234d-3055-4799-9f5d-48aca5ea2d53#483d2e5ad3bb5498b9424108004e2b26"
      }
    ],
    "level_one_taxons": [
      {
        "analytics_identifier": null,
        "api_url": "http://example.com/8f0b0385-2e08-4059-b159-2f1d8355031f/bbcac93b-8f0e-4e10-892c-1d51c5110413#f97a320c4e1b4bfdce1f740ed6d5b1d4",
        "base_path": "/6877c784-cfdd-4683-ba16-629f335f98ff",
        "content_id": "50813ec0-ba24-41d6-86be-d18983ee08bb",
        "locale": "uz",
        "public_updated_at": null,
        "title": "eros. fames interdum. vestibulum. ultricies est. nibh. consectetur non tempor libero. egestas. porttitor et Ut bibendum. Suspendisse elit. risus sem dolor Nam lorem Aenean lectus malesuada turpis non pellentesque finibus, cursus leo adipiscing sit massa Sed eu tristique mauris scelerisque. Mauris Nam interdum. Quisque aliquet. vel morbi nisl imperdiet molestie at molestie ac Pellentesque Lorem ac eu netus senectus suscipit purus volutpat habitant Ut sagittis a hendrerit, et in, sed ac Duis amet, tempor ipsum sollicitudin vel risus ac nibh orci tristique dolor",
        "web_url": "http://example.com/afb93b23-2665-4f9d-95e4-91e30fa65ed0/0474dc0c-718a-455e-96c5-4a93077f7f2b/c62fa1a1-15be-4a99-b125-c913740af852#02af9efd51d7baaed7c043fab60d0f84"
      },
      {
        "api_path": "/bd293889-9fb1-4cfa-94ea-80500fe84019/47bf9830-47d0-44fa-8a85-07dc83ca0f80/d01d7fd6-3f72-434e-b748-bce68092dbd3/2822321f-c781-4b3c-b4fd-ac0568b68ce4",
        "api_url": "http://example.com/23c69aec-e3cf-40c3-b0ba-9c0e07559fec#9962569ff70937461a69f59592c76abc",
        "base_path": "/6bd4fd2d-dc02-4558-beb3-724bbff9c11c/9a835d18-4fd8-4a09-ae59-2fa300f7704f",
        "content_id": "ba32b10a-686c-44a8-88e0-74b4d3ed4bd8",
        "document_type": "sed leo malesuada netus Ut Ut sagittis lectus Pellentesque Duis dolor ipsum ac suscipit in, Lorem eros. turpis ac et Aenean consectetur fames habitant ac sit mauris massa sollicitudin tempor finibus, et eu a tempor nibh. Suspendisse risus vel non dolor Nam ultricies imperdiet pellentesque adipiscing Mauris orci vestibulum. Quisque morbi tristique Nam vel est. lorem sem hendrerit, egestas. ac bibendum. molestie Sed amet, nibh risus scelerisque. tristique non molestie volutpat interdum. elit. eu at porttitor senectus purus interdum. cursus nisl libero. aliquet.",
        "links": {
        },
        "locale": "lv",
        "public_updated_at": "2018-07-22T11:38:41+00:00",
        "schema_name": "tempor Duis pellentesque nisl ac Nam Mauris tristique volutpat morbi elit. risus vestibulum. sagittis bibendum. tempor aliquet. tristique vel egestas. finibus, non eros. ac imperdiet amet, nibh. adipiscing scelerisque. hendrerit, lorem Pellentesque vel nibh sed suscipit dolor Aenean Nam Sed at interdum. est. risus in, leo",
        "title": "leo Lorem nibh. habitant in, aliquet. sollicitudin non eu et tristique dolor egestas. lectus et porttitor Ut Quisque lorem Mauris eros. consectetur hendrerit, nisl molestie Duis scelerisque. interdum. ipsum Aenean Pellentesque non sed elit. orci eu Nam sit molestie Ut sem dolor vestibulum. finibus, adipiscing sagittis suscipit ac"
      },
      {
        "api_path": "/f2549558-046e-4bf6-927b-55b59f9114b1/f6f4179c-c438-4a84-9315-c70e147cf0e5/f5ea1e47-f9c6-4236-8e0f-c7e2b9026be4/449eaf9d-edb9-4f7c-9e41-a7898d4ee034/b8e36c4e-dd3b-489b-94cc-9cb19a47bd90",
        "api_url": "http://example.com/deac2016-1284-4b9f-a866-51f8c73c46b6/31f9bd47-410c-4483-88f1-fec531a6aca9#b9a3d57513955d9a45c4842dea33ded3",
        "base_path": "/9f2ecae7-5b0f-4d4c-a4d2-d9b738faf235/e1ea9060-4160-48cc-8cd1-97ad02add998/02a6f9e0-92cb-428a-a6c5-6058c62e236e/dcdab807-3bb4-4b88-9995-ccf005c0e729",
        "content_id": "1cb3ad3f-fda4-4a93-82e9-8f6f66163a95",
        "locale": "vi",
        "public_updated_at": "2018-09-02T08:21:45+00:00",
        "schema_name": "bibendum. elit. tristique libero. eu vel aliquet. dolor et orci volutpat mauris malesuada ipsum Ut nisl",
        "title": "Aenean et ipsum Nam turpis vel sollicitudin tristique eu interdum. porttitor nibh adipiscing tristique libero. vel Suspendisse orci ac eros. egestas. Pellentesque massa vestibulum. hendrerit, eu ac fames Ut volutpat ac sagittis non suscipit risus nibh. mauris finibus, ac habitant dolor amet, Sed netus in, pellentesque malesuada Duis imperdiet lorem morbi purus molestie est. cursus tempor nisl a ultricies at Ut Mauris non tempor Lorem interdum. sem scelerisque. et risus dolor lectus senectus leo molestie bibendum. consectetur Quisque elit. sit Nam aliquet. sed",
        "web_url": "http://example.com/cd0a8af5-68d4-459d-a87f-38dbe609f8cc#517c15bf1d15c40b9d69380ba38f055c"
      },
      {
        "api_url": "http://example.com/41a25b01-0179-400d-9a4c-ec43e0ce26c8/efb98a53-8ca7-48cb-9c85-07e2477c0da1/8ff32354-8d82-45ab-bfe3-a2f86a3243a6/fc35955e-050b-45f8-8b25-9388767eb80b/14a2a048-64a7-4c24-b441-f57241b7aeb6#f059fb05607e3c786c79a7650092e040",
        "base_path": "/1d61446e-aa66-40a7-9927-a46c87429fb9/e3e3a542-c78e-4a9e-b2c5-49fa9dd03de9/4dcb0a03-7d68-4ecc-b061-3cb5409f60c8",
        "content_id": "d338fefa-f671-4d76-a1f8-f4e62d56b2f8",
        "links": {
        },
        "locale": "en",
        "schema_name": "et adipiscing",
        "title": "scelerisque. ac elit. tristique sollicitudin est. at tempor tempor nibh consectetur cursus non libero. ac interdum. dolor ac eros. vestibulum. lorem vel ac malesuada molestie Quisque ultricies Sed tristique purus turpis Aenean suscipit Pellentesque orci Nam adipiscing risus Mauris leo dolor Nam eu risus amet, a",
        "web_url": "http://example.com/d046729f-c842-48b1-8eee-6230ee220a49/e875188e-fc99-4b70-96f8-38c7df924d42/8a3768ea-ab45-400f-98c6-f7eed0e722ef/46fa226e-aadc-49ed-a14d-19bdeb3c97aa/d239638b-d647-4c48-9667-756ef7f02b87#ea7ae7de992494691bc5c1ef1357af0b"
      }
    ],
    "policies": [

    ]
  },
  "locale": "he",
  "navigation_document_supertype": "eros. ipsum non Ut est. Lorem porttitor interdum. tristique lectus sit Sed sed ac eu Suspendisse purus orci fames senectus Nam in, malesuada nisl mauris nibh. massa leo ac aliquet. ac Nam Duis bibendum. vel Mauris adipiscing eu risus hendrerit, imperdiet",
  "need_ids": [
    "elit. nibh. risus cursus imperdiet ac libero. consectetur lorem risus Nam interdum. et ipsum vestibulum. lectus sollicitudin adipiscing Pellentesque purus morbi amet, sed orci et turpis tempor leo mauris finibus, non molestie Aenean ac Ut nisl Ut non dolor pellentesque massa Quisque ac suscipit tristique malesuada habitant eros. senectus dolor vel porttitor hendrerit, fames eu netus vel sem molestie"
  ],
  "phase": "alpha",
  "public_updated_at": null,
  "publishing_app": "feedback",
  "publishing_request_id": null,
  "scheduled_publishing_delay_seconds": 6,
  "schema_name": "homepage",
  "title": "risus morbi habitant ac ultricies eu egestas. adipiscing dolor vel cursus bibendum. orci purus eros. molestie libero. nibh. est. Pellentesque ac interdum. finibus, sagittis Nam pellentesque ipsum ac tempor sed suscipit tempor senectus vestibulum. aliquet. Sed Nam et Mauris leo nisl et interdum. sollicitudin Duis a elit. netus eu tristique scelerisque. Aenean volutpat sem",
  "updated_at": "2018-08-10T16:45:00+00:00",
  "user_journey_document_supertype": "Mauris sed Nam dolor eros. massa ac pellentesque vestibulum. purus nibh lectus ac tristique elit. ultricies suscipit eu a turpis Nam egestas. et est. interdum. et non Lorem amet, vel at Quisque Aenean orci dolor interdum. tristique lorem Suspendisse Pellentesque non molestie aliquet. Ut ipsum hendrerit, risus Sed finibus, mauris in, Duis adipiscing tempor sem vel senectus imperdiet porttitor leo nisl risus volutpat bibendum. eu molestie cursus netus sollicitudin habitant morbi sit libero. malesuada consectetur sagittis ac Ut tempor ac scelerisque. fames nibh.",
  "user_need_document_supertype": "netus libero. massa adipiscing tempor nisl interdum. purus fames suscipit morbi ac Ut ultricies egestas. volutpat mauris turpis Duis nibh. hendrerit, Lorem leo senectus lectus orci Pellentesque et sem habitant eu vel ac molestie tempor bibendum. vestibulum. sed imperdiet cursus in, eu lorem vel non Quisque pellentesque molestie consectetur sagittis at Mauris interdum. dolor Nam scelerisque. elit. Sed risus finibus, porttitor non ac est. Aenean dolor Nam a amet, ipsum tristique Ut ac aliquet. tristique sit et Suspendisse eros. sollicitudin risus nibh malesuada"
}

Publisher content schema

This is what publisher apps should send to the publishing-api in This is what a publishing application sends to the publishing-api in a put_content call.

Attributes

access_limited
object
auth_bypass_ids
A list of ids that will allow access to this item for non-authenticated users
users
array

analytics_identifier
string or null
A short identifier we send to Google Analytics for multi-valued fields. This means we avoid the truncated values we would get if we sent the path or slug of eg organisations.
base_path
string
A path only. Query string and/or fragment are not allowed.
change_note
["null", "string"]

description
or null

details
object
document_type
string

Allowed values: homepage, service_manual_homepage
first_published_at
string
The date the content was first published. Automatically determined by the publishing-api, unless overridden by the publishing application.
last_edited_at
string
Last time when the content received a major or minor update.
links
object
policy_areas
A largely deprecated tag currently only used to power email alerts.
locale
string

Allowed values: ar, az, be, bg, bn, cs, cy, de, dr, el, en, es, es-419, et, fa, fr, he, hi, hu, hy, id, it, ja, ka, ko, lt, lv, ms, pl, ps, pt, ro, ru, si, sk, so, sq, sr, sw, ta, th, tk, tr, uk, ur, uz, vi, zh, zh-hk, zh-tw
need_ids
array

phase
string
The service design phase of this content item - https://www.gov.uk/service-manual/phases
Allowed values: alpha, beta, live
previous_version
string

public_updated_at
string
When the content was last significantly changed (a major update). Shown to users. Automatically determined by the publishing-api, unless overridden by the publishing application.
publishing_app
string
The application that published this item.
Allowed values: calculators, calendars, collections-publisher, contacts, content-publisher, content-tagger, email-alert-frontend, external-link-tracker, feedback, frontend, hmrc-manuals-api, info-frontend, licencefinder, manuals-frontend, manuals-publisher, maslow, performanceplatform-big-screen-view, policy-publisher, publisher, rummager, search-admin, service-manual-publisher, share-sale-publisher, short-url-manager, smartanswers, specialist-publisher, static, tariff, travel-advice-publisher, whitehall
redirects
array

rendering_app
string
The application that renders this item.
Allowed values: calculators, calendars, collections, email-alert-frontend, email-campaign-frontend, feedback, finder-frontend, frontend, government-frontend, info-frontend, licencefinder, manuals-frontend, performanceplatform-big-screen-view, publicapi, rummager, service-manual-frontend, smartanswers, spotlight, static, tariff, whitehall-admin, whitehall-frontend
routes
array

schema_name
string

Allowed values: homepage
title
string

update_type

Allowed values: major, minor, republish

View this schema on GitHub

Random example

{
  "analytics_identifier": "adipiscing Quisque tempor molestie Sed Pellentesque Nam turpis aliquet. Lorem Ut tristique massa amet, molestie fames hendrerit, risus est. sed senectus",
  "base_path": "/a01e9404-f657-428e-a560-b58552541034",
  "change_note": "tempor elit. eu tristique interdum. at nisl Sed non a dolor ac vel sem lectus Duis ac porttitor sagittis Nam Suspendisse tristique mauris tempor leo volutpat libero. sit Nam Pellentesque habitant risus in, eros. hendrerit, amet, nibh senectus ac Ut Mauris lorem et netus aliquet. morbi et ac ipsum massa imperdiet cursus dolor est. Ut vestibulum. bibendum. turpis nibh. sollicitudin adipiscing interdum. ultricies molestie orci fames molestie malesuada finibus, vel Quisque risus non sed Lorem scelerisque.",
  "details": {
  },
  "document_type": "homepage",
  "first_published_at": "2018-08-06T23:27:49+00:00",
  "links": {
    "policy_areas": [
      "f6abf8ad-44f0-4eb0-b8b2-5850da63a1dd",
      "ecc22bfc-a042-455f-a0c0-bf0877485921"
    ]
  },
  "locale": "pl",
  "public_updated_at": "2018-07-29T11:49:42+00:00",
  "publishing_app": "hmrc-manuals-api",
  "redirects": [
    "non et egestas. orci Aenean dolor libero. vel ac senectus Sed ultricies cursus Suspendisse vestibulum. turpis finibus, lectus eros. tempor amet, molestie sagittis ac",
    "suscipit vel sem dolor sit est. hendrerit, purus sed ipsum Suspendisse interdum. molestie dolor finibus, molestie Ut ac Ut lorem Sed Nam imperdiet vel libero. morbi tempor risus leo et interdum. ac ac eros. Nam volutpat senectus amet, tristique non ultricies tempor bibendum. fames a at massa non in, Duis ac nibh adipiscing sagittis consectetur eu porttitor sollicitudin netus vestibulum. Aenean turpis elit. aliquet. eu orci nibh. tristique et egestas. nisl mauris Quisque lectus Lorem habitant Pellentesque pellentesque scelerisque. risus cursus Mauris malesuada",
    "sagittis tristique Nam Duis adipiscing sed habitant pellentesque bibendum. cursus eros. est. eu ultricies nibh. Nam",
    "volutpat senectus Nam Mauris fames habitant et leo turpis nisl ac nibh amet, est. netus Ut ipsum finibus, suscipit tempor aliquet. ac malesuada vel egestas. dolor eros. bibendum. Ut nibh. morbi at a elit. dolor Quisque tristique sollicitudin orci sed cursus hendrerit, pellentesque imperdiet et",
    "elit. eros. aliquet. Mauris ultricies tristique Quisque amet, vestibulum. ac lorem adipiscing dolor vel in, cursus lectus sem vel ac sagittis leo a massa imperdiet risus volutpat ac Suspendisse et Sed Nam dolor bibendum. turpis molestie consectetur interdum. nibh.",
    "morbi leo imperdiet molestie sagittis turpis vel at egestas. bibendum. risus nisl fames et tempor non scelerisque. Sed Suspendisse ac consectetur sollicitudin vel Lorem Aenean risus pellentesque interdum. ac vestibulum. aliquet. purus Pellentesque Mauris ipsum Ut in,",
    "molestie scelerisque. porttitor imperdiet malesuada Lorem Ut purus Quisque Nam pellentesque mauris dolor Duis hendrerit, a tempor tristique risus ultricies ac massa et vestibulum. elit. sed non finibus, ipsum in, orci libero. ac Suspendisse egestas. tristique nisl vel senectus",
    "scelerisque. suscipit in, Quisque sed Ut sagittis risus nibh. eu Nam habitant imperdiet lorem tristique vel leo sem fames vestibulum. purus egestas. Nam Suspendisse ac ultricies aliquet. adipiscing lectus pellentesque interdum. sollicitudin vel Sed et nibh netus risus tristique Pellentesque dolor massa senectus Lorem Aenean molestie et Duis ac volutpat malesuada interdum. eu eros. sit bibendum. Mauris porttitor morbi elit. ac tempor libero. molestie ac a non consectetur hendrerit, at amet, orci ipsum turpis mauris nisl non est. tempor cursus dolor finibus, Ut"
  ],
  "rendering_app": "email-campaign-frontend",
  "routes": [
    {
      "path": "et dolor elit. amet, pellentesque morbi nisl Mauris ipsum Sed fames interdum. lorem purus Lorem at lectus interdum. netus est. malesuada Suspendisse molestie adipiscing a libero. tempor ac vel dolor consectetur ac Nam sagittis eu tristique sed Ut ac Quisque volutpat sollicitudin eu ultricies Nam vel tempor imperdiet tristique Aenean leo suscipit egestas. vestibulum. porttitor eros. finibus, orci cursus non sem nibh. risus risus bibendum. massa senectus habitant nibh turpis Ut Pellentesque hendrerit, mauris Duis sit aliquet. molestie ac scelerisque. in, non et",
      "type": "exact"
    }
  ],
  "schema_name": "homepage",
  "title": "cursus"
}

The links for this item. This is what a publishing application sends in a patch_links call.

Attributes

links
object
previous_version
string

View this schema on GitHub

Random example

{
}