Package org.apache.fineract.client.services

Interface OfficesApi

public interface OfficesApi

  • Method Details

    • createOffice

      @Headers("Content-Type:application/json") @POST("v1/offices") retrofit2.Call<PostOfficesResponse> createOffice(@Body PostOfficesRequest postOfficesRequest)
      Create an Office Mandatory Fields name, openingDate, parentId
      Parameters:
      postOfficesRequest - (required)
      Returns:
      Call<PostOfficesResponse>

    • getOfficeTemplate

      @GET("v1/offices/downloadtemplate") retrofit2.Call<Void> getOfficeTemplate(@Query("dateFormat") String dateFormat)
      Parameters:
      dateFormat - (optional)
      Returns:
      Call<Void>

    • postOfficeTemplate

      @Multipart @POST("v1/offices/uploadtemplate") retrofit2.Call<String> postOfficeTemplate(@Part("dateFormat") String dateFormat, @Part("locale") String locale, @Part okhttp3.MultipartBody.Part uploadedInputStream)
      Parameters:
      dateFormat - (optional)
      locale - (optional)
      uploadedInputStream - (optional)
      Returns:
      Call<String>

    • retrieveOffice

      @GET("v1/offices/{officeId}") retrofit2.Call<GetOfficesResponse> retrieveOffice(@Path("officeId") Long officeId)
      Retrieve an Office Example Requests: offices/1 offices/1?template=true offices/1?fields=id,name,parentName
      Parameters:
      officeId - officeId (required)
      Returns:
      Call<GetOfficesResponse>

    • retrieveOfficeByExternalId

      @GET("v1/offices/external-id/{externalId}") retrofit2.Call<GetOfficesResponse> retrieveOfficeByExternalId(@Path("externalId") String externalId)
      Retrieve an Office using external id Example Requests: offices/external-id/asd123 offices/external-id/asd123?template=true offices/external-id/asd123?fields=id,name,parentName
      Parameters:
      externalId - externalId (required)
      Returns:
      Call<GetOfficesResponse>

    • retrieveOfficeTemplate1

      @GET("v1/offices/template") retrofit2.Call<GetOfficesTemplateResponse> retrieveOfficeTemplate1()
      Retrieve Office Details Template This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults Allowed description Lists Example Request: offices/template
      Returns:
      Call<GetOfficesTemplateResponse>

    • retrieveOffices

      @GET("v1/offices") retrofit2.Call<List<GetOfficesResponse>> retrieveOffices(@Query("includeAllOffices") Boolean includeAllOffices, @Query("orderBy") String orderBy, @Query("sortOrder") String sortOrder)
      List Offices Example Requests: offices offices?fields=id,name,openingDate
      Parameters:
      includeAllOffices - includeAllOffices (optional, default to false)
      orderBy - orderBy (optional)
      sortOrder - sortOrder (optional)
      Returns:
      Call<List<GetOfficesResponse>>

    • updateOffice

      @Headers("Content-Type:application/json") @PUT("v1/offices/{officeId}") retrofit2.Call<PutOfficesOfficeIdResponse> updateOffice(@Path("officeId") Long officeId, @Body PutOfficesOfficeIdRequest putOfficesOfficeIdRequest)
      Update Office
      Parameters:
      officeId - officeId (required)
      putOfficesOfficeIdRequest - (required)
      Returns:
      Call<PutOfficesOfficeIdResponse>

    • updateOfficeWithExternalId

      @Headers("Content-Type:application/json") @PUT("v1/offices/external-id/{externalId}") retrofit2.Call<PutOfficesOfficeIdResponse> updateOfficeWithExternalId(@Path("externalId") String externalId, @Body PutOfficesOfficeIdRequest putOfficesOfficeIdRequest)
      Update Office
      Parameters:
      externalId - externalId (required)
      putOfficesOfficeIdRequest - (required)
      Returns:
      Call<PutOfficesOfficeIdResponse>

    • createOffice

      @Headers("Content-Type:application/json") @POST("v1/offices") retrofit2.Call<PostOfficesResponse> createOffice(@Body PostOfficesRequest postOfficesRequest, @HeaderMap Map<String,String> headers)
      Create an Office Mandatory Fields name, openingDate, parentId
      Parameters:
      postOfficesRequest - (required)
      Returns:
      Call<PostOfficesResponse>

    • getOfficeTemplate

      @GET("v1/offices/downloadtemplate") retrofit2.Call<Void> getOfficeTemplate(@Query("dateFormat") String dateFormat, @HeaderMap Map<String,String> headers)
      Parameters:
      dateFormat - (optional)
      Returns:
      Call<Void>

    • postOfficeTemplate

      @Multipart @POST("v1/offices/uploadtemplate") retrofit2.Call<String> postOfficeTemplate(@Part("dateFormat") String dateFormat, @Part("locale") String locale, @Part okhttp3.MultipartBody.Part uploadedInputStream, @HeaderMap Map<String,String> headers)
      Parameters:
      dateFormat - (optional)
      locale - (optional)
      uploadedInputStream - (optional)
      Returns:
      Call<String>

    • retrieveOffice

      @GET("v1/offices/{officeId}") retrofit2.Call<GetOfficesResponse> retrieveOffice(@Path("officeId") Long officeId, @HeaderMap Map<String,String> headers)
      Retrieve an Office Example Requests: offices/1 offices/1?template=true offices/1?fields=id,name,parentName
      Parameters:
      officeId - officeId (required)
      Returns:
      Call<GetOfficesResponse>

    • retrieveOfficeByExternalId

      @GET("v1/offices/external-id/{externalId}") retrofit2.Call<GetOfficesResponse> retrieveOfficeByExternalId(@Path("externalId") String externalId, @HeaderMap Map<String,String> headers)
      Retrieve an Office using external id Example Requests: offices/external-id/asd123 offices/external-id/asd123?template=true offices/external-id/asd123?fields=id,name,parentName
      Parameters:
      externalId - externalId (required)
      Returns:
      Call<GetOfficesResponse>

    • retrieveOfficeTemplate1

      @GET("v1/offices/template") retrofit2.Call<GetOfficesTemplateResponse> retrieveOfficeTemplate1(@HeaderMap Map<String,String> headers)
      Retrieve Office Details Template This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults Allowed description Lists Example Request: offices/template
      Returns:
      Call<GetOfficesTemplateResponse>

    • retrieveOffices

      @GET("v1/offices") retrofit2.Call<List<GetOfficesResponse>> retrieveOffices(@Query("includeAllOffices") Boolean includeAllOffices, @Query("orderBy") String orderBy, @Query("sortOrder") String sortOrder, @HeaderMap Map<String,String> headers)
      List Offices Example Requests: offices offices?fields=id,name,openingDate
      Parameters:
      includeAllOffices - includeAllOffices (optional, default to false)
      orderBy - orderBy (optional)
      sortOrder - sortOrder (optional)
      Returns:
      Call<List<GetOfficesResponse>>

    • updateOffice

      @Headers("Content-Type:application/json") @PUT("v1/offices/{officeId}") retrofit2.Call<PutOfficesOfficeIdResponse> updateOffice(@Path("officeId") Long officeId, @Body PutOfficesOfficeIdRequest putOfficesOfficeIdRequest, @HeaderMap Map<String,String> headers)
      Update Office
      Parameters:
      officeId - officeId (required)
      putOfficesOfficeIdRequest - (required)
      Returns:
      Call<PutOfficesOfficeIdResponse>

    • updateOfficeWithExternalId

      @Headers("Content-Type:application/json") @PUT("v1/offices/external-id/{externalId}") retrofit2.Call<PutOfficesOfficeIdResponse> updateOfficeWithExternalId(@Path("externalId") String externalId, @Body PutOfficesOfficeIdRequest putOfficesOfficeIdRequest, @HeaderMap Map<String,String> headers)
      Update Office
      Parameters:
      externalId - externalId (required)
      putOfficesOfficeIdRequest - (required)
      Returns:
      Call<PutOfficesOfficeIdResponse>