From 363e448521ac057d3be1457f78e1c9d31b1db95a Mon Sep 17 00:00:00 2001 From: Pawan Dubey Date: Wed, 5 Mar 2014 22:41:49 +0530 Subject: [PATCH] MIFOSX-948 Added UGD links to API DOCS --- api-docs/apiLive.htm | 55 +++++++++++++++++++++++++++++--------------- 1 file changed, 36 insertions(+), 19 deletions(-) diff --git a/api-docs/apiLive.htm b/api-docs/apiLive.htm index 15980cc9d..71b3ccea0 100644 --- a/api-docs/apiLive.htm +++ b/api-docs/apiLive.htm @@ -950,6 +950,23 @@ + + User Generated Documents + templates + Create a UGD + List UGDs + + + + + + templates/{templateId} + + Retrieve a UGD + Update a UGD + Delete a UGD + + @@ -21350,12 +21367,12 @@ Content-Type: application/json Request Body:  
-

Templates

-

Templates are used for end-user features such as custom user defined document generation (AKA UGD). They are based on {{ moustache }} templates. Think of them as a sort of built-in "mail merge" functionality.

+

User Generated Documents

+

User Generated Documents(alternatively, Templates) are used for end-user features such as custom user defined document generation (AKA UGD). They are based on {{ moustache }} templates. Think of them as a sort of built-in "mail merge" functionality.

User Generated Documents (and other types of templates) can aggregate data from several Mifos X back-end API calls via mappers. Mappers can even access non-Mifos X REST services from other servers. UGDs can render such data in tables, show images, etc. TBD: Please have a look at some of the Example UGDs included in Mifos X (or the Wiki page, for now.).

-

Templates can be assigned to an entity like client or loan and be of a typ like document. The entity and type of a template is only there for the convenience of user agents (UIs), in order to know where to show templates for the user (i.e. which tab). The Template Engine back-end runner does not actually need this metadata.

+

UGDs can be assigned to an entity like client or loan and be of a typ like document. The entity and type of a UGD is only there for the convenience of user agents (UIs), in order to know where to show UGDs for the user (i.e. which tab). The Template Engine back-end runner does not actually need this metadata.

@@ -21373,7 +21390,7 @@ Content-Type: application/json Request Body: @@ -21382,7 +21399,7 @@ Content-Type: application/json Request Body: @@ -21390,7 +21407,7 @@ Content-Type: application/json Request Body: @@ -21398,8 +21415,8 @@ Content-Type: application/json Request Body:
Field Descriptions
For now only the type document is supported. - In a next version templates may be created for e-mails oder SMS. + In a next version UGDs may be created for e-mails oder SMS.
Indicates the primary resource reference. - Templates may be filtered by entity and type so the relevant templates may be listed at the belonging position. + UGDs may be filtered by entity and type so the relevant UGDs may be listed at the belonging position.
- The actual template which may be any html-text containing mustache tags. + The actual UGD which may be any html-text containing mustache tags.
- By default one mapper is assigned to the template depending on the entity. - Mappers are used to create requests and get tags wich may be used in the template. + By default one mapper is assigned to the UGD depending on the entity. + Mappers are used to create requests and get tags wich may be used in the UGD. Also mappery are in order and may depend on the previous mappers. For now mappers expect a response in JSON or plain/text. JSON contains the keys and the values. @@ -21413,10 +21430,10 @@ Content-Type: application/json Request Body:  
-

Retrieve Template Details Template

+

Retrieve UGD Details Template

This is a convenience resource. It can be useful when - building maintenance user interface screens for templates. - The template data returned consists of any or all of: + building maintenance user interface screens for UGDs. + The UGD data returned consists of any or all of:

Arguments
@@ -21472,8 +21489,8 @@ GET https://DomainName/api/v1/templates/template class="old-syle-anchor"> 
-

Add a Template

-

Adds a new template.

+

Add a UGD

+

Adds a new UGD.

@@ -21521,13 +21538,13 @@ Request Body: class="old-syle-anchor"> 
-

Retrieve all Templates

+

Retrieve all UGDs

Example Requests:

templates

- It is also possible to get specific templates by entity and type: + It is also possible to get specific UGDs by entity and type:

templates?type=0&entity=0

@@ -21588,7 +21605,7 @@ GET https://DomainName/api/v1/templates class="old-syle-anchor"> 
-

Retrieve a Template

+

Retrieve a UGD

Example Requests:

templates/1
@@ -21620,7 +21637,7 @@ GET https://DomainName/api/v1/templates/{Id} class="old-syle-anchor"> 
-

Update a Template

+

Update a UGD

@@ -21658,7 +21675,7 @@ Request Body: class="old-syle-anchor"> 
-

Delete a Template

+

Delete a UGD

@@ -21677,7 +21694,7 @@ No Request Body:
- +
Mandatory Fields