Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This page documents the final Template Service & User Generated Documents API etc. Some of this was on other related pages during development, but it's just being pulled together here. We expect this will eventually be integrated into the API Documentation (and may some end-user documentation for the UI, if there is any?) - by who & when?

...

May be our first blog post with the initial live screencast demo is of interest. TBD Related Postman Collection Scripts are here. Here are the steps used (remember to set Content-type: application/json):

1. Create first template (without Mappers): POST this to https://localhost:8443/mifosng-provider/api/v1/templates?username=mifos&password=password&tenantIdentifier=default (and note the returned resourceId):

...

User Generated Document Out-of-the-Box (OOB) Example #1: Loan Schedule table + Image

This isn't 100% final yet. because fields are missing... who can help us get this 100% done?

This can be loaded into a Mifos X demo DB either by manually copy/pasting the name/mappers/text src, or via a some REST tool like Postman (remember to set Content-type: application/json).

It should then go into Git to be "pre-loaded" into DB - as the first example template (of hopefully more to come?) :
{
  "name": "Example Loan Schedule",

...

",
  "mappers": [
    {
      "mapperorder": 0,
      "mapperkey": "loan",
      "mappervalue": "loans/{{loanId}}?associations\u003dall\u0026tenantIdentifier\u003ddefault=all&tenantIdentifier=default",
      "id": 42
    },
    {
      "mapperorder": 1,
      "mapperkey": "client",
      "mappervalue": "clients/{{loan.clientId}}?tenantIdentifier={{tenantIdentifier}}",
      "id": 43
    },
    {
      "mapperorder": 2,
      "mapperkey": "image",
      "mappervalue": "clients/{{loan.clientId}}/images?tenantIdentifier\u003ddefault=default",
      "id": 44
    }
  ],
  "id": 4
}