Table of contents

Schema: completed_transaction

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

description
or null

details
object
change_history
array

external_related_links
array

promotion
object
category

Allowed values: organ_donor, register_to_vote
url
string

document_type
string

Allowed values: completed_transaction
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
mainstream_browse_pages
Powers the /browse section of the site. These are known as sections in some legacy apps.
meets_user_needs
The user needs this piece of content meets.
ordered_related_items
Related items, can be any page on GOV.UK. Mostly used for mainstream content to power the sidebar. Ordering of the links is determined by the editor in Content Tagger.
ordered_related_items_overrides
Related items, can be any page on GOV.UK. Overrides ‘more like this’ automatically generated links in the beta navigation.
organisations
All organisations linked to this content item. This should include lead organisations.
parent
The parent content item.
policies
Link type automatically added by Publishing API
policy_areas
A largely deprecated tag currently only used to power email alerts.
primary_publishing_organisation
The organisation that published the page. Corresponds to the first of the 'Lead organisations’ in Whitehall, and is empty for all other publishing applications.
taxons
Prototype-stage taxonomy label for this content item
topics
Powers the /topic section of the site. These are known as specialist sectors in some legacy apps.
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-tagger, design-principles, external-link-tracker, feedback, frontend, hmrc-manuals-api, info-frontend, licencefinder, manuals-frontend, manuals-publisher, maslow, performanceplatform-big-screen-view, policy-publisher, publisher, rummager, service-manual-publisher, share-sale-publisher, short-url-manager, smartanswers, specialist-publisher, spotlight, static, tariff, travel-advice-publisher, whitehall
publishing_request_id
A unique identifier used to track publishing requests to rendered content
rendering_app
string
The application that renders this item.
Allowed values: calculators, calendars, collections, designprinciples, 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
schema_name
string

Allowed values: completed_transaction
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
withdrawn_notice
object
explanation
string

withdrawn_at

View this schema on GitHub

Random example

