jp.co.freee.accounting.api

Interface UsersApi

public interface UsersApi

Method Summary

Modifier and Type	Method and Description
io.reactivex.Observable<InlineResponse20012>	getUsers(Integer companyId, Integer limit) 事業所に所属するユーザー一覧の取得
io.reactivex.Observable<InlineResponse20013>	getUsersCapabilities(Integer companyId) ログインユーザーの権限の取得
io.reactivex.Observable<MeResponse>	getUsersMe(Boolean companies, Boolean advisor) ログインユーザー情報の取得
io.reactivex.Observable<UserResponse>	updateUser(UserParams userParams) ユーザー情報の更新

Method Detail

getUsers

@GET(value="api/1/users")
io.reactivex.Observable<InlineResponse20012> getUsers(@Query(value="company_id")
                                                                                Integer companyId,
                                                                                @Query(value="limit")
                                                                                Integer limit)

事業所に所属するユーザー一覧の取得

Parameters:

companyId - 事業所ID (required)

limit - 取得レコードの件数 (デフォルト: 50, 最小: 1, 最大: 3000) (optional)

Returns:

Observable<InlineResponse20012>

getUsersCapabilities

@GET(value="api/1/users/capabilities")
io.reactivex.Observable<InlineResponse20013> getUsersCapabilities(@Query(value="company_id")
                                                                                                         Integer companyId)

ログインユーザーの権限の取得

Parameters:

companyId - 事業所ID (required)

Returns:

Observable<InlineResponse20013>

getUsersMe

@GET(value="api/1/users/me")
io.reactivex.Observable<MeResponse> getUsersMe(@Query(value="companies")
                                                                            Boolean companies,
                                                                            @Query(value="advisor")
                                                                            Boolean advisor)

ログインユーザー情報の取得

Parameters:

companies - 取得情報にユーザーが所属する事業所一覧を含める (optional)

advisor - 取得情報に事業がアドバイザー事象所の場合は事業所毎の一意なプロフィールIDを含める (optional)

Returns:

Observable<MeResponse>

updateUser

@Headers(value="Content-Type:application/json")
 @PUT(value="api/1/users/me")
io.reactivex.Observable<UserResponse> updateUser(@Body
                                                                                                                               UserParams userParams)

ユーザー情報の更新

Parameters:

userParams - ユーザー情報の更新 (optional)

Returns:

Observable<UserResponse>