Sign in
letter

Info for a specific letter

get/letter/{letterId}

Path parameters

letterIdnumber required

The id of the letter to retrieve

Response

Expected response to a valid request

idstring letterId required
namestring required
direction'received' | 'send' required

Direction

channelstring channelId required

Channel

finalboolean

The status of the letter, e.g. deciding about visibility in the collection

datastring date-time

Date of receipt / Date of dispatch

identifierstring

External identifier of letter / case

descriptionnumber

Description ID choose by content creator

institutionnumber[]
casestring caseId
orderingnumber
commentstring
excerptstring
tagsstring[]
createdOnstring datetime required
createdBystring required

User ID responsible for creating the content

modifiedOnstring datetime required
modifiedBystring required

Changes

Changed in 5 of the 16 revisions of this API.119

  • 09067c6a65871See the full diff
    • ○

      added the optional property description to the response with the 200 status

      response-optional-property-added

  • 019c3da29e4d1See the full diff
    • ●

      removed the optional property description from the response with the 200 status

      response-optional-property-removed

  • 652992eaa7d91See the full diff
    • ▲

      the description response's property type/format changed from descriptionId/ to number/ for status 200

      response-property-type-changed

  • d1aec2d6c45b1See the full diff
    • ○

      added the optional property description to the response with the 200 status

      response-optional-property-added

  • f16566c7c7ef7See the full diff
    • ○

      the response property attachment/items/id became required for the status 200

      response-property-became-required

    • ○

      the response property attachment/items/name became required for the status 200

      response-property-became-required

    • ○

      the response property attachment/items/path became required for the status 200

      response-property-became-required

    • ○

      the response property createdBy became required for the status 200

      response-property-became-required

    • ○

      the response property createdOn became required for the status 200

      response-property-became-required

    • ○

      the response property modifiedBy became required for the status 200

      response-property-became-required

    • ○

      the response property modifiedOn became required for the status 200

      response-property-became-required

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 16 revisions, 1 has no diff computed.