Package org.apache.fineract.client.services

Interface CodesApi

public interface CodesApi

  • Method Details

    • createCode

      @Headers("Content-Type:application/json") @POST("v1/codes") retrofit2.Call<PostCodesResponse> createCode(@Body PostCodesRequest postCodesRequest)
      Create a Code Creates a code. Codes created through api are always 'user defined' and so system defined is marked as false.
      Parameters:
      postCodesRequest - (required)
      Returns:
      Call<PostCodesResponse>

    • deleteCode

      @DELETE("v1/codes/{codeId}") retrofit2.Call<DeleteCodesResponse> deleteCode(@Path("codeId") Long codeId)
      Delete a Code Deletes a code if it is not system defined.
      Parameters:
      codeId - codeId (required)
      Returns:
      Call<DeleteCodesResponse>

    • retrieveCode

      @GET("v1/codes/{codeId}") retrofit2.Call<GetCodesResponse> retrieveCode(@Path("codeId") Long codeId)
      Retrieve a Code Returns the details of a Code. Example Requests: codes/1
      Parameters:
      codeId - codeId (required)
      Returns:
      Call<GetCodesResponse>

    • retrieveCodeByName

      @GET("v1/codes/name/{codeName}") retrofit2.Call<GetCodesResponse> retrieveCodeByName(@Path("codeName") String codeName)
      Retrieve a Code Returns the details of a Code. Example Requests: codes/1
      Parameters:
      codeName - codeName (required)
      Returns:
      Call<GetCodesResponse>

    • retrieveCodes

      @GET("v1/codes") retrofit2.Call<List<GetCodesResponse>> retrieveCodes()
      Retrieve Codes Returns the list of codes. Example Requests: codes
      Returns:
      Call<List<GetCodesResponse>>

    • updateCode

      @Headers("Content-Type:application/json") @PUT("v1/codes/{codeId}") retrofit2.Call<PutCodesResponse> updateCode(@Path("codeId") Long codeId, @Body PutCodesRequest putCodesRequest)
      Update a Code Updates the details of a code if it is not system defined.
      Parameters:
      codeId - codeId (required)
      putCodesRequest - (required)
      Returns:
      Call<PutCodesResponse>

    • createCode

      @Headers("Content-Type:application/json") @POST("v1/codes") retrofit2.Call<PostCodesResponse> createCode(@Body PostCodesRequest postCodesRequest, @HeaderMap Map<String,String> headers)
      Create a Code Creates a code. Codes created through api are always 'user defined' and so system defined is marked as false.
      Parameters:
      postCodesRequest - (required)
      Returns:
      Call<PostCodesResponse>

    • deleteCode

      @DELETE("v1/codes/{codeId}") retrofit2.Call<DeleteCodesResponse> deleteCode(@Path("codeId") Long codeId, @HeaderMap Map<String,String> headers)
      Delete a Code Deletes a code if it is not system defined.
      Parameters:
      codeId - codeId (required)
      Returns:
      Call<DeleteCodesResponse>

    • retrieveCode

      @GET("v1/codes/{codeId}") retrofit2.Call<GetCodesResponse> retrieveCode(@Path("codeId") Long codeId, @HeaderMap Map<String,String> headers)
      Retrieve a Code Returns the details of a Code. Example Requests: codes/1
      Parameters:
      codeId - codeId (required)
      Returns:
      Call<GetCodesResponse>

    • retrieveCodeByName

      @GET("v1/codes/name/{codeName}") retrofit2.Call<GetCodesResponse> retrieveCodeByName(@Path("codeName") String codeName, @HeaderMap Map<String,String> headers)
      Retrieve a Code Returns the details of a Code. Example Requests: codes/1
      Parameters:
      codeName - codeName (required)
      Returns:
      Call<GetCodesResponse>

    • retrieveCodes

      @GET("v1/codes") retrofit2.Call<List<GetCodesResponse>> retrieveCodes(@HeaderMap Map<String,String> headers)
      Retrieve Codes Returns the list of codes. Example Requests: codes
      Returns:
      Call<List<GetCodesResponse>>

    • updateCode

      @Headers("Content-Type:application/json") @PUT("v1/codes/{codeId}") retrofit2.Call<PutCodesResponse> updateCode(@Path("codeId") Long codeId, @Body PutCodesRequest putCodesRequest, @HeaderMap Map<String,String> headers)
      Update a Code Updates the details of a code if it is not system defined.
      Parameters:
      codeId - codeId (required)
      putCodesRequest - (required)
      Returns:
      Call<PutCodesResponse>