public interface SegmentTagsApi
| Modifier and Type | Method and Description |
|---|---|
io.reactivex.Observable<SegmentTagResponse> |
createSegmentTag(Integer segmentId,
SegmentTagParams segmentTagParams)
セグメントの作成
<h2 id=\"\">概要</h2> <p>指定した事業所のセグメントタグを作成する</p> <h2 id=\"\">注意点</h2> <ul> <li>本APIは法人向けのプロフェッショナルプラン以上で利用可能です。利用可能なセグメントの数は、法人向けのプロフェッショナルプランの場合は1つ、エンタープライズプランの場合は3つです。</li> </ul>
|
io.reactivex.Completable |
destroySegmentsTag(Integer segmentId,
Integer id,
Integer companyId)
セグメントタグの削除
<h2 id=\"\">概要</h2> <p>指定した事業所のセグメントタグを削除する</p> <h2 id=\"\">注意点</h2> <ul> <li>本APIは法人向けのプロフェッショナルプラン以上で利用可能です。利用可能なセグメントの数は、法人向けのプロフェッショナルプランの場合は1つ、エンタープライズプランの場合は3つです。</li> </ul>
|
io.reactivex.Observable<InlineResponse20010> |
getSegmentTags(Integer segmentId,
Integer companyId,
Integer offset,
Integer limit)
セグメントタグ一覧の取得
<h2 id=\"\">概要</h2> <p>指定した事業所のセグメントタグ一覧を取得する</p> <h2 id=\"\">注意点</h2> <ul> <li>本APIは法人向けのプロフェッショナルプラン以上で利用可能です。利用可能なセグメントの数は、法人向けのプロフェッショナルプランの場合は1つ、エンタープライズプランの場合は3つです。</li> </ul>
|
io.reactivex.Observable<SegmentTagResponse> |
updateSegmentTag(Integer segmentId,
Integer id,
SegmentTagParams segmentTagParams)
セグメントタグの更新
<h2 id=\"\">概要</h2> <p>指定した事業所のセグメントタグを更新する</p> <h2 id=\"\">注意点</h2> <ul> <li>本APIは法人向けのプロフェッショナルプラン以上で利用可能です。利用可能なセグメントの数は、法人向けのプロフェッショナルプランの場合は1つ、エンタープライズプランの場合は3つです。</li> </ul>
|
@Headers(value="Content-Type:application/json")
@POST(value="api/1/segments/{segment_id}/tags")
io.reactivex.Observable<SegmentTagResponse> createSegmentTag(@Path(value="segment_id")
Integer segmentId,
@Body
SegmentTagParams segmentTagParams)
segmentId - セグメントID（1,2,3のいずれか） 該当プラン以外で参照した場合にはエラーとなります。 1: 法人向けプロフェッショナル, 法人向けエンタープライズプラン 2,3: 法人向け エンタープライズプラン (required)segmentTagParams - セグメントタグの作成 (required)@DELETE(value="api/1/segments/{segment_id}/tags/{id}")
io.reactivex.Completable destroySegmentsTag(@Path(value="segment_id")
Integer segmentId,
@Path(value="id")
Integer id,
@Query(value="company_id")
Integer companyId)
segmentId - セグメントID（1,2,3のいずれか） 該当プラン以外で参照した場合にはエラーとなります。 1: 法人向けプロフェッショナル, 法人向けエンタープライズプラン 2,3: 法人向け エンタープライズプラン (required)id - セグメントタグID (required)companyId - 事業所ID (required)@GET(value="api/1/segments/{segment_id}/tags")
io.reactivex.Observable<InlineResponse20010> getSegmentTags(@Path(value="segment_id")
Integer segmentId,
@Query(value="company_id")
Integer companyId,
@Query(value="offset")
Integer offset,
@Query(value="limit")
Integer limit)
segmentId - セグメントID（1,2,3のいずれか） 該当プラン以外で参照した場合にはエラーとなります。 1: 法人向けプロフェッショナル, 法人向けエンタープライズプラン 2,3: 法人向け エンタープライズプラン (required)companyId - 事業所ID (required)offset - 取得レコードのオフセット (デフォルト: 0) (optional)limit - 取得レコードの件数 (デフォルト: 20, 最小: 1, 最大: 500) (optional)@Headers(value="Content-Type:application/json")
@PUT(value="api/1/segments/{segment_id}/tags/{id}")
io.reactivex.Observable<SegmentTagResponse> updateSegmentTag(@Path(value="segment_id")
Integer segmentId,
@Path(value="id")
Integer id,
@Body
SegmentTagParams segmentTagParams)
segmentId - セグメントID（1,2,3のいずれか） 該当プラン以外で参照した場合にはエラーとなります。 1: 法人向けプロフェッショナル, 法人向けエンタープライズプラン 2,3: 法人向け エンタープライズプラン (required)id - セグメントタグID (required)segmentTagParams - セグメントタグの作成 (required)Copyright © 2020. All rights reserved.