Interface CategoryService


  • public interface CategoryService
    • Method Detail

      • createCategories

        @POST(" ")
        retrofit2.Call<java.util.Collection<Category>> createCategories​(@Body
                                                                        java.util.Collection<Category> categories)
        Parameters:
        categories - - categories to be created
        Returns:
        Categories
      • updateCategories

        @PUT(" ")
        retrofit2.Call<java.util.Collection<Category>> updateCategories​(@Body
                                                                        java.util.Collection<Category> categories)
        Parameters:
        categories - - categories to be created or updated
        Returns:
        Categories
      • updateCategory

        @PUT("{categoryId}")
        retrofit2.Call<Category> updateCategory​(@Path("categoryId")
                                                java.lang.Long categoryId,
                                                @Body
                                                Category category)
        Parameters:
        categoryId - - id of category to be updated
        category - - category to be updated
        Returns:
        Category
      • patchCategory

        @PATCH("{categoryId}")
        retrofit2.Call<Category> patchCategory​(@Path("categoryId")
                                               java.lang.Long categoryId,
                                               @Body
                                               Category category)
        Parameters:
        categoryId - - id of category to be patched
        category - - category to be patched
        Returns:
        Category
      • deleteCategory

        @DELETE("{categoryId}")
        retrofit2.Call<Category> deleteCategory​(@Path("categoryId")
                                                java.lang.Long categoryId)
        Parameters:
        categoryId - - category id
        Returns:
        Category
      • getCategory

        @GET("{categoryId}")
        retrofit2.Call<Category> getCategory​(@Path("categoryId")
                                             java.lang.Long categoryId)
        Parameters:
        categoryId - - categoryId id
        Returns:
        Category
      • getCategories

        @GET(" ")
        retrofit2.Call<ResultPage<Category>> getCategories​(@Query("page")
                                                           int page,
                                                           @Query("limit")
                                                           int limit,
                                                           @Query("filter")
                                                           java.lang.String filter,
                                                           @Query("sort")
                                                           java.lang.String sort)
        Parameters:
        page - - pagination parameter, default = 1
        limit - - pagination parameter, default = 100, max = 100
        filter - - query filter
        sort - - Description: Sort parameters in format: column_name1,column_name2 //means asc -column_name1,-column_name2 //means desc
        Returns:
        Categories