Interface BranchService


  • public interface BranchService
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      retrofit2.Call<Branch> getBranch​(java.lang.Long cloudId, java.lang.Long branchId)  
      retrofit2.Call<java.util.Collection<Branch>> getBranches​(java.lang.Long cloudId, int limit, int offset, java.lang.String sort)  
    • Method Detail

      • getBranch

        @GET("{cloudId}/{branchId}")
        retrofit2.Call<Branch> getBranch​(@Path("cloudId")
                                         java.lang.Long cloudId,
                                         @Path("branchId")
                                         java.lang.Long branchId)
        Parameters:
        cloudId - - cloud id
        branchId - - branch id
        Returns:
      • getBranches

        @GET("{cloudId}")
        retrofit2.Call<java.util.Collection<Branch>> getBranches​(@Path("cloudId")
                                                                 java.lang.Long cloudId,
                                                                 @Query("limit")
                                                                 int limit,
                                                                 @Query("offset")
                                                                 int offset,
                                                                 @Query("sort")
                                                                 java.lang.String sort)
        Parameters:
        cloudId - - cloud id
        offset - - pagination parameter, default = 0
        limit - - pagination parameter, default = 100, max = 100
        sort - - Description: Sort parameters in format: column_name1,column_name2 //means asc -column_name1,-column_name2 //means desc
        Returns: