Skip to main content

Schema: content_block_postal_address

Frontend schema

This schema doesn’t have a frontend schema. This means that it should not be used by rendering applications.

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
 Deprecated: auth_bypass_ids should be sent as a separate field
organisations
 A list of organisation content ids permitted access to this item
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.
auth_bypass_ids
array
base_path
null
bulk_publishing
boolean
change_note
["null", "string"]
description
or null
details
object
county
string
line_1
string
line_2
string
postcode
string
town_or_city
string
document_type
string
Allowed values: content_block_postal_address
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
embed
 Content that will be embedded within the document, using embed tags.
policy_areas
 A largely deprecated tag currently only used to power email alerts.
primary_publishing_organisation
 The organisation that published the content block. Corresponds to the Edition’s ‘Organisation’ in Whitehall, and is empty for all other publishing applications.
locale
string
Allowed values: ar, az, be, bg, bn, cs, cy, da, de, dr, el, en, es, es-419, et, fa, fi, fr, gd, gu, he, hi, hr, hu, hy, id, is, it, ja, ka, kk, ko, lt, lv, ms, mt, ne, nl, no, pa, pa-pk, pl, ps, pt, ro, ru, si, sk, sl, so, sq, sr, sv, sw, ta, th, tk, tr, uk, ur, uz, vi, yi, 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: account-api, calculators, calendars, collections-publisher, contacts, content-publisher, content-tagger, email-alert-frontend, external-link-tracker, feedback, frontend, government-frontend, hmrc-manuals-api, local-links-manager, manuals-publisher, maslow, performanceplatform-big-screen-view, publisher, publishing-api, rummager, search-admin, search-api, service-manual-publisher, share-sale-publisher, short-url-manager, smartanswers, specialist-publisher, static, tariff, travel-advice-publisher, whitehall
redirects
array
rendering_app
null
routes
array
schema_name
string
Allowed values: content_block_postal_address
title
string
update_type
Allowed values: major, minor, republish

View this schema on GitHub

Random example