{
  "base_path": "/e02fbf51-e23b-4c75-95c0-064393030533/fc7bead4-6fda-4682-bf2f-b9ac69287769/185cb1e5-4356-4180-9f56-7f086c360544/50ec58d8-181d-4dcf-8d11-c95b7eccf345/3005dcc9-f38e-4a61-9cc2-517bbbd6fadd",
  "content_id": "98ef8c66-68ea-48db-b23a-dc7a2b366bbd",
  "description": "amet, finibus, porttitor nibh morbi egestas. Sed Ut tempor adipiscing suscipit sagittis malesuada Ut nibh. nisl fames libero. vestibulum. eros. pellentesque ac dolor et",
  "details": {
    "change_history": [
      {
        "note": "egestas. netus sit orci suscipit eu aliquet. sollicitudin Ut at a est. Duis lectus tristique molestie dolor non molestie Lorem sem ultricies turpis vel malesuada Aenean ac non sagittis nisl libero. ac eros. risus tempor ac mauris massa elit. volutpat purus leo Quisque interdum. sed finibus, ac consectetur habitant fames Ut tempor risus et Mauris ipsum Nam tristique eu Nam porttitor imperdiet interdum. senectus Pellentesque in, pellentesque vel et Sed nibh. scelerisque.",
        "public_timestamp": "2017-09-26T23:24:21+00:00"
      },
      {
        "note": "eu Nam Quisque Ut finibus, ultricies cursus Ut sollicitudin vel suscipit ac amet, massa vestibulum. purus nibh lorem eu egestas. Duis Pellentesque volutpat adipiscing risus scelerisque. turpis dolor Sed Mauris non sagittis sem elit. molestie tristique senectus hendrerit, risus sed Lorem tristique ac ipsum est. orci pellentesque dolor tempor fames lectus Nam eros. malesuada mauris nisl non consectetur et libero. netus in, imperdiet aliquet. tempor Suspendisse habitant interdum. nibh. porttitor ac interdum. Aenean morbi at a sit et vel bibendum. ac leo molestie",
        "public_timestamp": "2017-10-28T06:56:42+00:00"
      },
      {
        "note": "sit Suspendisse sem Quisque fames sagittis turpis purus dolor risus Ut non suscipit senectus eros. tempor cursus Ut et pellentesque lorem interdum. in, massa Mauris hendrerit, eu imperdiet ultricies sed Nam porttitor Sed Lorem vel finibus, orci adipiscing aliquet. mauris malesuada elit. ipsum Duis Aenean non egestas. Pellentesque molestie a volutpat vestibulum. tristique at",
        "public_timestamp": "2017-09-28T22:29:01+00:00"
      },
      {
        "note": "finibus, Ut et malesuada volutpat amet, fames purus massa vestibulum. sed ac Nam ultricies lorem habitant elit. molestie bibendum. interdum. Pellentesque tempor ipsum sem vel at orci sollicitudin tristique non ac scelerisque. libero. senectus tristique aliquet. Sed Lorem in, ac eu tempor dolor Quisque sit Duis leo et",
        "public_timestamp": "2017-11-20T22:13:14+00:00"
      },
      {
        "note": "elit. nibh. ac suscipit ultricies risus eu Sed vel et sit Quisque Lorem massa turpis dolor egestas. adipiscing sagittis tempor Duis eu et purus leo imperdiet tristique Ut cursus a Ut Pellentesque libero. pellentesque eros. nisl ac senectus morbi sem at dolor volutpat ac fames tempor tristique Mauris vestibulum. aliquet. malesuada risus molestie sollicitudin Aenean non est. orci hendrerit, sed Nam consectetur non lorem interdum. in, amet, bibendum. nibh Nam interdum. molestie ipsum netus lectus habitant porttitor scelerisque. mauris vel ac",
        "public_timestamp": "2017-10-26T07:09:10+00:00"
      },
      {
        "note": "molestie nisl dolor suscipit imperdiet ac tristique vel nibh turpis hendrerit, est. libero. orci Suspendisse mauris risus porttitor tempor Nam Nam tristique interdum. ultricies Mauris non sollicitudin aliquet. sem leo lectus Duis lorem amet, vestibulum. interdum. vel finibus, malesuada adipiscing ac senectus dolor ac nibh. Pellentesque eu eros. massa sit at ipsum molestie et Ut scelerisque. ac Sed sagittis Aenean bibendum. consectetur non in, Ut morbi pellentesque Lorem Quisque fames habitant sed elit. a egestas.",
        "public_timestamp": "2017-09-26T07:43:43+00:00"
      },
      {
        "note": "eros. volutpat molestie",
        "public_timestamp": "2017-12-05T03:59:45+00:00"
      },
      {
        "note": "non Lorem Mauris ultricies imperdiet nibh. dolor egestas. aliquet. sollicitudin lorem tempor ac scelerisque.",
        "public_timestamp": "2018-01-09T19:40:05+00:00"
      },
      {
        "note": "sit ac non cursus consectetur fames egestas. Ut nibh. eros. eu non vestibulum. est. Pellentesque Aenean ultricies interdum. pellentesque sollicitudin sagittis adipiscing eu imperdiet massa at et Quisque Mauris Suspendisse elit. vel sem leo Sed scelerisque. Nam tempor risus",
        "public_timestamp": "2017-12-31T11:33:30+00:00"
      }
    ]
  },
  "document_type": "completed_transaction",
  "first_published_at": null,
  "links": {
    "available_translations": [
      {
        "api_path": "/8945a0f5-5083-446b-b449-5aafb99c4d22/c74cbce6-b3e9-41da-9cef-0de6f64241ef/1e4174f0-4eb7-4919-90e1-1213005599d4",
        "base_path": "/ed7ba908-fa34-4d0a-997d-9e46efe40c8d",
        "content_id": "95606f0e-825f-4e23-89e9-91488731c5a1",
        "links": {
        },
        "locale": "vi",
        "schema_name": "ac non ac bibendum. hendrerit, orci habitant pellentesque at Ut lorem nisl Nam risus sit molestie turpis finibus, interdum. et in, elit. egestas. senectus imperdiet massa porttitor Duis tristique Ut sed morbi tristique ipsum libero. eros. netus dolor eu nibh",
        "title": "",
        "web_url": "http://example.com/773bec2b-9654-4d3a-a62f-4cf32a2cf237/2c850e0a-1cb7-4211-9520-172eac8a463c/ecd07ae7-300f-4439-bb24-f3e8dd4b1302/bba8599f-e635-43f4-a167-b249ca117c03#ed8d028ec35ebba92c0063547d77d5ec"
      },
      {
        "api_url": "http://example.com/9cda4575-f2ea-4f2c-bdc5-5610dc609130#a85f70f3dadbaeb40ad7a6c9211eac23",
        "base_path": "/ed67a91f-c5d9-425e-9bb3-efad5b016506/51960a99-8a6b-422e-9f7f-f8bfbb3bed4e/dbb57dc0-c41d-4449-9c87-d8c1158d8d39/72441e71-dc82-4595-8900-bec044e3598b/3c05f535-7ebf-4dd9-9bc8-674270eafdf2",
        "content_id": "4961eac5-b97a-4a8a-9721-2c7c07cfa617",
        "document_type": "aliquet. ipsum porttitor nibh. molestie",
        "links": {
        },
        "locale": "bn",
        "public_updated_at": null,
        "title": "Mauris libero. aliquet. suscipit Aenean scelerisque. tempor ac malesuada Lorem vel molestie Suspendisse imperdiet risus senectus molestie ac lectus risus lorem elit. turpis a pellentesque Nam ac fames et non volutpat ac hendrerit, tristique amet, sagittis adipiscing ultricies cursus",
        "web_url": "http://example.com/148f5170-ae73-403a-9adc-200cda6d7875/2a807f6f-ad0a-4103-af67-4082dec64dfe/20259db6-969a-40b3-b768-b9b42e521507/36cff0fe-baf6-4417-8a60-ed8f3658413a#848afac5c89a6819648c4b2b8467439b"
      }
    ],
    "meets_user_needs": [
      {
        "analytics_identifier": "amet, aliquet. dolor Mauris et sit Nam vel ac bibendum. ac vel finibus, risus Quisque hendrerit, porttitor et suscipit non malesuada ac Ut elit. Sed interdum. consectetur tristique purus sollicitudin egestas. est. vestibulum. non lectus lorem molestie netus mauris imperdiet Suspendisse eu cursus sed massa senectus tempor sem turpis molestie pellentesque leo tempor ultricies fames adipiscing libero. nisl morbi",
        "base_path": "/d62394ee-9372-4fb7-9b80-c2f6be520322/d00c46e4-6db2-4461-ba9d-41d09b186e2c/57da18c9-183c-48ab-91c1-914d3a6d7455",
        "content_id": "8a1e8735-887a-459f-9cc1-b6e87846c527",
        "links": {
        },
        "locale": "ja",
        "schema_name": "purus non hendrerit, Nam molestie sem dolor ipsum libero. tristique et molestie risus non eros. risus leo lorem netus senectus ac Duis Quisque tempor sed fames at suscipit eu consectetur turpis Lorem mauris habitant porttitor ac Sed bibendum. et adipiscing dolor nisl morbi est. Mauris nibh. Ut Aenean pellentesque",
        "title": "orci eu sagittis leo morbi Duis hendrerit, elit. lectus Pellentesque Nam Lorem Ut Mauris sollicitudin est. sem Nam purus Sed amet, malesuada ac non ultricies fames molestie vestibulum. turpis nisl interdum. scelerisque. vel a tempor massa aliquet. et eros. nibh at cursus senectus non ipsum lorem porttitor bibendum. tristique Suspendisse Aenean dolor suscipit ac finibus, imperdiet ac interdum. risus tempor volutpat et ac Quisque sit eu nibh. egestas. pellentesque netus risus libero. adipiscing vel dolor in, sed tristique consectetur habitant Ut molestie mauris"
      },
      {
        "analytics_identifier": null,
        "base_path": "/0e7a08f5-33c2-4fb2-a9d7-3ebba3dd08f0/2c5e2e9c-8c84-4880-93e6-f316abcf388e",
        "content_id": "7a9f2507-2dee-4a4f-aa69-1beb0e7d3902",
        "document_type": "ipsum et ac ac sollicitudin vestibulum. a est. turpis lectus senectus aliquet. hendrerit, consectetur porttitor habitant Ut tristique libero. dolor lorem Suspendisse in, molestie Nam nibh eros. adipiscing elit. Aenean ac risus morbi Mauris suscipit Lorem risus Duis eu vel finibus, at ac non interdum. ultricies amet, vel sit",
        "locale": "az",
        "public_updated_at": null,
        "title": "est. mauris volutpat tristique et netus Pellentesque eros. porttitor lectus eu adipiscing nisl pellentesque morbi tempor elit. sollicitudin hendrerit, risus sed molestie"
      },
      {
        "api_path": "/41799af7-7c00-4084-887e-e13a2e7c862f/920c08c6-146d-438c-8226-1ca6ced6df2a/90894486-6a46-49b5-996c-3c757acde493/98c2427a-4956-434d-8b9e-28f277abdd36/1502d16c-24fd-4073-958a-4b5aa0132d68",
        "api_url": "http://example.com/0169d888-c520-4980-affe-34fbfc94926e/845a539e-4d38-4e92-8395-19528f31bad8/9df454fd-596f-433b-b75b-a6940829bb3e#cb7aa446910d0fda7694849cee38ed26",
        "base_path": "/93ad4141-c731-4454-be4d-09f86018a8a5/4297ee62-c563-434d-bdc8-f020878cb4fe",
        "content_id": "2282876a-c3de-48cf-bbfe-444526ad86b4",
        "locale": "zh",
        "public_updated_at": null,
        "title": "adipiscing et aliquet. vestibulum. ac consectetur leo risus netus malesuada a dolor eros. sagittis Nam Quisque eu molestie dolor Pellentesque suscipit ac scelerisque. mauris imperdiet Lorem nisl molestie",
        "web_url": "http://example.com/c9df40a4-e36d-4b2f-86a8-fc11f8f711e3#fe0629f162a3f56a132496015f0ae2af"
      },
      {
        "api_path": "/e8d987d1-690c-416a-a9c5-933ca586b438/6e87c109-b563-4867-a935-1df03cf138d6",
        "api_url": "http://example.com/5fd9c38e-2814-411b-9fe4-167c70ba2409/2ab145bf-f2e4-407b-a255-400f9fd49411#407b8c3ea0a5f8cbd8e6523391e49b09",
        "base_path": "/0ec7cd4c-1faa-4414-8d8e-298d37ad6e76/82b7388e-92ed-420a-8007-fd15ea5ca182/7de577e0-47ca-4424-b269-4846da75952e/16399f12-34ef-4c5c-acd2-37a59e5a2d6e",
        "content_id": "e88e196a-b24d-45d1-bb27-17922e82b0e5",
        "document_type": "risus a tristique lorem Sed ac imperdiet fames Aenean bibendum. at hendrerit, molestie ultricies consectetur Lorem senectus non et morbi cursus habitant sed finibus, risus interdum. in, interdum.",
        "locale": "zh",
        "schema_name": "ac molestie non bibendum. suscipit Quisque dolor scelerisque. interdum. vestibulum. ultricies Sed adipiscing",
        "title": "nisl tempor fames purus sit consectetur scelerisque. ac tempor Nam habitant Ut sem eros."
      }
    ],
    "policy_areas": [
      {
        "base_path": "/37a654a9-03d1-40c4-8abc-74d2b3a0396c",
        "content_id": "71d19f70-076c-4681-90a5-c7ee4dafcd9a",
        "locale": "es-419",
        "schema_name": "tristique Sed Lorem ipsum mauris Mauris bibendum. Nam ac elit. orci finibus, Aenean sed Pellentesque vestibulum. porttitor egestas. hendrerit, Duis molestie tristique est. eu consectetur Quisque massa risus netus adipiscing fames interdum. tempor vel suscipit amet, Suspendisse at nibh. nibh aliquet. sollicitudin lectus cursus pellentesque Ut lorem ac non eros. turpis sagittis vel nisl risus non molestie ultricies tempor Nam ac Ut morbi et in, interdum. purus malesuada a et ac dolor sit eu libero.",
        "title": "scelerisque. non Mauris nisl suscipit Sed Duis non turpis Ut dolor ac Quisque netus Pellentesque purus at tempor volutpat Nam interdum. senectus vel interdum. libero. mauris in, est. Lorem hendrerit, dolor imperdiet ac tristique Nam tempor ultricies finibus, vestibulum. sagittis porttitor eu eu pellentesque risus consectetur sollicitudin lectus Suspendisse et molestie a sem massa amet, sit ac adipiscing elit. malesuada habitant egestas. et Ut cursus tristique vel nibh ac sed leo orci bibendum. nibh. morbi eros. lorem"
      },
      {
        "api_path": "/e743ab6c-e1a2-4dc1-af72-eec6ab1f048a",
        "base_path": "/e81ab119-ca04-40a7-a661-93345daf3cee/a0f261bb-b8e4-4e5b-9b10-3425b8226a26/6a462349-b70b-4a57-9736-aa7e664c6317/8769f0cf-8214-4d80-8e98-f8d0735c843e",
        "content_id": "42331981-929c-49d6-b81f-5cf8fa0682bb",
        "document_type": "Duis non interdum. purus leo vel a aliquet. hendrerit, pellentesque et tristique non egestas. malesuada lectus ac eu et sit eros. Mauris interdum. cursus molestie ultricies scelerisque. Ut consectetur sollicitudin dolor amet, nibh. ipsum nibh Nam turpis dolor Lorem morbi Ut vestibulum. eu est. bibendum. risus tempor ac nisl libero. netus finibus, lorem Quisque senectus volutpat ac elit. adipiscing sagittis habitant tristique sem vel sed risus at ac molestie porttitor suscipit Pellentesque tempor mauris",
        "links": {
        },
        "locale": "th",
        "public_updated_at": null,
        "schema_name": "ipsum bibendum. nibh non mauris risus ac Mauris Nam dolor egestas. tristique interdum. morbi ac est. vel molestie ultricies amet, cursus sed finibus,",
        "title": "eros. massa Ut tempor Quisque sollicitudin adipiscing Suspendisse Duis Pellentesque scelerisque. pellentesque consectetur risus molestie nibh elit. volutpat Aenean finibus, ac eu Nam lorem Lorem ac malesuada sagittis Nam in, interdum. ultricies imperdiet sed lectus vestibulum. at Ut cursus vel morbi Sed ac dolor turpis risus tristique tristique a suscipit interdum. hendrerit, est. molestie sem sit bibendum. vel senectus aliquet."
      },
      {
        "api_url": "http://example.com/fbd19557-f164-4461-936f-8087879a0487/04e78e5f-d80a-4be2-a223-af06601300ac#02039bcd8e7e010f254eef0dbfd94cd8",
        "base_path": "/89d0bdb1-5c36-4943-b834-4b2fe3259b71/9b392f2e-4ddd-495e-921d-b942083f50e3/85964556-9d6a-47a5-84da-53c409e1ba66/ea095f58-cee5-4881-87f3-f594183c3ba8/87f16960-58a8-4309-8253-2f593f7b2add",
        "content_id": "f32aa13d-011b-4c1c-9fdc-2d690290d688",
        "locale": "it",
        "public_updated_at": null,
        "title": "morbi adipiscing egestas. ac nibh. risus tempor a nibh lorem amet, in, Nam interdum. et malesuada Mauris tempor scelerisque. nisl Suspendisse aliquet. eu Nam ac bibendum. suscipit Sed at netus non ac eu dolor hendrerit, imperdiet pellentesque tristique ac tristique vel sem orci consectetur sed risus molestie Pellentesque turpis habitant et eros. libero. massa mauris finibus, Aenean fames porttitor ipsum elit. est. vestibulum. ultricies Lorem purus leo Ut senectus dolor cursus Ut interdum. sit molestie sagittis volutpat Quisque vel lectus sollicitudin non Duis"
      },
      {
        "analytics_identifier": null,
        "api_path": "/3f478db8-79e0-4f46-9cec-2d8a4f874947/14821faa-c554-4638-8f00-a16ec035cd7c",
        "base_path": "/91f879a3-934e-4d3e-8499-c0f3c0303675/5d892738-c118-4d2a-8542-83332a40e724/c4bf2c83-d490-4ab5-b709-4fec72341143",
        "content_id": "195f0043-c27b-4b00-892f-9ce1511fc10d",
        "document_type": "Sed mauris ac Ut lorem Pellentesque nibh. purus Ut cursus Suspendisse adipiscing non vel risus elit. et orci aliquet. Quisque Aenean hendrerit, eu amet, et tempor ac sagittis porttitor dolor ac interdum. senectus risus ipsum massa consectetur suscipit eu molestie sollicitudin pellentesque non fames sit interdum. eros. leo ac habitant volutpat vel molestie bibendum. scelerisque. Lorem vestibulum. morbi netus tristique Mauris",
        "locale": "ta",
        "schema_name": "lorem suscipit egestas. mauris eu Ut massa ac Sed eros. sed sem risus ac risus est. malesuada netus ipsum Duis lectus cursus porttitor senectus imperdiet et tristique sagittis fames finibus, elit. ultricies",
        "title": "consectetur Duis Sed tristique lorem volutpat ac Ut Nam risus massa Quisque mauris aliquet. dolor fames cursus Ut nibh risus Suspendisse orci pellentesque interdum. adipiscing Aenean tempor nibh. imperdiet sed ipsum ultricies ac vestibulum. turpis at ac scelerisque. sit malesuada egestas. tempor et et eu vel netus purus lectus morbi",
        "web_url": "http://example.com/73a9e903-9a5d-4a82-a53b-b27122dc1431/67d995af-3851-472d-965d-3dc1cebb1d9b/68fda432-1f70-40e2-8676-f0d79e23e6e0/b846a81e-4391-4a2b-8cb0-50a0617da44f#9bb3781c2de3b4d4ba8c2ad38bed05ca"
      }
    ]
  },
  "locale": "fa",
  "navigation_document_supertype": "malesuada cursus Nam netus egestas. Pellentesque scelerisque. et tristique aliquet. tempor elit. ac adipiscing interdum. risus consectetur lorem leo nibh. dolor eu ipsum libero. suscipit non at a Duis Aenean vestibulum. est. vel senectus dolor",
  "need_ids": [
    "vel imperdiet Lorem leo morbi fames Aenean pellentesque sagittis interdum. hendrerit, Duis molestie mauris tristique massa nibh. in, lectus senectus consectetur ultricies Pellentesque Mauris vel Nam elit. Ut Nam finibus, et bibendum. ipsum sem purus non",
    "netus est. lectus risus tristique Suspendisse sem orci",
    "tempor egestas. malesuada nisl aliquet. sed et lectus bibendum. orci hendrerit, Ut tempor tristique ac porttitor molestie Nam purus eros. nibh. Quisque interdum. at ac nibh Ut tristique ac habitant eu cursus est. sit non ipsum eu Pellentesque dolor finibus, sem vel netus",
    "mauris senectus lorem tempor imperdiet nisl volutpat sagittis adipiscing nibh vel Nam est. purus interdum. orci tempor et et molestie Sed ac",
    "Pellentesque adipiscing ac turpis tristique Suspendisse sagittis egestas. et cursus non sit tempor amet, vel malesuada risus orci lectus libero. senectus vestibulum. risus dolor consectetur leo Sed volutpat elit. interdum. nibh sem in, Nam sed mauris Quisque porttitor Mauris finibus, Lorem fames imperdiet tempor et ultricies nisl netus vel ac ac habitant eu massa molestie purus eu at suscipit ipsum hendrerit, Aenean ac Ut Ut lorem eros. scelerisque. a est. bibendum. Duis non aliquet. interdum. dolor pellentesque nibh. Nam molestie morbi sollicitudin tristique",
    "Quisque non dolor eu porttitor vel interdum. at lorem habitant nibh. nisl",
    "Aenean interdum. tempor Nam Ut ipsum suscipit interdum. pellentesque molestie Ut est. Lorem bibendum. aliquet. Pellentesque tristique purus eu et tempor vestibulum. elit. habitant imperdiet sem Quisque ac Suspendisse tristique eu consectetur ac risus a volutpat molestie vel finibus, lorem porttitor vel massa et morbi non ac ac leo nibh nibh. mauris sagittis sed cursus dolor fames Duis scelerisque. dolor libero. ultricies eros. turpis hendrerit, Sed amet, Mauris senectus lectus sit sollicitudin risus non netus at adipiscing egestas. malesuada",
    "pellentesque massa est. eu sollicitudin risus fames in, Mauris a Suspendisse eu at non Nam ultricies purus egestas. dolor Duis nisl nibh sed leo habitant tristique turpis orci mauris tempor risus sit Aenean vel elit. non ac ac aliquet. ac lorem malesuada adipiscing suscipit Lorem cursus ac volutpat Pellentesque nibh. scelerisque. sagittis molestie hendrerit, amet, tristique Nam bibendum. vestibulum. interdum. ipsum"
  ],
  "public_updated_at": "2018-01-01T07:18:36+00:00",
  "publishing_request_id": null,
  "rendering_app": "performanceplatform-big-screen-view",
  "schema_name": "completed_transaction",
  "search_user_need_document_supertype": "et non Nam vestibulum. suscipit sem molestie amet, malesuada ipsum Nam in, non a imperdiet bibendum. netus eu at morbi Ut habitant Quisque massa consectetur aliquet. elit. leo ac nibh. fames ultricies tempor Duis turpis interdum. ac porttitor molestie cursus dolor nisl Pellentesque sed dolor et tempor interdum. risus Sed eu eros. pellentesque Mauris Suspendisse ac Aenean lectus tristique hendrerit, lorem vel vel adipiscing finibus, purus est. sollicitudin ac senectus orci egestas. volutpat mauris risus sagittis Ut tristique libero. Lorem nibh sit scelerisque.",
  "title": "in, cursus vel orci lorem Nam tempor eu Lorem nisl scelerisque. sagittis lectus risus ac fames aliquet. Duis finibus, eros. bibendum. a elit. interdum. et netus ipsum sit mauris egestas. sollicitudin Suspendisse turpis dolor adipiscing Pellentesque at Aenean Nam risus tristique eu morbi malesuada tempor nibh. ac interdum. leo",
  "updated_at": "2017-12-01T18:28:33+00:00"
}

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
external_related_links
array

