Reference

This is a flat view of all the representations and relations. If you would rather explore our API starting from the Entry Point, please use the Browser.

Quick reminder:
  • Representation: a set of name-value pairs representing the state of a resource.
  • Relation: the identifier of a link between two resources.

missing-parameters

  1. missing-parameters-representation
  2. get-document-template-missing-parameters
  3. get-mandate-template-missing-parameters

1. missing-parameters-representation

Description: A missing parameters representation contains a list of missing parameters in a document, if there is any missing ones. It can be either for a document template or a mandate template.

Properties
missingParameters
The list of missing parameters. Constraints: List of strings, Read-Only.

2. get-document-template-missing-parameters (relation)

Description: Get missing required parameters in a document template by id. Returns a missing parameters resource with a list filled with the missing parameters if there is any missing ones.

Properties
id
The document template id. Constraints: 36 characters or less, Read-Only.

3. get-mandate-template-missing-parameters (relation)

Description: Get missing required parameters in a mandate template by id. Returns a missing parameters resource with a list filled with the missing parameters if there is any missing ones.

Properties
id
The mandate template id. Constraints: 36 characters or less, Read-Only.