diff --git a/api/publication-log.md b/api/publication-log.md index 8426631..5420671 100644 --- a/api/publication-log.md +++ b/api/publication-log.md @@ -33,20 +33,20 @@ The fields that appear in Publication Log entries are: |Field|Representing element|Meaning| |---|---|---| -|Entry ID|``|{::nomarkdown}

A unique identifier for the event.

Note: the Publication Log records the (dis)association of a UK Impact Assessment with an item of legislation as two separate entries (one for the UKIA-legislation association, and one for the legislation-UKIA association). These entries have the same Entry ID, but different Item IDs (one for the legislation item and the other for the UKIA){:/}| +|Entry ID|``|{::nomarkdown}

A unique identifier for the event.

Note: the Publication Log records the (dis)association of a UK Impact Assessment with an item of legislation as two separate entries (one for the UKIA-legislation association, and one for the legislation-UKIA association). These entries have the same Entry ID, but different Item IDs (one for the legislation item and the other for the UKIA)

{:/}| |Item ID|``|The identifier of the item of legislation or UK Impact Assessment which the resource manifests or to which it is associated.| |Updated|``|The date and time at which the event (publication or withdrawal) occurred.| -|Published|``|{::nomarkdown}

If present, the first date and time at which a resource was published at this URI.

Note: Due to deficiencies in the admin log, which recorded publication events before the Publication Log was released, some resources were published to legislation.gov.uk without a log entry. If this field is absent, it means that the resource was not previously published on or after 5th July 2023, but might have been published before that date. If this field is present, the date may not be the true date and time of original publication if it is on or after 5th July 2023.{:/}| +|Published|``|{::nomarkdown}

If present, the first date and time at which a resource was published at this URI.

Note: Due to deficiencies in the admin log, which recorded publication events before the Publication Log was released, some resources were published to legislation.gov.uk without a log entry. If this field is absent, it means that the resource was not previously published on or after 5th July 2023, but might have been published before that date. If this field is present, the date may not be the true date and time of original publication if it is on or after 5th July 2023.

{:/}| |Title|``|The title of the resource. This is usually the title of the legislation item, but for associated documents it will normally be the title of the associated legislation item followed by the type of the associated document.| -|Author|``|{::nomarkdown}

The publisher of the resource.

Note: the Publication Log always shows the author for XML versions of revised legislation as editorial.legislation.gov.uk, but in the XML for the revised legislation itself the value of dc:publisher is usually Statute Law Database.{:/}| +|Author|``|{::nomarkdown}

The publisher of the resource.

Note: the Publication Log always shows the author for XML versions of revised legislation as editorial.legislation.gov.uk, but in the XML for the revised legislation itself the value of dc:publisher is usually Statute Law Database.

{:/}| |Content type|``|The type of content being published or withdrawn (`legislation`, `draft`, `associated-documents` or `changes`).| |Event|``|The type of event (`published` or `withdrawn`).| -|Republished|``|{::nomarkdown}

Indicates whether the resource has ever previously been published at this URI.

Note: Due to deficiencies in the admin log, which recorded publication events before the Publication Log was released, some resources were published to legislation.gov.uk without a log entry. If the value of this field is `false`, it means that the resource was not previously published on or after 5th July 2023, but might have been published before that date{:/}| +|Republished|``|{::nomarkdown}

Indicates whether the resource has ever previously been published at this URI.

Note: Due to deficiencies in the admin log, which recorded publication events before the Publication Log was released, some resources were published to legislation.gov.uk without a log entry. If the value of this field is `false`, it means that the resource was not previously published on or after 5th July 2023, but might have been published before that date

