CentersApi

interface CentersApi

Functions

Link copied to clipboard
abstract suspend fun activate2(centerId: Long, postCentersCenterIdRequest: PostCentersCenterIdRequest, command: String? = null): PostCentersCenterIdResponse

Activate a Center | Generate Collection Sheet | Save Collection Sheet | Close a Center | Associate Groups | Disassociate Groups Activate a Center: Centers can be created in a Pending state. This API exists to enable center activation. If the center happens to be already active, this API will result in an error. Close a Center: Centers can be closed if they don't have any non-closed groups or saving accounts. If the Center has any active groups or savings accounts, this API will result in an error. Associate Groups: This API allows associating existing groups to a center. The groups are listed from the office to which the center is associated. If group(s) is already associated with a center, this API will result in an error. Disassociate Groups: This API allows to disassociate groups from a center. Generate Collection Sheet: This Api retrieves repayment details of all jlg loans under a center as on a specified meeting date. Save Collection Sheet: This Api allows the loan officer to perform bulk repayments of JLG loans for a center on a given meeting date. Showing Request/Response for Close a Center Responses:

Link copied to clipboard
abstract suspend fun create7(postCentersRequest: PostCentersRequest): PostCentersResponse

Create a Center Creates a Center Mandatory Fields: name, officeId, active, activationDate (if active=true) Optional Fields: externalId, staffId, groupMembers Responses:

Link copied to clipboard
abstract suspend fun delete11(centerId: Long): DeleteCentersCenterIdResponse

Delete a Center A Center can be deleted if it is in pending state and has no association - groups, loans or savings Responses:

Link copied to clipboard
abstract suspend fun getCentersTemplate(officeId: Long? = null, staffId: Long? = null, dateFormat: String? = null)

Responses:

Link copied to clipboard
abstract suspend fun postCentersTemplate(dateFormat: String, locale: String, uploadedInputStream: MultiPartFormDataContent): String

Responses:

Link copied to clipboard
abstract suspend fun retrieveAll23(officeId: Long? = null, staffId: Long? = null, externalId: String? = null, name: String? = null, underHierarchy: String? = null, paged: Boolean? = null, offset: Int? = null, limit: Int? = null, orderBy: String? = null, sortOrder: String? = null, meetingDate: String? = null, dateFormat: String? = null, locale: String? = null): GetCentersResponse

List Centers The default implementation supports pagination and sorting with the default pagination size set to 200 records. The parameter limit with description -1 will return all entries. Example Requests: centers centers?fields=name,officeName,joinedDate centers?offset=10&limit=50 centers?orderBy=name&sortOrder=DESC Responses:

Link copied to clipboard

Retrieve Center accounts overview An example of how a savings summary for a Center can be provided. This is requested in a specific use case of the reference application. It is quite reasonable to add resources like this to simplify User Interface development. Example Requests: centers/9/accounts Responses:

Link copied to clipboard
abstract suspend fun retrieveOne14(centerId: Long, staffInSelectedOfficeOnly: Boolean? = false): GetCentersCenterIdResponse

Retrieve a Center Retrieves a Center Example Requests: centers/1 centers/1?associations=groupMembers Responses:

Link copied to clipboard
abstract suspend fun retrieveTemplate6(command: String? = null, officeId: Long? = null, staffInSelectedOfficeOnly: Boolean? = false): GetCentersTemplateResponse

Retrieve a Center Template Retrieves a Center Template Example Requests: centers/template centers/template?officeId=2 Responses:

Link copied to clipboard
abstract suspend fun update12(centerId: Long, putCentersCenterIdRequest: PutCentersCenterIdRequest): PutCentersCenterIdResponse

Update a Center Updates a Center Responses: