Package org.apache.fineract.client.services

Interface DocumentsApi

public interface DocumentsApi

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<PostEntityTypeEntityIdDocumentsResponse>	createDocument(String entityType, Long entityId, Long contentLength, String dateFormat, String description, String locale, String name, okhttp3.MultipartBody.Part uploadedInputStream)	Create a Document 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
retrofit2.Call<PostEntityTypeEntityIdDocumentsResponse>	createDocument(String entityType, Long entityId, Long contentLength, String dateFormat, String description, String locale, String name, okhttp3.MultipartBody.Part uploadedInputStream, Map<String,String> headers)	Create a Document 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
retrofit2.Call<DeleteEntityTypeEntityIdDocumentsResponse>	deleteDocument(String entityType, Long entityId, Long documentId)	Remove a Document
retrofit2.Call<DeleteEntityTypeEntityIdDocumentsResponse>	deleteDocument(String entityType, Long entityId, Long documentId, Map<String,String> headers)	Remove a Document
retrofit2.Call<Void>	downloadFile(String entityType, Long entityId, Long documentId)	Retrieve Binary File associated with Document Request used to download the file associated with the document Example Requests: clients/1/documents/1/attachment loans/1/documents/1/attachment
retrofit2.Call<Void>	downloadFile(String entityType, Long entityId, Long documentId, Map<String,String> headers)	Retrieve Binary File associated with Document Request used to download the file associated with the document Example Requests: clients/1/documents/1/attachment loans/1/documents/1/attachment
retrofit2.Call<DocumentData>	getDocument(String entityType, Long entityId, Long documentId)	Retrieve a Document Example Requests: clients/1/documents/1 loans/1/documents/1 client_identifiers/1/documents/1?fields=name,description
retrofit2.Call<DocumentData>	getDocument(String entityType, Long entityId, Long documentId, Map<String,String> headers)	Retrieve a Document Example Requests: clients/1/documents/1 loans/1/documents/1 client_identifiers/1/documents/1?fields=name,description
retrofit2.Call<List<DocumentData>>	retrieveAllDocuments(String entityType, Long entityId)	List documents Example Requests: clients/1/documents client_identifiers/1/documents loans/1/documents?fields=name,description
retrofit2.Call<List<DocumentData>>	retrieveAllDocuments(String entityType, Long entityId, Map<String,String> headers)	List documents Example Requests: clients/1/documents client_identifiers/1/documents loans/1/documents?fields=name,description
retrofit2.Call<PutEntityTypeEntityIdDocumentsResponse>	updateDocument(String entityType, Long entityId, Long documentId, Long contentLength, String dateFormat, String description, String locale, String name, okhttp3.MultipartBody.Part uploadedInputStream)	Update a Document 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
retrofit2.Call<PutEntityTypeEntityIdDocumentsResponse>	updateDocument(String entityType, Long entityId, Long documentId, Long contentLength, String dateFormat, String description, String locale, String name, okhttp3.MultipartBody.Part uploadedInputStream, Map<String,String> headers)	Update a Document 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

Method Details

createDocument

@Multipart
@POST("v1/{entityType}/{entityId}/documents")
retrofit2.Call<PostEntityTypeEntityIdDocumentsResponse> createDocument(@Path("entityType")
 String entityType,
 @Path("entityId")
 Long entityId,
 @Header("Content-Length")
 Long contentLength,
 @Part("dateFormat")
 String dateFormat,
 @Part("description")
 String description,
 @Part("locale")
 String locale,
 @Part("name")
 String name,
 @Part
 okhttp3.MultipartBody.Part uploadedInputStream)

Create a Document 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

Parameters:

entityType - entityType (required)

entityId - entityId (required)

contentLength - Content-Length (optional)

dateFormat - (optional)

description - (optional)

locale - (optional)

name - (optional)

uploadedInputStream - (optional)

Returns:

Call<PostEntityTypeEntityIdDocumentsResponse>

deleteDocument

@DELETE("v1/{entityType}/{entityId}/documents/{documentId}")
retrofit2.Call<DeleteEntityTypeEntityIdDocumentsResponse> deleteDocument(@Path("entityType")
 String entityType,
 @Path("entityId")
 Long entityId,
 @Path("documentId")
 Long documentId)

Remove a Document

Parameters:

entityType - entityType (required)

entityId - entityId (required)

documentId - documentId (required)

Returns:

Call<DeleteEntityTypeEntityIdDocumentsResponse>

downloadFile

@GET("v1/{entityType}/{entityId}/documents/{documentId}/attachment")
retrofit2.Call<Void> downloadFile(@Path("entityType")
 String entityType,
 @Path("entityId")
 Long entityId,
 @Path("documentId")
 Long documentId)

Retrieve Binary File associated with Document Request used to download the file associated with the document Example Requests: clients/1/documents/1/attachment loans/1/documents/1/attachment

Parameters:

entityType - entityType (required)

entityId - entityId (required)

documentId - documentId (required)

Returns:

Call<Void>

getDocument

@GET("v1/{entityType}/{entityId}/documents/{documentId}")
retrofit2.Call<DocumentData> getDocument(@Path("entityType")
 String entityType,
 @Path("entityId")
 Long entityId,
 @Path("documentId")
 Long documentId)

Retrieve a Document Example Requests: clients/1/documents/1 loans/1/documents/1 client_identifiers/1/documents/1?fields=name,description

Parameters:

entityType - entityType (required)

entityId - entityId (required)

documentId - documentId (required)

Returns:

Call<DocumentData>

retrieveAllDocuments

