Overview

Canonical Text Services is described as follows:

The Canonical Text Services protocol defines interaction between a client and server providing identification of texts and retrieval of canonically cited passages of texts.

The following site was used as a reference.

http://cts.informatik.uni-leipzig.de/Canonical_Text_Service.html

Usage

The following was used as a reference.

https://github.com/cite-architecture/cts_spec/blob/master/md/specification.md

GetCapabilities

A request to check the services supported by the server.

http://cts.informatik.uni-leipzig.de/pbc/cts/?request=GetCapabilities

<G/e<<Gtrr/eCee<rtaqpT/eCpule<<<<<<Tpaaeyxccccctelpbs>toooooe<<txyaitIrrrrrxgeet>bl>nppppptrd<<<<<<exIiiGvuuuuugoitlsplcdtnlteesssssrutiiouaoigviitnlslndopitcubnntreteCtioaaeunolerlgtionisaocunmspanenciueouteprergecm>secannposxayncu>rueuTe>agt>>r>mbseaPir>rh>hteTylite>gapnbnePti>y>nli>hert=i=utoapsivPt>ai"b"Bbpnre=teutalouluil:Db>"irbprlnrerbi/a<xhesl:be>n<nlc/t/mtsii/,lT:/:epellt<oc/chcgcDa>a<p/npeBetrtior1n/:r=Dabisosnma8gc/e"or,bB:u:al6uo/q5maclipppAil5anru.aleebbnbrne<gtee0ilslcaca<l/eels.ne,Ce:m:b/tp>natr<lcobebileutx>ctyrci>icixbTn.cempobb<ctlyg1ox,urll/e.ip."rtdspeetniceo>p.e<u".isna>ruiu/s>pteftgsn,cal>oi/lfeocre/onionroa>dnsc/gpnlaD/ed,utltasnafsaeattstinil/ereanan.>u>/,msarc<feret/r>1btuca1.rro,6nieri9oe/ptrv1uaume.s,n:d0smi""oyq>vuauixr,eamcrleutCn>sras,an:tnoagsn=lli",achutatkiltrop<nT:/se/c,x/otrrwephSluieascrxlhvnaignhc.gaeouvraehggt/ebtn>epse:/n/c/oacmstpssai.tgiinnbefidolri9mt0ay6t/iadkni.nfuofnteiar-telineotinpsIz/Si1Og.-.06d"3e9/x-pm3blcnc/soc:dtteses/i.<=/"Tshhotiutsrpc:Ce/T>/Swwiwn.stteain-cce.ocrogn/tnasi/n1s.02"0xbmilbnlse:dtcr=a"nhstltapt:i/o/npsurflr.oomrgP/BdCc/tehlaetmeanrtes/a1v.a1i/l"abxlmelnass:tPiu=b"lhitctpD:o/m/acihns..<h/acrovrapruds.deedsuc/rximpltniso/nc>ts">

GetPassage

Retrieves a specific portion of text based on a specified URN (Uniform Resource Name).

http://cts.informatik.uni-leipzig.de/pbc/cts/?request=GetPassage&urn=urn:cts:pbc:bible.parallel.eng.kingjames:1.3

<G/e<<Gtr/r/ePe<<re<<<<rtaqrrepuplsePsueeqlraiopaseqquynsculsasuue>>serysgteesuanc>ae>sstrgsegtt>nee>exNU:>>h>marcNPtlmntoutne>swbps>u:l:=Grpti/"enbhc/ht:ceptPc:Datatbsorpssiema:s:bral/aplpil/gbeenerec.n<le<:pt/tl/balearirwixxebaactnqllse.guelni.e.emsnosploefrta.r>ogNree//aandnmlgsasel.ut/>ekbaslit/t.nireglrunjecgattt.mhrukeairisneen:v/g1ae1j.nd.a3y0m<v"e/bisueax:ram1nsCl.>tan3ns<oo:/fnari=etc"qhahueltetsfTptie:Uex/rlt/ndr>Sewelhraivxcinhcge.tohhretgt/LpnO:sR//D/ccoGtmospd.aithniafbdoirlmmiaatdtyei/ka.nunnoit/-apltaeisiospnazsgi/eg1>..d0e"/pxbmcl/ncst:st/eiw=i"thhttCpT:S//UwRwNw.utreni:-cct.so:rpgb/cn:sb/i1b.l0e".>parallel.eng.kingjames:1.3</source>

GetPassagePlus

Similar to GetPassage, but also retrieves additional metadata (such as bibliographic information).

http://cts.informatik.uni-leipzig.de/pbc/cts/?request=GetPassagePlus&urn=urn:cts:pbc:bible.parallel.eng.kingjames:1.3

The response includes additional information such as label, groupname, prevnext navigation, and reff (list of citable sub-passages).

GetValidReff

Retrieves a list of valid references within a specified range for a particular text.

http://cts.informatik.uni-leipzig.de/pbc/cts/?request=GetValidReff&urn=urn:cts:pbc:bible.parallel.eng.kingjames:&level=1

The response returns a list of URNs for each valid reference at the specified level.

GetFirstUrn

http://cts.informatik.uni-leipzig.de/pbc/cts/?request=GetFirstUrn&urn=urn:cts:pbc:bible.parallel.eng.kingjames:

Returns the first URN in the text.

GetPrevNextUrn

http://cts.informatik.uni-leipzig.de/pbc/cts/?request=GetPrevNextUrn&urn=urn:cts:pbc:bible.parallel.eng.kingjames:1

Returns the previous and next URNs relative to the specified passage.

GetLabel

http://cts.informatik.uni-leipzig.de/pbc/cts/?request=GetLabel&urn=urn:cts:pbc:bible.parallel.eng.kingjames:1

Returns the label (human-readable title) for the specified passage.

Summary

There may be other request methods available, but we hope this serves as a useful reference.