promotion
object
category

Allowed values: organ_donor, register_to_vote
url
string

document_type
string

Allowed values: completed_transaction
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-tagger, design-principles, external-link-tracker, feedback, frontend, hmrc-manuals-api, info-frontend, licencefinder, manuals-frontend, manuals-publisher, maslow, performanceplatform-big-screen-view, policy-publisher, publisher, rummager, service-manual-publisher, share-sale-publisher, short-url-manager, smartanswers, specialist-publisher, spotlight, static, tariff, travel-advice-publisher, whitehall
redirects
array

rendering_app
string
The application that renders this item.
Allowed values: calculators, calendars, collections, designprinciples, 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: completed_transaction
title
string

update_type

Allowed values: major, minor, republish

View this schema on GitHub

Random example

{
  "access_limited": {
    "auth_bypass_ids": [
      "27dfde72-3663-40ae-b423-27dfc37acb21",
      "06e53580-e352-447f-8392-a5779811a532",
      "7ee15b2b-e848-41f0-b705-1a60cadfca80",
      "6c7e0346-ac46-4626-9990-ceb8e5d98f06"
    ]
  },
  "analytics_identifier": null,
  "base_path": "/1ff84d8d-f13c-4226-bff9-5c153366be75/552130c4-7edd-447c-9d10-c465f0cd59e9/07454ddc-d84b-4572-bf60-4f29ab3a93bf/4747c22d-bf00-49ba-9fbc-9f688db0e808/51da76ac-4942-4999-bbf2-c1176538c2db",
  "description": "Pellentesque lorem Nam ultricies senectus cursus habitant sem risus Mauris in, purus tempor a nibh. morbi vestibulum. Nam tristique sagittis interdum. nibh lectus eros. massa leo mauris suscipit est. ipsum Duis interdum. et nisl vel egestas. Ut sollicitudin orci molestie bibendum. eu dolor Suspendisse aliquet. ac ac finibus, porttitor hendrerit, eu tristique tempor at volutpat Ut non adipiscing scelerisque. molestie risus turpis ac non sit Quisque Lorem libero. pellentesque Sed amet, elit. malesuada netus ac imperdiet vel et consectetur sed Aenean fames dolor",
  "details": {
    "external_related_links": [
      {
        "title": "tempor ac ac egestas. sed et scelerisque. risus",
        "url": "http://example.com/6839738e-6ef2-426c-bfb3-df27132acd49/b7fae976-0903-40ec-bf6f-424aca19d4d7/8d0f4776-d039-4f88-a627-4ced5fcd02f5/b9b79c91-4a65-4ffa-b2e0-19089da557fa#f7be1f771c3c2ab01dd89d3e3ebb3a1d"
      },
      {
        "title": "leo hendrerit, cursus et elit. malesuada ac morbi sagittis consectetur fames turpis Pellentesque risus Nam senectus finibus, sit eu netus pellentesque non eu Lorem molestie eros. scelerisque. at in, risus imperdiet interdum. Ut vel nibh suscipit interdum.",
        "url": "http://example.com/1fd7484b-751c-4b6d-8a22-84109ae3bb32/c4fa3a47-86c4-427a-b7d0-3b984313f6ca/bc166e48-f1d1-43ab-99ad-29e90be83f22/fe4c11cb-4be3-4f52-95c4-058b6d8a3976/864fe496-ec7a-4109-a23d-b0ec9fd93fb0#4885f6e9b481279f5726e752e7951623"
      },
      {
        "title": "sagittis a dolor tempor orci scelerisque. Ut ac Lorem elit. netus in, finibus, sollicitudin Aenean egestas. purus at cursus dolor Suspendisse Ut senectus et Sed turpis pellentesque Nam vel porttitor nisl sed lorem nibh. Pellentesque fames eu risus bibendum. eu molestie ipsum Mauris non leo vel adipiscing libero. est. lectus suscipit molestie nibh Nam et volutpat massa Quisque amet, non sit consectetur tempor tristique ac sem ultricies aliquet.",
        "url": "http://example.com/6ad569a5-f495-4512-b74f-61464d1ae254/d9f8ada9-816e-475a-b4e0-c5c1cbafd64c#23f2b0274f692c54f7b164c5a7c117a3"
      },
      {
        "title": "non tempor et purus vel porttitor Lorem ultricies egestas. scelerisque. leo fames ac malesuada dolor lorem non Suspendisse vestibulum. finibus, tristique molestie tempor a eros. molestie mauris interdum. elit. Pellentesque in, netus hendrerit, turpis volutpat massa pellentesque imperdiet risus Ut Duis amet, est. Nam Nam risus senectus",
        "url": "http://example.com/ec599fc3-384d-4f5a-a614-64c4449b89ce/2f155a40-0069-4ea4-940d-e18c8f1a22bf/5eb98b2e-96f8-47c8-9cc0-ae01b561ac1f#164a8147b9b9b31663fa3eb179c8d645"
      },
      {
        "title": "interdum. cursus Lorem senectus est. eu suscipit malesuada Mauris molestie Sed eros. tristique amet, lorem sed leo turpis adipiscing eu molestie in, vestibulum. libero. sem lectus interdum. et aliquet. vel ultricies Nam nibh Aenean risus a mauris sollicitudin Suspendisse massa pellentesque morbi orci nisl ac dolor",
        "url": "http://example.com/43626023-7613-4ef6-8436-fabc7b33867a/4ce48bbd-8d6d-4bcb-8cc8-dc37c951cf83/f65e096f-c2c6-4072-ace3-1c45b28c3444#4c75150c68579ce86861a910c63f3962"
      },
      {
        "title": "tempor Duis Nam non volutpat et eu leo Lorem sit Pellentesque in, tristique libero. purus orci Aenean turpis molestie interdum. porttitor Ut Sed lorem Mauris Quisque sem habitant suscipit finibus, Nam Suspendisse lectus pellentesque egestas. ac eros. dolor tempor nibh. imperdiet senectus ultricies sed netus adipiscing Ut malesuada consectetur",
        "url": "http://example.com/ed5fe60c-f371-4ffa-b187-8d345f41e38d/4c8d50a1-9a27-4e71-bb75-0a22e6c75883/07651324-f98d-43a6-a525-c04c1c5561eb/76f54adc-4392-43f9-b8d9-5643e0f01bb6#eb48db2e999d41e75413c02543fa8c97"
      },
      {
        "title": "purus sagittis a risus tempor fames Suspendisse tristique eu egestas. volutpat elit. sem cursus Nam ac nisl Aenean at et nibh. interdum. Duis ultricies nibh Ut amet, ipsum bibendum. aliquet. ac tempor habitant et vel ac in, lorem vel interdum. leo senectus dolor est. massa Ut imperdiet sit eros. tristique morbi Pellentesque lectus mauris non Mauris non vestibulum. orci libero. consectetur molestie sed adipiscing hendrerit, dolor porttitor Lorem Sed molestie risus netus eu",
        "url": "http://example.com/0542f66b-8322-445d-a1d4-9e0ab96cd8c0/71fca93d-d2de-4ae1-aaca-a788e92c5034/4d3e9b2f-a10d-424b-af6c-872ceb1e9e8a/59d35b96-7f62-4483-b8bf-4ac27cfc4781#8c06b3aefa3619fcb20a275bd414a32e"
      },
      {
        "title": "mauris Quisque consectetur lorem morbi lectus est. orci massa malesuada Ut porttitor nibh hendrerit, pellentesque vel risus egestas. Nam adipiscing Nam purus eu dolor dolor sit nisl interdum. bibendum. non scelerisque. cursus Ut risus imperdiet finibus, a eu non sem sollicitudin libero. Duis turpis sagittis tristique interdum. at Sed Suspendisse suscipit leo netus ultricies tempor ac fames ac vel sed",
        "url": "http://example.com/ac8c1793-a9da-4819-b105-bb100a96baee/43985773-4c36-40f6-9bdd-2fd663af18bf/c578c1da-14d9-4168-92d8-066c2b185933/61b907f9-568f-4d3c-a4b1-621b00b739b8/bc33c144-826c-40cb-b45f-664b863bd50c#434fc3e9d8ac41157ab2676afe3469e7"
      },
      {
        "title": "pellentesque hendrerit, ultricies purus bibendum. libero. Ut netus risus a leo Mauris ac egestas. dolor lectus turpis Nam nibh. adipiscing ac",
        "url": "http://example.com/c5314504-3e47-4c68-8ebe-8b0494db5a86/b76e4088-4743-4c8c-b367-6b07463793d2/cb750f8a-5e88-4316-b376-205f3a2fa6e4/0f6a63cd-1916-4c6c-b136-3691a915dce1#487dd4e3dea8f2375aa5bc48e0d00f2d"
      },
      {
        "title": "",
        "url": "http://example.com/168ae6f8-021f-40b3-8dd9-b2a155e58ebf/d1ff19a0-6453-4a62-a4e1-de9787beb7aa#b7bb3f563ec8632c26ee69c9d57b223e"
      }
    ]
  },
  "document_type": "completed_transaction",
  "first_published_at": "2017-11-18T08:21:57+00:00",
  "last_edited_at": "2017-12-28T00:50:30+00:00",
  "links": {
  },
  "locale": "tk",
  "need_ids": [
    "morbi tempor risus fames nibh at libero. a netus turpis elit. ultricies Nam lectus",
    "risus vel Ut dolor senectus in, lorem dolor ac at netus vestibulum. Nam Pellentesque et consectetur nibh tempor aliquet. pellentesque Suspendisse Nam interdum. non libero. elit. sit eu risus sollicitudin eu Quisque a interdum. Lorem Sed vel ac nibh. finibus, tempor tristique et ipsum porttitor malesuada egestas. imperdiet adipiscing purus sem eros. suscipit morbi amet, non molestie bibendum. ultricies mauris nisl sagittis ac ac turpis sed molestie Duis massa Mauris lectus orci Ut scelerisque. tristique cursus volutpat fames leo Aenean habitant est.",
    "Mauris Sed tristique in, Ut tempor consectetur lectus turpis scelerisque. nibh. libero. purus suscipit massa lorem pellentesque mauris non est. non sit egestas. eu adipiscing bibendum. eu molestie volutpat ac sed sagittis vel morbi et at aliquet. tristique cursus ac ac fames a porttitor Nam interdum. Quisque dolor imperdiet finibus, vestibulum. sollicitudin Pellentesque et interdum. leo malesuada elit. molestie ultricies hendrerit, sem ipsum Ut Lorem senectus ac vel nisl risus amet, eros. Suspendisse nibh dolor habitant Duis tempor orci risus netus Nam Aenean"
  ],
  "previous_version": "Mauris orci sagittis eu consectetur ipsum amet, vel ac hendrerit, netus leo",
  "public_updated_at": "2017-10-19T04:20:00+00:00",
  "publishing_app": "maslow",
  "rendering_app": "collections",
  "routes": [
    {
      "path": "orci tempor ac sem leo dolor bibendum. non volutpat molestie a adipiscing elit. risus tempor Suspendisse sit Duis in, dolor non imperdiet turpis risus porttitor fames amet, mauris Quisque cursus interdum. sagittis scelerisque. morbi hendrerit, lectus molestie libero. Nam Pellentesque eu sollicitudin Ut consectetur ac pellentesque sed vel Nam nibh et malesuada ultricies at nisl Lorem eros. habitant tristique nibh. finibus, et eu",
      "type": "prefix"
    },
    {
      "path": "Aenean nisl hendrerit, Pellentesque scelerisque. elit. purus bibendum. eros. sollicitudin molestie et sagittis tempor habitant",
      "type": "prefix"
    },
    {
      "path": "Sed Ut non purus lorem aliquet. pellentesque morbi risus dolor in, lectus sem molestie a suscipit sit nisl Aenean porttitor eros. turpis Mauris orci tristique egestas. interdum. eu ac vestibulum. Ut Duis hendrerit, risus mauris consectetur interdum. tempor ac at est. tempor habitant nibh dolor adipiscing cursus volutpat eu Lorem tristique ipsum ac Quisque finibus, ultricies vel libero. senectus netus Nam non",
      "type": "prefix"
    },
    {
      "path": "ac sollicitudin et volutpat Mauris interdum. non suscipit Duis imperdiet vestibulum. sagittis orci aliquet. nisl molestie egestas. purus tempor Pellentesque turpis Ut Ut tempor malesuada sed interdum. fames cursus dolor leo eu tristique sem vel finibus, bibendum. risus Lorem Quisque dolor lorem libero. ac vel consectetur est. et at Sed lectus porttitor nibh. sit in, ipsum eu Aenean senectus ac massa ac ultricies Nam pellentesque habitant amet, scelerisque. adipiscing mauris",
      "type": "exact"
    },
    {
      "path": "Nam sit tristique pellentesque ac dolor vel volutpat Ut porttitor Sed non sem ac malesuada hendrerit, tempor Duis fames vel tristique leo Nam est. Mauris sagittis tempor lorem orci dolor senectus nibh ac non Quisque risus a nisl molestie Aenean scelerisque. finibus, aliquet. Lorem mauris suscipit amet, turpis ipsum nibh. imperdiet eu risus sed massa libero. morbi elit.",
      "type": "exact"
    },
    {
      "path": "interdum. nisl fames vel ac molestie ac tristique adipiscing Ut eu nibh in, lectus senectus malesuada orci vestibulum. purus risus Nam sit at ac imperdiet tempor egestas. sagittis tempor scelerisque. dolor a ac Aenean elit. lorem et hendrerit, finibus, ultricies suscipit libero. tristique consectetur vel bibendum. cursus Pellentesque Quisque Mauris mauris eu Duis non",
      "type": "prefix"
    },
    {
      "path": "interdum. ac ac mauris Duis Nam vel risus sagittis a tempor libero. molestie eros. nisl Sed tristique sit Quisque morbi Ut ultricies sollicitudin eu scelerisque. ipsum Pellentesque porttitor Ut et sem adipiscing netus turpis eu senectus lorem imperdiet est. fames elit. tempor consectetur purus orci dolor at leo Mauris molestie vel Suspendisse bibendum. nibh. in, ac risus ac nibh finibus, et pellentesque volutpat lectus suscipit sed amet, non Aenean aliquet.",
      "type": "exact"
    }
  ],
  "schema_name": "completed_transaction",
  "title": "sollicitudin leo Nam nisl ac purus sit morbi porttitor volutpat adipiscing cursus non tristique Pellentesque Nam vestibulum. lorem Duis suscipit bibendum. Aenean pellentesque et orci et Ut vel habitant risus ultricies vel imperdiet consectetur amet, sed interdum. ipsum netus libero. massa lectus in, hendrerit, tempor elit. molestie Sed ac scelerisque. senectus eu dolor malesuada Mauris eros. tristique fames aliquet. interdum. at Lorem sagittis egestas. Suspendisse risus dolor finibus, Quisque tempor eu nibh. mauris molestie Ut non est. ac a ac sem"
}

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

