Notes on the Canonical Text Service requests

CTS uses HTTP for its transport protocol. Requests are submitted as HTTP parameters; replies are returned as XML validating against the CTS reply schemas.

Summary of the requests and their optional parameters

All other requests require a parameter named urn that should be a syntactically valid CTS URN.

The following requests have no optional parameters

Request Reply
GetDescription Returns text identifying a work
GetPrevNextUrn Returns URN values of preceding and following citation nodes

The following requests have optional parameters

Request Reply Optional parameters
GetValidReff Returns valid citation values with the scope of the URN level specifies number of tiers of the citation hierarchy to include
GetPassage Returns text content of the cited passage context specifies number of citation units on either side of the passage to include
GetPassagePlus Returns a concatenation of the GetDescription, GetPassage and GetPrevNextUrn requests context specifies number of citation units on either side of the passage to include