Canllawiau

Gofynion Gwasanaeth Gwrandawiadau’r Llysoedd a'r Tribiwnlysoedd API

Diweddarwyd 15 Gorffennaf 2026

Yn berthnasol i Loegr, yr Alban a Chymru

1. Rhagair

Mae gwasanaeth gwrandawiadau’r Llysoedd a’r Tribiwnlysoedd yn cefnogi ymrwymiad GLlTEF i gyfiawnder agored. Trwy foderneiddio a gwella mynediad y cyhoedd at wybodaeth a ddarperir gan GLlTEF. Cyhoeddi neu arddangos gwybodaeth llys/tribiwnlys (fel rhestrau’r llysoedd a’r tribiwnlysoedd), yn unol â’r gofynion polisi a’r rheolau busnes perthnasol.

Mae gan y gwasanaeth y gallu i integreiddio â’r systemau ffynhonnell i dderbyn data, neu ddogfennau, gan dynnu’r angen i ffwrdd ar gyfer hen brosesau cyhoeddi neu rai gyda llaw.

Fel rhan o’r gwasanaeth hwn, rydym wedi datblygu API am allan sy’n galluogi GLlTEF i anfon gwybodaeth i sefydliadau trydydd parti.

O fewn y ddogfen hon, byddwn yn darparu chi gyda throsolwg lefel uchel o’r gwasanaeth, a mwy o fanylder am ein API am allan a strwythur y ffeiliau rydym yn derbyn ac yn anfon.

2. Trosolwg o CaTH

Y weledigaeth ar gyfer CaTH yw “Cefnogi’r ymrwymiad GLlTEF i gyfiawnder agored ac i foderneiddio a gwella mynediad y cyhoedd at wybodaeth a ddarperir gan GLlTEF trwy gyhoeddi neu arddangos gwybodaeth am y llys/tribiwnlys (fel rhestrau’r llysoedd a’r tribiwnlysoedd) yn unol â’r gofynion polisi a’r rheolau busnes perthnasol.”

Yn y bôn, mae CaTH yn system sy’n galluogi awdurdodaethau i rannu cyhoeddiadau i roi siop un stop i ddefnyddwyr allanol i weld gwybodaeth a gyhoeddir gan GLlTEF.

Delwedd CaTH Image 1 – “What is CaTH” – Cynrychiolaeth fras o Broses Graidd y CaTH  

Diagram yn dangos pib linellau data i system rheolau busnes sy’n cynhyrchu rhestrau cyhoeddus dyddiol, rhestrau achosion sifil a rhestrau SJP.

Mae’r gwasanaeth CaTH wedi’i ddatblygu i fynd i’r afael ag anghysondebau ledled y maes o ran beth sy’n cael ei gyhoeddi gan amryw awdurdodaethau. Nod y gwasanaeth hwn yn dod y dulliau hyn ynghyd mewn un datrysiad unedig.

Mae gwybodaeth fel arfer yn cael ei derbyn fel “payload” (pecyn o wybodaeth mewn fformat JSON) a’i harddangos trwy ganllawiau arddull o fewn y gwasanaeth ei hun neu drwy fersiynau PDF fel rhan o danysgrifiadau.

Cyfrifoldeb perchennog y “payload” / cyhoeddiad yw sicrhau bod y “payload” wedi’i olygu’n briodol ac wedi mynd trwy’r Fframwaith Rheoli Risg GLlTEF angenrheidiol. Bydd unrhyw ddata o fewn y “payload” yn cael ei arddangos yn seiliedig ar ei ganllaw arddull cysylltiedig. Nid yw’r CaTH yn trin data.

Wrth dderbyn “payload” bydd y CaTH yn gwirio’r holl feysydd gorfodol a bod y penawdau wedi’i cynnwys ar gyfer y canllaw arddull cysylltiedig. Bydd y gwiriad hyn yn cael ei wneud yn seiliedig ar ‘schema dilysu’. Os bydd yn methu’r gwiriad hwn, yna ni fydd y cyhoeddiad yn cael ei gyhoeddi, a bydd neges yn cael ei dychwelyd gan nodi rhesymau am y methiant.

3. Egwyddorion cyhoeddi

Mae’r CaTH wedi’i ddylunio gyda 5 egwyddor dylunio gwaelodol y mae’n rhaid glynu atynt.

Egwyddorion Cyhoeddi:

• Rydym yn Cyhoeddi mewn Lleoliad
• Rydyn yn Cyhoeddi am Gyfnod
• Gellir tanysgrifio i’r holl gyhoeddiadau (ond mae wedi’i gyfyngu yn amodol ar y “Sensitifrwydd”
• Rhaid bod gan yr holl Gyhoeddiadau “sbardun”
• Gall yr holl Gyhoeddiadau gael eu Disodli

3.1 Cyhoeddi mewn lleoliad

Gall y CaTH gyhoeddi ar sawl lefel wahanol fel y dangosir yn fras yn y ddelwedd isod, ond o dan y ddealltwriaeth bod cyhoeddiadau ar gyfer y math hynny o restr yn parhau i fod yn gyson. E.e. Ni fyddem yn disgwyl cyhoeddi’r un cynnwys ar ran Llys Sirol Basildon a Llys Cyfun Basildon o dan 2 leoliad gwahanol - byddai angen un “payload” ar gyfer pob lleoliad.

Mapiau o’r Deyrnas Unedig yn dangos cwmpas llysoedd cenedlaethol yn erbyn rhanbarthol, gydag eiconau ar gyfer un adeilad llys a llysoedd lluosog.

3.2 Cyhoeddi am gyfnod

Mae’r CaTH wedi’i adeiladu i fod y platfform technegol i wasanaethu anghenion awdurdodaethau gwahanol a gwahanol fathau o gyhoeddiadau. Mae amryw fathau o gyhoeddiadau sy’n cael eu cyhoeddi/cylchredeg ar draws llawer o gyfnodau gwahanol, weithiau gyda’r cyfnodau hyn yn gorgyffwrdd (fel yn ddyddiol, yn wythnosol (a all gynnwys y cynnwys o’r un dyddiol), ac yn fisol (a all gynnwys y cynnwys dyddiol ac wythnosol)).

Mae cyhoeddiadau wedi’u dangos a’i dal o fewn CaTH am gyfnod y gellir ei ffurfweddu. Mae dyddiadau “display-from” a “display-to” wedi’u darparu gan y system ffynhonnell pan fydd yn ei hanfon i CaTH.

Gall CaTH ymdrin â’r heriau hyn ymhellach trwy ganiatáu gwasanaethau i gynnwys dyddiad y cynnwys e.e. bydd dyddiad  y gwrandawiadau neu ddyddiad y cyhoeddiad yn cael ei gyhoeddi.

Mae’r her hon wedi’i rheoli ymhellach trwy alluogi awdurdodaethau i enwi eu mathau o gyhoeddiadau, ac felly’n galluogi i’r defnyddiwr i wahaniaethu rhyngddynt o ran y cyfnod maen nhw’n ymwneud ag ef e.e. Rhestr ddyddiol, Rhestr wythnosol.

3.3 Dosbarthiadau’r cyhoeddiadau

Mae CaTH yn wasanaeth cyhoeddus a rhad ac am ddim sydd ar gael i ddefnyddwyr sy’n cynnwys aelodau o’r cyhoedd, defnyddwyr proffesiynol ac aelodau achrededig o’r cyfryngau. Fodd bynnag, nid yw’r holl gyhoeddiadau mae GLlTEF yn cyhoeddi, neu a fydd yn cyhoeddi, ar gael yn gyhoeddus.  Gan gadw hyn mewn cof, rhaid i gyhoeddiadau gynnwys graddfa ‘sensitifrwydd’ fel bod CaTH yn gwybod sut i ddosbarthu’r cyhoeddiad ac i ba defnyddwyr y dylid ei wneud ar gael iddynt.

Mae’r isod yn disgrifio tair lefel wahanol o ddosbarthiadau. Bydd y system ffynhonell yn gosod sensitifrwydd y cyhoeddiad a bydd CaTH yn ei gyhoeddi’n unol â hynny.

Pyramid yn dangos lefelau gwybodaeth: Cyhoeddus i bob defnyddiwr, Preifat i ddefnyddwyr wedi’u dilysu, Cyfrinachol i ddefnyddwyr dethol.

3.4 Gall yr holl gyhoeddiadau gael eu disodli

Er mwyn cefnogi awdurdodaethau i ddiweddaru cyhoeddiad, gall “payloads” ddisodli “payloads” sydd eisoes yn bodoli heb yr angen i ddileu’r hen un neu gyhoeddi un newydd.  Bydd cyhoeddi eto (cyn belled bod meysydd allweddol yn cyd-fynd) yn sicrhau bod disodli yn digwydd.

Enghraifft o hyn fyddai bod un gwrandawiad wedi’i ddad-restru a rhaid cyhoeddi rhestr newydd heb y gwrandawiad sydd wedi’i ddad-restru

Bydd hyn ond yn digwydd os bydd 5 o’r meysydd allweddol yn cyd-fynd (gweler isod). Lle nad yw pob un o’r 5 maes yn cyd-fynd, bydd ail gyhoeddiad ar gael i’w arddangos.

1. Tarddiad (y system ffynhonnell),
2. Math (fel “Rhestr Ddyddiol Llys y Goron”),
3. Rhif Adnabod Lleoliad
4. Iaith (i sicrhau nad ydym yn disodli fformatau ieithoedd amgen)
5. Dyddiad y cynnwys.

4. Trydydd parti - API am allan

Bydd yr adran hon yn darparu manylion o beth a sut byddwn yn anfon gwybodaeth atoch.

Yr hyn sy’n dilyn yw ein ffordd gyfredol o anfon a dilysu gyda 3ydd partïon. Os oes arnoch angen unrhyw beth yn ychwanegol i hyn e.e. mecanweithiau dilysu gwahanol, bydd hyn yn golygu newid ar ein ochr ni a bydd angen cael ei drafod a’i gymeradwyo trwy sianelau llywodraeth yn GLlTEF.

Noder - Bydd y cyhoeddiadau a gewch yn ddibynnol ar y mathau o restrau a’r lefel sensitifrwydd cysylltiedig fel y cytunwyd fel rhan o’r broses gynefino.

4.1 Trosolwg

Bydd CaTH yn derbyn “payload” o system ffynhonnell. Ar y cyfan rydym yn derbyn ffeiliau JSON o systemau ffynhonnell, fodd bynnag, gallwn ac yn achlysurol byddwn yn dderbyn ffeiliau fflat / crai, sy’n gallu bod yn un o’r mathau canlynol:

1. .csv
2. .doc
3. .docx
4. .htm
5. .html
6. .pdf

Bydd CaTH un ai’n anfon y JSON atoch neu un o’r ffeiliau fflat uchod trwy’r API am allan, ochr yn ochr â metadata yn disgrifio’r ffeil.

Os yw cyhoeddiad yn cael ei ddileu â llaw yn CaTH, er enghraifft mae wedi’i gyhoeddi gyda chamgymeriad ynddo, byddwn hefyd yn eich hysbysu ei fod wedi’i ddileu.

4.2 Mecanwaith hysbysu

Bydd CaTH yn eich hysbysu am yr uchod trwy HTTP REST. Gyda’r URL a darparwch, byddwn yn eich hysbysu fel a ganlyn:

Math o Hysbysiad	Dull Gwneud Cais
Cyhoeddiad Newydd	POST
Diweddariad i Gyhoeddiad Presennol (Disodli)	PUT
Dileu Cyhoeddiad	DELETE

4.3 Pwyntiau terfyn

I alluogi cysylltiadau gyda CaTH, mae’n ofynnol i chi sefydlu’r pwyntiau terfyn canlynol gyda’r fformatau URL isod:

Dull Gwneud Cais	Llwybr URL
GET	BaseURL
POST	BaseURL
PUT	BaseURL>/<PublicationID
DELETE	BaseURL>/<PublicationID

Y Rhif Adnabod cyhoeddi a amlygir yn y ceisiadau PUT / DELETE fydd yr un rhif adnabod cyhoeddi a anfonwyd yn y metadata fel rhan o’r cyhoeddiad gwreiddiol, newydd.

Defnyddir y pwynt terfyn GET fel pwynt terfyn gwirio i brofi eich cysylltiad gyda ni.  Defnyddiwr y pwyntiau terfyn  POST / PUT / DELETE gan CaTH i anfon cyhoeddiadau / hysbysiadau atoch.

4.4 Corff y cais

Y math o gynnwys ar gyfer y ceisiadau POST a PUT fydd: multipart/form-data.

Noder - Ni fyddai’r cais GET a DELETE yn cynnwys corff,  yn hytrach dylai’r rhif adnabod yn yr URL gael ei ddefnyddio i adnabod y cyhoeddiad i’w ddileu.

Mae corff y cais POST / PUT yn cynnwys y rhannau canlynol:

Part / Rhan	Mandatory / Gorfodol	Description / Disgrifiad
metadata	Yes / Ie	Yn cynnwys y metadata JSON am y cyhoeddiad. Gweler adran 2.4.1 ar gyfer y strwythur JSON
payload	No / Na	Cyflwyno os yn anfon cyhoeddiad JSON. Dyma’r JSON crai rydym yn ei dderbyn, neu’r JSON wedi’i drosi pan fyddwn yn derbyn ffeil Excel
ffeil	No / Na	Cyflwyno os yn anfon ffeil fflat / crai

Mae’r tabl canlynol yn disgrifio mathau cynnwys posib pob rhan:

Rhan	Math o ffeil	Math o MIME
metadata	Amherthnasol	application/json
payload	AMH	application/json
ffeil	.pdf	application/pdf
	.csv	text/csv
	.doc	application/msword
	.docx	application/vnd.openxmlformats-officedocument.wordprocessingml.document
	.htm neu .html	text/html

4.5 Rhan: metadata

Mae’r tabl canlynol yn manylu ar bob eitem yn y metadata JSON:

Allwedd	Disgrifiad	Math
publicationId	Yr UUID sy’n rhif adnabod unigryw i’r cyhoeddiad Bydd hwn yn cael ei anfon mewn ceisiadau PUT / DELETE dilynol	UUID
listType	Y rhestr y mae’r cyhoeddiad ar ei gyfer, gweler adran 2.5 am fanylion	String (gweler adran 2.5)
locationName	Enw’r lleoliad y mae’r cyhoeddiad ar ei gyfer	String
contentDate	Y dyddiad y mae’r cyhoeddiad ar ei gyfer. Ar gyfer cyhoeddiadau sy’n ymwneud â sawl tabl, dyma dyddiad cyntaf y cyhoeddiad	ISO 8061 fformat dyddiad / amser
Sensitifrwydd	Sensitifrwydd y cyhoeddiad - gweler adran 1.3 am fanylion	String (CYHOEDDUS, PREIFAT NEU DDOSBARTHIADOL)
iaith	Iaith y cyhoeddiad	String (SAESNEG, CYMRAEG neu DDWYIEITHOG)
displayFrom	O pryd mae’r cyhoeddiad ar gael i ddefnyddwyr ei weld	ISO 8061 fformat dyddiad / amser
displayTo	Tan pryd mae’r cyhoeddiad ar gael i ddefnyddwyr ei weld	ISO 8061 fformat dyddiad / amser

Ceir enghraifft o ran o ‘metadata’ fel a ganlyn:

{

  “publicationId”: “29e7432d-9c9f-4cb0-bdf9-06f9d4465dc9”,

  “listType”: “CIVIL_DAILY_CAUSE_LIST”,

  “locationName”: “Canolfan Llysoedd Cyfun Norwich”,

  “contentDate”: “2025-02-05T00:00:00Z”,

  “sensitifrwydd”: “CYHOEDDUS”,

  “iaith”: “ENGLISH”,

  “displayFrom”: “2024-04-05T00:00:00Z”,

  “displayTo”: “2024-04-05T00:00:00Z”,

}

4.6 Rhan: payload

Os bydd data mae CaTH yn ei dderbyn yn JSON (neu os yw’n Excel ac yn cael ei throsi i JSON), bydd hyn yn cael ei anfon trwy’r rhan ‘payload’ o’r corff. Ar gyfer cyhoeddiadau ffeiliau fflat, byddai gwerth y payload yn nwl.

Mae’r strwythur / schema ar gyfer y JSON hwn yn benodol i’r Math o Restr (a anfonwyd yn y metadata, gweler adran 2.5 i gael mwy o fanylion). Gellir dod o hyd i schemas ar gyfer pob un o’r mathau o restrau yma: https://github.com/hmcts/pip-data-management/tree/master/src/main/resources/schemas

4.7 Rhan: ffeil

Os yw’r data mae CaTH yn ei dderbyn yn ffeil fflat / crai, bydd yn cael ei anfon drwy’r rhan ‘ffeil’ o’r corff, a gellir dod o hyd i manylion y mathau ffeil posib yn adran 2.3.

Bydd enw’r ffeil yn UUID a gynhyrchir ar hap, a’r estyniad ffeil. Byddai gwerth y ffeil yn nwl ar gyfer cyhoeddiad JSON.

4.8 Mathau o restrau

Fel y gellir ei weld yn adran 2.4.1, byddwn yn anfon y Math o Restr atoch yn y metadata sy’n adnabod ar gyfer pa restr y mae’r data. Gellir dod o hyd i restr lawn o’r mathau o restrau yma: https://github.com/hmcts/pip-data-management/tree/master/src/main/resources/schemas

Noder - gellir ychwanegu rhestrau newydd ac felly mae’r uchod yn destun newid.  Mae’r mathau o restrau a gewch yn ddibynnol ar y tanysgrifiadau y cytunwyd arnynt ar gyfer eich cyfrif chi.

4.9 Dileu cyhoeddiadau

Fel yr amlygir yn adran 2.2, byddwn yn eich hysbysu trwy gais DELETE os yw cyhoeddiad wedi’i ddileu â llaw o CaTH.

Ni fyddwn yn eich hysbysu pan fydd cyhoeddiad wedi dod i ben (pan fydd y dyddiad ‘displayTo’ yn y metadata wedi cyrraedd)

4.10 Dilysu

Ar hyn o bryd rydym yn cefnogi dilysu OAuth trwy’r API, gan ddefnyddio’r llif cymeradwyo manylion mewngofnodi cleient i gynhyrchu tocyn a fydd yn cael ei anfon yn y cais.

Mae arnom angen y pethau canlynol gennych i gefnogi hyn:

• Rhif Adnabod Cleient
• Cyfrinach Cleient (Client Secret)
• Cwmpas
• URL y Tocyn (i wneud cais am y tocyn)

Wrth wneud y cais eich hun, byddwch yn defnyddio’r uchod i wneid cais am docyn deilydd. Yna bydd hwn yn cael ei anfon drwy’r pennawd ‘Awdurdodi’.

4.11 Ceisio eto

Os bydd ymateb yn nodi methiant yn cael ei ddychwelyd gan y trydydd parti, bydd CaTH yn ceisio anfon y cyhoeddiad eto, tair gwaith.

4.12 Ymatebion

Nid ydym yn disgwyl unrhyw beth yn y corff yn yr ymateb gan y trydydd parti, ac ni fyddwn yn ei brosesu.

O ran y cod ymateb, rydym yn rhagweld i ymateb 2xx gael ei ddychwelyd. Os bydd unrhyw beth arall yn cael ei ddychwelyd, bydd yn ceisio eto fel a nodir yn yr adran uchod.

4.13 Cyhoeddiadau gyda dyddiad yn y dyfodol

Mae’r bosib i CaTH dderbyn cyhoeddiadau gyda dyddiad yn y dyfodol, h.y. cyhoeddiadau lle mae’r dyddiad i gychwyn ei ddangos yn y dyfodol.

Yn y sefyllfa hon, bydd CaTH yn anfon y cyhoeddiad am 1AM UTC ar y bore cyntaf bydd y cyhoeddiad yn weithredol.

5. Beth sydd arnom angen gennych chi

I sefydlu eich cyfrif a dechrau derbyn cyhoeddiadau, mae arnom angen yr hyn a ganlyn gennych:

• URL hafan i anfon cyhoeddiadau ato
• Manylion dilysu (gweler adran 2.7)

Wrth anfon y manylion dilysu atom trwy e-bost, dylech amgryptio’r ffeil sy’n cynnwys yr wybodaeth trwy ddefnyddio GnuPG (a elwir hefyd yn GPG).  

Bydd hyn yn cynhyrchu par allwedd GPG cyhoeddus/preifat ar ein ochr ni, a bydd y ffeil sy’n cynnwys yr allwedd gyhoeddus yn cael ei rhannu gyda chi. Dylech fod yn defnyddio’r allwedd gyhoeddus hon i amgryptio’r ffeil testun gyda’r manylion dilysu. Atodwch y ffeil wedi’i hamgryptio mewn e-bost gan ddefnyddio’r un cyfeiriad e-bost a ddefnyddiwyd gennych i greu eich cyfrif gyda ni.

Pan fyddwch wedi derbyn y data gennych, byddwn yn defnyddio’r allwedd breifat i ddadgryptio’r ffeil i gael y manylion dilysu. 

Cyfeiriwch at y ddogfennaeth ar-lein canlynol ar sut i ddefnyddio GPG i amgryptio:

https://www.gnupg.org/documentation/index.html