{
  "access_limited": {
    "auth_bypass_ids": [
      "bfeb8cab-4bdc-127e-a67a-8c0fea6ef517",
      "4495505b-4b90-1cdf-a5a4-b3adeae7bad5",
      "ed3cd8e6-cbd3-11c3-a450-e6dda3ce6e5d",
      "3daf01af-d8dd-1045-aefb-2ef9f0c41d94",
      "2c3c7a3a-aec3-1f6a-a54b-4aad1d71e255",
      "db6904a8-fcd3-1d49-ac28-c22a92cfeaed"
    ]
  },
  "description": "Pellentesque Mauris Sed Nam eros. dolor eu nisl",
  "details": {
    "line_1": "sed tristique netus ac vel Duis interdum. tempor Pellentesque turpis ac libero. tempor vel et Suspendisse nibh lorem eros. vestibulum. nibh. senectus nisl ipsum hendrerit morbi massa a molestie dolor mauris imperdiet porttitor Ut Lorem fames eu scelerisque. volutpat Nam bibendum. egestas. est. tristique lectus ultricies leo eu non sem cursus ac sit finibus in Aenean ac adipiscing consectetur sagittis orci Ut Mauris Nam",
    "line_2": "sit suscipit nibh malesuada molestie egestas. ac Suspendisse tristique ac purus at ac libero. Nam dolor ac lectus senectus bibendum. dolor adipiscing lorem cursus hendrerit Pellentesque habitant sagittis a elit. vel tristique eros. interdum. eu eu porttitor Quisque Aenean finibus molestie tempor fames Ut risus risus et sed tempor Duis massa vel aliquet. et nibh. Nam scelerisque. ipsum mauris in nisl Mauris imperdiet pellentesque leo Lorem sem orci",
    "postcode": "risus non non amet orci nibh leo vestibulum. senectus interdum. ac ipsum cursus Sed molestie Pellentesque fames volutpat tristique libero. egestas. imperdiet Nam et dolor eros. tempor Ut bibendum. Suspendisse lorem sed lectus porttitor hendrerit Aenean sit ac nibh. nisl tempor a est. consectetur morbi tristique Duis massa mauris malesuada suscipit purus aliquet. Lorem Mauris",
    "town_or_city": "sem finibus ipsum est. egestas. vestibulum. Duis porttitor aliquet. sollicitudin ac volutpat suscipit morbi hendrerit at dolor a interdum. amet purus bibendum. non elit. massa lectus mauris non Pellentesque tempor ac in Sed risus lorem Lorem senectus leo vel Nam turpis Quisque Suspendisse ac dolor nisl orci sit et nibh. molestie consectetur eu sed tristique fames tempor pellentesque Ut imperdiet ultricies scelerisque. sagittis Aenean ac molestie malesuada eros. Ut et eu tristique libero. netus interdum. Nam cursus risus adipiscing vel nibh habitant"
  },
  "document_type": "content_block_postal_address",
  "first_published_at": "2013-08-21T22:14:47+00:00",
  "last_edited_at": "2018-09-07T14:14:20+00:00",
  "links": {
    "policy_areas": [
      "b7579923-c6df-1f34-aaa4-12fe8fa0f5b7",
      "a036b2fe-af16-10e5-accd-35f122f6ee24",
      "acceec0d-92e3-1e00-aebf-9059ff3c0545",
      "3e5d2bda-c45e-1b96-a15e-c309273c53f7",
      "e17a36e4-286b-14c5-aab1-7bd6beec0fce",
      "93f3f2f3-bee1-1a6e-ab9a-98d9668d0f59"
    ],
    "primary_publishing_organisation": [
      "ebaffb57-d62f-1abc-a497-bfff6d046c01"
    ]
  },
  "locale": "ps",
  "public_updated_at": "2021-03-01T22:17:10+00:00",
  "publishing_app": "feedback",
  "rendering_app": null,
  "schema_name": "content_block_postal_address",
  "title": "sit Sed bibendum. interdum. Nam Duis scelerisque. senectus turpis Lorem Pellentesque Quisque aliquet. cursus adipiscing eu non egestas. sollicitudin et eu amet suscipit sagittis est. sed leo mauris Nam purus ac ac malesuada Ut tristique volutpat nibh Aenean lectus finibus libero. imperdiet",
  "update_type": "major"
}

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

Attributes

bulk_publishing
boolean
links
object
finder
 Powers links from content back to finders the content is surfaced on
lead_organisations
 DEPRECATED: A subset of organisations that should be emphasised in relation to this content item. All organisations specified here should also be part of the organisations array.
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.
original_primary_publishing_organisation
 The organisation that published the original version of the page. Corresponds to the first of the ‘Lead organisations’ in Whitehall for the first edition, and is empty for all other publishing applications.
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.
suggested_ordered_related_items
 Used for displaying related content on most pages, except for step-by-step and fatality notices. Links and their ordering are determined by the machine learning algorithms.
taxons
 Prototype-stage taxonomy label for this content item
previous_version
string

View this schema on GitHub

Random example

{
  "bulk_publishing": true,
  "links": {
    "lead_organisations": [
      "feb8cab4-bdc2-17e6-a7a8-c0fea6ef5174"
    ],
    "organisations": [
      "aaa5b4b9-0cdf-15a4-ab3a-deae7bad5ed3",
      "cd8e6cbd-31c3-1450-ae6d-da3ce6e5d3da",
      "f01afd8d-d045-1efb-a2ef-9f0c41d942c3",
      "c7a3aaec-3f6a-154b-a4aa-d1d71e255db6"
    ],
    "parent": [

    ],
    "suggested_ordered_related_items": [
      "a8fcd3d4-9c28-1c22-aa92-cfeaed226c5a",
      "21eaedea-11fb-173d-ae1b-3e6f10367a48",
      "16aaa975-c681-13f5-a9a6-a7b3dcdb4f55",
      "fb35efc3-1bec-1eab-a9bf-06ff1cbe91fa"
    ]
  }
}