Package pl.grizzlysoftware.dotykacka.client.v1.api.service

Interface CategoryService

public interface CategoryService

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<Category>	createCategory(java.lang.Long cloudId, Category category)
retrofit2.Call<Category>	deleteCategory(java.lang.Long cloudId, java.lang.Long categoryId)
retrofit2.Call<java.util.Collection<Category>>	getCategories(java.lang.Long cloudId, int limit, int offset, java.lang.String sort)
retrofit2.Call<Category>	getCategory(java.lang.Long cloudId, java.lang.Long categoryId)
retrofit2.Call<Category>	updateCategory(java.lang.Long cloudId, java.lang.Long categoryId, Category category)

Method Detail

createCategory

@POST("{cloudId}/create")
retrofit2.Call<Category> createCategory(@Path("cloudId")
                                        java.lang.Long cloudId,
                                        @Body
                                        Category category)

Parameters:

cloudId - - cloud id

category - - category to be created

Returns:

updateCategory

@POST("{cloudId}/{categoryId}/update")
retrofit2.Call<Category> updateCategory(@Path("cloudId")
                                        java.lang.Long cloudId,
                                        @Path("categoryId")
                                        java.lang.Long categoryId,
                                        @Body
                                        Category category)

Parameters:

cloudId - - cloud id

category - - category to be updated

Returns:

deleteCategory

@GET("{cloudId}/{categoryId}/delete")
retrofit2.Call<Category> deleteCategory(@Path("cloudId")
                                        java.lang.Long cloudId,
                                        @Path("categoryId")
                                        java.lang.Long categoryId)

Parameters:

cloudId - - cloud id

categoryId - - category id

Returns:

getCategory

@GET("{cloudId}/{categoryId}")
retrofit2.Call<Category> getCategory(@Path("cloudId")
                                     java.lang.Long cloudId,
                                     @Path("categoryId")
                                     java.lang.Long categoryId)

Parameters:

cloudId - - cloud id

categoryId - - categoryId id

Returns:

getCategories

@GET("{cloudId}")
retrofit2.Call<java.util.Collection<Category>> getCategories(@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: