API Docs

Ex Libris Developer Network Alma Documentation REST APIs API Docs

Retrieve Letter

Contents

Resource URL
API Description
URL Parameters
Query string Parameters
Body Parameters
Output
Possible Error Codes

This API retrieves details for a single Letter.

Resource URL

GET /almaws/v1/conf/letters/{letterCode}

API Description

WADL documentation: Download
Swagger (OpenAPI) documentation: Download

URL Parameters

Parameter	Type	Description
`letterCode`	xs:string	The code of the letter.

Querystring Parameters

None

Body Parameters

None

Output

This method returns a Library object. See doc

Possible Error Codes

Code	Message
402119	General error.
40166411	Letter code is not valid.
60344	Problem retrieving letter data.