Attributes

links
object
mainstream_browse_pages
Powers the /browse section of the site. These are known as sections in some legacy apps.
meets_user_needs
The user needs this piece of content meets.
ordered_related_items
Related items, can be any page on GOV.UK. Mostly used for mainstream content to power the sidebar. Ordering of the links is determined by the editor in Content Tagger.
ordered_related_items_overrides
Related items, can be any page on GOV.UK. Overrides 'more like this’ automatically generated links in the beta navigation.
organisations
All organisations linked to this content item. This should include lead organisations.
parent
The parent content item.
policy_areas
A largely deprecated tag currently only used to power email alerts.
primary_publishing_organisation
The organisation that published the page. Corresponds to the first of the 'Lead organisations’ in Whitehall, and is empty for all other publishing applications.
taxons
Prototype-stage taxonomy label for this content item
topics
Powers the /topic section of the site. These are known as specialist sectors in some legacy apps.
previous_version
string

View this schema on GitHub

Random example

{
  "links": {
    "meets_user_needs": [
      "5a7de8ff-e5bd-48a0-b7c8-a4e39d58b5c6",
      "43e43524-fe47-49c3-8db4-b7e0be1afa51",
      "0bf6bec7-1afe-4c7f-94eb-bb728e74a662",
      "b61ad9fa-9cf1-4577-a8f3-d937e781eae5",
      "1ffbd930-99d5-4edb-8969-09e55a6f3acc",
      "4aa6cdcf-3f53-483d-96d8-9dd629a1f136",
      "65a92ee5-c611-414c-93e6-08986bebeb89",
      "cbe9bccc-08f8-437b-a427-a698084e4d5d",
      "cbdd43ba-dd4e-41ac-b458-8c6996371160",
      "27430bd2-8211-4298-8e03-59102590d3d3"
    ],
    "ordered_related_items_overrides": [

    ],
    "organisations": [
      "d7e40d10-b7ee-42c1-b7b7-87065cc0584c",
      "46413b26-095e-47bf-a595-d12c928b75d2",
      "66bb9326-d398-4c3f-b20f-691985eb84de",
      "9c4c7323-432f-41d6-914c-225669e0194b",
      "05025f0a-e272-49aa-978f-cf5d374850e6",
      "83bc4e21-6b15-43dd-b938-bcc93db5fc2f"
    ],
    "parent": [

    ],
    "primary_publishing_organisation": [

    ],
    "taxons": [
      "19d05fda-6799-4396-8dd4-6454d0e4e3ee",
      "9d2dc1f3-ae5c-4c02-b723-316e79b18e20",
      "af0f5e51-7c03-4572-937b-75d44aa3bcd7",
      "57702b7e-1cbe-4d57-930c-9d8b45c3db3d",
      "5ccf882b-074f-40b6-a4d3-10e080a64c0e",
      "8cb40a32-3b50-4b84-84b7-098a285b59ab",
      "e26d144d-306c-46e7-8c66-050f6270089f",
      "195bdd83-ed6e-45f1-aebb-1ef21c9b7dee"
    ]
  },
  "previous_version": "nisl morbi Suspendisse ipsum at sed ac in, vel tempor sollicitudin malesuada finibus, habitant Duis vestibulum. ac orci elit. aliquet. eros. Nam lorem turpis dolor vel senectus consectetur cursus interdum. tristique est. molestie adipiscing Nam a et risus netus non Quisque molestie sem bibendum. Aenean non tristique hendrerit, Pellentesque ultricies libero. Ut purus lectus Ut interdum. egestas. porttitor ac dolor et sit pellentesque suscipit amet, volutpat mauris nibh risus imperdiet nibh. Sed Mauris Lorem ac massa eu eu tempor fames scelerisque. leo sagittis"
}