@GET("v1/{entityType}/{entityId}/documents")
retrofit2.Call<List<DocumentData>> retrieveAllDocuments(@Path("entityType")
 String entityType,
 @Path("entityId")
 Long entityId)

List documents Example Requests: clients/1/documents client_identifiers/1/documents loans/1/documents?fields=name,description

Parameters:

entityType - entityType (required)

entityId - entityId (required)

Returns:

Call<List<DocumentData>>

updateDocument

@Multipart
@PUT("v1/{entityType}/{entityId}/documents/{documentId}")
retrofit2.Call<PutEntityTypeEntityIdDocumentsResponse> updateDocument(@Path("entityType")
 String entityType,
 @Path("entityId")
 Long entityId,
 @Path("documentId")
 Long documentId,
 @Header("Content-Length")
 Long contentLength,
 @Part("dateFormat")
 String dateFormat,
 @Part("description")
 String description,
 @Part("locale")
 String locale,
 @Part("name")
 String name,
 @Part
 okhttp3.MultipartBody.Part uploadedInputStream)

Update a Document 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

Parameters:

entityType - entityType (required)

entityId - entityId (required)

documentId - documentId (required)

contentLength - Content-Length (optional)

dateFormat - (optional)

description - (optional)

locale - (optional)

name - (optional)

uploadedInputStream - (optional)

Returns:

Call<PutEntityTypeEntityIdDocumentsResponse>

createDocument

@Multipart
@POST("v1/{entityType}/{entityId}/documents")
retrofit2.Call<PostEntityTypeEntityIdDocumentsResponse> createDocument(@Path("entityType")
 String entityType,
 @Path("entityId")
 Long entityId,
 @Header("Content-Length")
 Long contentLength,
 @Part("dateFormat")
 String dateFormat,
 @Part("description")
 String description,
 @Part("locale")
 String locale,
 @Part("name")
 String name,
 @Part
 okhttp3.MultipartBody.Part uploadedInputStream,
 @HeaderMap
 Map<String,String> headers)

Create a Document 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

Parameters:

entityType - entityType (required)

entityId - entityId (required)

contentLength - Content-Length (optional)

dateFormat - (optional)

description - (optional)

locale - (optional)

name - (optional)

uploadedInputStream - (optional)

Returns:

Call<PostEntityTypeEntityIdDocumentsResponse>

deleteDocument

@DELETE("v1/{entityType}/{entityId}/documents/{documentId}")
retrofit2.Call<DeleteEntityTypeEntityIdDocumentsResponse> deleteDocument(@Path("entityType")
 String entityType,
 @Path("entityId")
 Long entityId,
 @Path("documentId")
 Long documentId,
 @HeaderMap
 Map<String,String> headers)

Remove a Document

Parameters:

entityType - entityType (required)

entityId - entityId (required)

documentId - documentId (required)

Returns:

Call<DeleteEntityTypeEntityIdDocumentsResponse>

downloadFile

@GET("v1/{entityType}/{entityId}/documents/{documentId}/attachment")
retrofit2.Call<Void> downloadFile(@Path("entityType")
 String entityType,
 @Path("entityId")
 Long entityId,
 @Path("documentId")
 Long documentId,
 @HeaderMap
 Map<String,String> headers)

Retrieve Binary File associated with Document Request used to download the file associated with the document Example Requests: clients/1/documents/1/attachment loans/1/documents/1/attachment

Parameters:

entityType - entityType (required)

entityId - entityId (required)

documentId - documentId (required)

Returns:

Call<Void>

getDocument

@GET("v1/{entityType}/{entityId}/documents/{documentId}")
retrofit2.Call<DocumentData> getDocument(@Path("entityType")
 String entityType,
 @Path("entityId")
 Long entityId,
 @Path("documentId")
 Long documentId,
 @HeaderMap
 Map<String,String> headers)

Retrieve a Document Example Requests: clients/1/documents/1 loans/1/documents/1 client_identifiers/1/documents/1?fields=name,description

Parameters:

entityType - entityType (required)

entityId - entityId (required)

documentId - documentId (required)

Returns:

Call<DocumentData>

retrieveAllDocuments

@GET("v1/{entityType}/{entityId}/documents")
retrofit2.Call<List<DocumentData>> retrieveAllDocuments(@Path("entityType")
 String entityType,
 @Path("entityId")
 Long entityId,
 @HeaderMap
 Map<String,String> headers)

List documents Example Requests: clients/1/documents client_identifiers/1/documents loans/1/documents?fields=name,description

Parameters:

entityType - entityType (required)

entityId - entityId (required)

Returns:

Call<List<DocumentData>>

updateDocument

@Multipart
@PUT("v1/{entityType}/{entityId}/documents/{documentId}")
retrofit2.Call<PutEntityTypeEntityIdDocumentsResponse> updateDocument(@Path("entityType")
 String entityType,
 @Path("entityId")
 Long entityId,
 @Path("documentId")
 Long documentId,
 @Header("Content-Length")
 Long contentLength,
 @Part("dateFormat")
 String dateFormat,
 @Part("description")
 String description,
 @Part("locale")
 String locale,
 @Part("name")
 String name,
 @Part
 okhttp3.MultipartBody.Part uploadedInputStream,
 @HeaderMap
 Map<String,String> headers)

Update a Document 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

Parameters:

entityType - entityType (required)

entityId - entityId (required)

documentId - documentId (required)

contentLength - Content-Length (optional)

dateFormat - (optional)

description - (optional)

locale - (optional)

name - (optional)

uploadedInputStream - (optional)

Returns:

Call<PutEntityTypeEntityIdDocumentsResponse>