Codes are mostly system defined which means the code itself - comes out of the box and cannot be modifed however its code values + comes out of the box and cannot be modified however its code values can be. e.g. 'Customer Identifier', it defaults to a code value of 'Passport' but could be 'Drivers License, National Id' etc
@@ -7164,6 +7208,174 @@ Content-Type: application/json + + +Code and code values: Codes represent a specific category of + data, their code values are a specific instance of that category.
++ Codes are mostly system defined which means the code itself + comes out of the box and cannot be modified however its code values + can be. e.g. 'Customer Identifier', it defaults to a code value of + 'Passport' but could be 'Drivers License, National Id' etc +
+
+POST https://DomainName/api/v1/codes/1/codevalues
+
+
+POST codes/1/codevalues
+Content-Type: application/json
+Request Body:
+{
+ "name":"Ration Card",
+ "position":"1"
+}
+
+
+{
+ "resourceId": 4
+}
+
+ Returns the list of Code Values for a given Code
+Example Requests:
+
+GET https://DomainName/api/v1/codes/{codeId}/codevalues
+
+
+[
+ {
+ "id": 1,
+ "name": "Passport",
+ "position": 0
+ },
+ {
+ "id": 2,
+ "name": "Id",
+ "position": 0
+ },
+ {
+ "id": 3,
+ "name": "Drivers License",
+ "position": 0
+ },
+ {
+ "id": 4,
+ "name": "Any Other Id Type",
+ "position": 0
+ },
+ {
+ "id": 5,
+ "name": "Ration Card",
+ "position": 1
+ }
+]
+
+ Returns the details of a Code Value
+Example Requests:
+
+GET https://DomainName/api/v1/codes/{codeId}/codevalues/{codevalueId}
+
+
+{
+ "id": 1,
+ "name": "Passport",
+ "position": 0
+}
+
+ Updates the details of a code value.
+
+PUT https://DomainName/api/v1/codes/{codeId}/codevalues/{codevalueId}
+
+
+PUT codes/1/codevalues/1
+Content-Type: application/json
+Request Body:
+{
+ "name": "Indian Passport",
+ "position":2
+}
+
+
+{
+ "resourceId": 1,
+ "changes": {
+ "name": "Indian Passport",
+ "position": 2
+ }
+}
+
+ Deletes a code value
+
+DELETE https://DomainName/api/v1/codes/{codeId}/codevalues/{codevalueId}
+
+
+DELETE codes/1/codevalues/5
+Content-Type: application/json
+
+
+{
+ "resourceId": 5
+}
+
+ Multiple Documents (a combination of a name, description + and a file) may be attached to different Entities + like Clients, Staff, Loans, Savings and Client + Identifiers in the system +
+Note: The currently allowed Entities are +
Field Descriptions |
+
| parentEntityType | +
| The type of the Entity + with which this document is associated + | +
| parentEntityId | +
| The ID of the entity (client, + loan etc) with which this document is + associated | +
| name | +
| User Defined name for the + document, need not be the same as the name + of the file associated with the document + | +
| fileName | +
| The name of the file associated + with this document | +
| size | +
| The size (in bytes) of the file + associated with this document | +
| type | +
| Mime Type of the file + associated with this document + | +
| description | +
| A description of this document + | +
Example Requests:
+
+GET https://DomainName/api/v1/{entityType}/{entityId}/documents
+
+
+[
+ {
+ "id": 1,
+ "parentEntityType": "clients",
+ "parentEntityId": 1,
+ "name": "Client Details Form ",
+ "fileName": "CGAP.pdf",
+ "size": 5246719,
+ "type": "application/pdf",
+ "description": "A signed form signed by new member"
+ }
+]
+
+ Example Requests:
+
+GET https://DomainName/api/v1/documents/{clientId}
+
+
+{
+ "id": 1,
+ "parentEntityType": "clients",
+ "parentEntityId": 1,
+ "name": "Client Details Form ",
+ "fileName": "CGAP.pdf",
+ "size": 5246719,
+ "type": "application/pdf",
+ "description": "A signed form signed by new member"
+}
+
+
+ Note: A document is created using a Multi-part form upload
+
+
Body Parts |
+
| name | +
| Name or summary of the document + | +
| description | +
| Description of the document + |
| file | +
| The file to be uploaded + | +
Mandatory Fields |
+
| file and description | +
+POST https://DomainName/api/v1/{entityType}/{entityId}/documents
+
+
+POST clients/1/documents
+Content-Type: multipart/form-data
+Request Body:
+Not Shown (multi-part form data)
+
+
+{
+ "resourceId":3,
+ "resourceIdentifier":"3"
+}
+
+
+ Note: A document is updated using a Multi-part form upload
+
+
Body Parts |
+
| name | +
| Name or summary of the document + | +
| description | +
| Description of the document + |
| file | +
| The file to be uploaded + | +
+PUT https://DomainName/api/v1/{entityType}/{entityId}/documents/{documentId}
+
+
+PUT clients/1/documents/1
+Content-Type: multipart/form-data
+Request Body:
+Not Shown (multi-part form data)
+
+
+{
+ "resourceId":3,
+ "changes":{},
+ "resourceIdentifier":"3"
+}
+
+ Request used to download the file associated with the document
+Example Requests:
+
+GET https://DomainName/api/v1/{entityType}/{entityId}/documents/{documentId}/attachment
+
+
+Not Shown: The corresponding Binary file
+
+
+DELETE https://DomainName/api/v1/{entityType}/{entityId}/documents/{documentId}
+
+
+DELETE clients/1/documents/1
+Content-Type: application/json
+No Request Body:
+
+
+{
+ "resourceId":1,
+ "changes":{},
+ "resourceIdentifier":"1"
+}
+
+
+DELETE https://DomainName/api/v1/{entityType}/{entityId}/documents/{documentId}
+
+
+DELETE loans/1/documents/1
+Content-Type: application/json
+No Request Body:
+
+
+{
+ "resourceId":1,
+ "changes":{},
+ "resourceIdentifier":"1"
+}
+
+