{:/}| |New|``|Indicates whether the item of legislation existed on legislation.gov.uk before this publication event.| |Newly issued|``|Indicates whether a new item of legislation has just been issued (is actually “new”), or whether it was issued in the past but has only just been uploaded.| |Document|``|The [expression](../model/legislation.md#frbr-functional-requirements-for-bibliographic-records) (version) of the item that the resource manifests. For associated documents, this will normally be the same as the Item.| |Link|``|For XML resources, a link to an alternate representation of the resource.| -|Item|{::nomarkdown}<pbl:Item_Published>
<pbl:Item_Withdrawn>{:/}|The URI of the resource being published or withdrawn.| +|Item|{::nomarkdown}<pbl:Item_Published>
<pbl:Item_Withdrawn>{:/}|The URI of the resource being published or withdrawn.| |Format|``|The format of the resource (`xml`, `pdf` or `html5`).| |Print|``|Indicates whether a legislation PDF represents the version of the document that is to be printed.| |Direction|``|For changes, indicates whether the effects were updated for the affecting or affected item.| @@ -56,8 +56,8 @@ The fields that appear in Publication Log entries are: |Year|``|The year of the item to which the resource relates.| |Number|``|The number of the item (in its primary numbering series) to which the resource relates.| |ISBN|``|For legislation items that are not numbered, the ISBN of the item of legislation to which the resource relates.| -|Alternative number|``|{::nomarkdown}

A number in an alternative numbering series for the item to which the resource relates.

Note: this field does not appear for entries for associated documents or changes, even if it applies to the related item of legislation.{:/}| -|Supersedes|``|{::nomarkdown}

For legislation that supersedes other legislation, the item of legislation superseded by the item to which the resource relates.

Note: this field does not appear for entries for associated documents or changes, even if it applies to the related item of legislation.{:/}| +|Alternative number|``|{::nomarkdown}

A number in an alternative numbering series for the item to which the resource relates.

Note: this field does not appear for entries for associated documents or changes, even if it applies to the related item of legislation.

{:/}| +|Supersedes|``|{::nomarkdown}

For legislation that supersedes other legislation, the item of legislation superseded by the item to which the resource relates.

Note: this field does not appear for entries for associated documents or changes, even if it applies to the related item of legislation.

{:/}| ## Filtering @@ -70,11 +70,11 @@ The Publication Log feeds support the following path parameters: |Parameter|Filters|Permitted values|Examples| |---|---|---|---| |Date|The date on which the event occurred (from the `` field)|A date in `yyyy-mm-dd` format|[https://www.legislation.gov.uk/update/2023-07-07/data.feed](https://www.legislation.gov.uk/update/2023-07-07/data.feed)| -|Content type|The type of content to which the event relates|{::nomarkdown}One of the following values:
  • legislation
  • draft
  • associated-documents
  • changes
    • {:/}|[https://www.legislation.gov.uk/update/draft/data.feed](https://www.legislation.gov.uk/update/draft/data.feed)| -|Direction|**For effects only:** Whether the effects were recorded against the affecting item or the affected item|{::nomarkdown}One of the following values:
    • affecting
    • affected
      • {:/}|[https://www.legislation.gov.uk/update/changes/affected/data.feed](https://www.legislation.gov.uk/update/changes/affected/data.feed)| -|Document category|**For legislation and associated documents:** The category of legislation|{::nomarkdown}One of the following values:
      • primary
      • secondary
      • eu-origin
        • {:/}|[https://www.legislation.gov.uk/update/legislation/eu-origin/data.feed](https://www.legislation.gov.uk/update/legislation/eu-origin/data.feed)| +|Content type|The type of content to which the event relates|{::nomarkdown}One of the following values:
        • legislation
        • draft
        • associated-documents
        • changes
        {:/}|[https://www.legislation.gov.uk/update/draft/data.feed](https://www.legislation.gov.uk/update/draft/data.feed)| +|Direction|**For effects only:** Whether the effects were recorded against the affecting item or the affected item|{::nomarkdown}One of the following values:
        • affecting
        • affected
        {:/}|[https://www.legislation.gov.uk/update/changes/affected/data.feed](https://www.legislation.gov.uk/update/changes/affected/data.feed)| +|Document category|**For legislation and associated documents:** The category of legislation|{::nomarkdown}One of the following values:
        • primary
        • secondary
        • eu-origin
        {:/}|[https://www.legislation.gov.uk/update/legislation/eu-origin/data.feed](https://www.legislation.gov.uk/update/legislation/eu-origin/data.feed)| |Document main type|The type of the document to which the resource relates|One of the values in the “Document Main Type” column of the [legislation types](../model/uris.md#legislation-types) table|[https://www.legislation.gov.uk/update/2023-07-05/wsi/data.feed](https://www.legislation.gov.uk/update/2023-07-05/wsi/data.feed) (Document main type = wsi)| -|Treaty name|**For EU treaties only:** The short name of the EU treaty|{::nomarkdown}One of the following values:
        • teec
        • euratom
        • teu
        • eea-agreement
        • withdrawal-agreement
          • {:/}|[https://www.legislation.gov.uk/update/eut/withdrawal-agreement/data.feed](https://www.legislation.gov.uk/update/eut/withdrawal-agreement/data.feed)| +|Treaty name|**For EU treaties only:** The short name of the EU treaty|{::nomarkdown}One of the following values:
          • teec
          • euratom
          • teu
          • eea-agreement
          • withdrawal-agreement
          {:/}|[https://www.legislation.gov.uk/update/eut/withdrawal-agreement/data.feed](https://www.legislation.gov.uk/update/eut/withdrawal-agreement/data.feed)| |Year|The year assigned to the document|A four digit year|[https://www.legislation.gov.uk/update/2014/data.feed](https://www.legislation.gov.uk/update/2014/data.feed)| |Regnal year|**For regnal year-numbered items only:** The monarch and session assigned to the document|A regnal year string (see examples)|[https://www.legislation.gov.uk/update/legislation/ukpga/Eliz2/6-7/51/data.feed](https://www.legislation.gov.uk/update/legislation/ukpga/Eliz2/6-7/51/data.feed) (Regnal = Eliz2/6-7)| |Number|The number assigned to the document in its main numbering series|A whole number greater than or equal to 0|[https://www.legislation.gov.uk/update/2023-07-06/2022/231/data.feed](https://www.legislation.gov.uk/update/2023-07-06/2022/231/data.feed) (Number = 231)| @@ -86,7 +86,7 @@ The Publication Log feeds support the following query parameters: |Parameter|Filters|Permitted values| |---|---|---| |event|The type of event|`published` or `withdrawn`| -|new|{::nomarkdown}

          For items of legislation and UK Impact Assessments: whether the item of legislation or UK Impact Assessment associated with the event is new to legislation.gov.uk.

          For other associated documents: whether the associated document has been published before at this URI.{:/}|`true` or `false`| +|new|{::nomarkdown}

          For items of legislation and UK Impact Assessments: whether the item of legislation or UK Impact Assessment associated with the event is new to legislation.gov.uk.

          For other associated documents: whether the associated document has been published before at this URI.

          {:/}|`true` or `false`| |format|The format of the resource.|`xml`, `pdf` or `html5`| |language|A language of the resource.|`en` or `cy` (dual-language resources will match either value)| |title|The title of the resource or the document to which it is associated, or any contiguous sequence of words within its title.|Any text string| diff --git a/api/search.md b/api/search.md index a681c71..f1b703d 100644 --- a/api/search.md +++ b/api/search.md @@ -138,7 +138,7 @@ You can specify the following sort orders for a legislation search/list using th |Name|Order| |---|---| -|`published`|{::nomarkdown}

          Sort by first publication date/time descending\*, then category (EU, then primary, then secondary), then year descending, then number descending, then enacted/made date descending

          (\* If a correction slip has been issued for a document, the first publication date will be treated as the issuance date of the most recent correction slip for the document, not the date the document was originally published.){:/}| +|`published`|{::nomarkdown}

          Sort by first publication date/time descending\\\*, then category (EU, then primary, then secondary), then year descending, then number descending, then enacted/made date descending

          (\\\* If a correction slip has been issued for a document, the first publication date will be treated as the issuance date of the most recent correction slip for the document, not the date the document was originally published.)

          {:/}| |`title`|Sort by title ascending in alphabetical order, then category (EU, then primary, then secondary), then year descending, then number descending, then enacted/made date descending| |`modified`|Sort by last modified date descending, then category (EU, then primary, then secondary), then year descending, then number descending, then enacted/made date descending| |`created`|Sort by category (EU, then primary, then secondary), then year descending, then enacted/made date descending| diff --git a/what-we-have.md b/what-we-have.md index fb42933..336246c 100644 --- a/what-we-have.md +++ b/what-we-have.md @@ -65,7 +65,7 @@ There are some types of legislation for which we do not record all changes (eith |Scottish Statutory Instruments (1999–)|{::nomarkdown}

          All Scottish Statutory Instruments, except for Local Statutory Instruments and non-prints (all except Local and non-prints available as XML, most available as King’s Printer PDF)

          All Local and non-print Scottish Statutory Instruments since 2007 (only available as King’s Printer PDFs)

          {:/}|Yes, but only where available as XML|Yes|Yes| |Northern Ireland Statutory Rules (1974–)|{::nomarkdown}

          All Northern Ireland Statutory Rules since 1996, except for Local Statutory Instruments and non-prints (all except Local and non-prints available as XML, most available as King’s Printer PDF)

          All Local and non-print Northern Ireland Statutory Rules since 2011 (only available as King’s Printer PDFs)

          {:/}|Yes, but only where available as XML|Yes, but only for Northern Ireland Statutory Rules made from 1994 onwards|Yes| |UK Ministerial Directions (2023–)|All UK Ministerial Directions from 2023 onwards (only available as King’s Printer PDFs)|No|Yes|Yes| -|UK Ministerial Orders (1953–)|{::nomarkdown}

          All UK Ministerial Orders from 2013 onwards (only available as King’s Printer PDFs)

          Select UK Ministerial Orders from 1972 to 2012 (only available as King’s Printer PDFs){:/}|No|No|No| +|UK Ministerial Orders (1953–)|{::nomarkdown}

          All UK Ministerial Orders from 2013 onwards (only available as King’s Printer PDFs)

          Select UK Ministerial Orders from 1972 to 2012 (only available as King’s Printer PDFs)

          {:/}|No|No|No| ### Historical legislation types @@ -98,7 +98,7 @@ There are some types of legislation for which we do not record all changes (eith ## Limitations - Our database is both large and complex, with more than 300,000 items of legislation from data collections deriving from different sources. As a result, the content held within the database has some limitations. +Our database is both large and complex, with more than 300,000 items of legislation from data collections deriving from different sources. As a result, the content held within the database has some limitations. ### Missing legislation