メールタグ件数取得

リクエストURL

ホスト

https://api.next-engine.org

エンドポイント

/api_v1_master_mailtag/count

リファレンス内容

件数取得について

入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります

検索条件を複数指定した場合、全ての条件がかつ(AND)となります

入力パラメータ

パラメータ	値	省略	備考
`access_token`	access_token取得により取得した値	必須(SDKの場合不要)
`refresh_token`	access_token取得により取得した値	可能(SDKの場合不要)	【指定してaccess_tokenの有効期限が切れた場合】正常に出力パラメータが設定されaccess_tokenとrefresh_tokenが新しい値に更新されます【省略してaccess_tokenの有効期限が切れた場合】出力パラメータ「result」の値がredirectになります（成功時以外の出力パラメータ参照)
`wait_flag`	1:メイン機能過負荷でも可能な限りエラーにせず実行1以外:メイン機能過負荷の場合、003002のエラーを返却	可能(省略時は1以外とする)	詳細はパラメータ共通事項「待機フラグについて」を参照して下さい
フィールド名-比較演算子(WHERE句のカラムと比較演算子相当)	検索条件の値(WHERE句の値相当)	可能	例：商品マスタ検索でパラメータ：goods_id-like、値：”%-red”と指定した場合、商品コードが*-redの商品マスタを検索します

出力パラメータ

パラメータ名	値	備考
`result`	`success`	success以外の場合の出力パラメータは成功時以外の出力パラメータ参照
`access_token`	入力パラメータで指定したaccess_token／新たに発行されたaccess_token	有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります
`access_token_end_date`	access_tokenの有効期限切れ日時
`refresh_token`	入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token	access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります
`refresh_token_end_date`	refresh_tokenの有効期限切れ日時
`count`	検索結果の件数

メールタグ

項目名	フィールド名	データ型	備考
メールタグ	`mail_tag_id`	文字列型
対応月	`mail_tag_month`	数値型	0-12の値が設定される。0:メール送信月に対応する1-12の設定がない場合、適用される。1-12:メール送信月の１月～１２月に対応する。
メールタグ概要	`mail_tag_name`	文字列型
メールタグ備考	`mail_tag_note`	文字列型
メッセージ1	`mail_tag_message1`	文字列型	メール送信時、メッセージ1~6の中からランダムにメッセージが選択される。
メッセージ2	`mail_tag_message2`	文字列型
メッセージ1	`mail_tag_message3`	文字列型
メッセージ2	`mail_tag_message4`	文字列型
メッセージ1	`mail_tag_message5`	文字列型
メッセージ2	`mail_tag_message6`	文字列型
削除フラグ	`mail_tag_deleted_flag`	文字列型
作成日	`mail_tag_creation_date`	日時型
最終更新日	`mail_tag_last_modified_date`	日時型
最終更新日	`mail_tag_last_modified_null_safe_date`	日時型	NULLの場合作成日
作成担当者ID	`mail_tag_creator_id`	数値型
作成担当者名	`mail_tag_creator_name`	文字列型
最終更新者ID	`mail_tag_last_modified_by_id`	数値型
最終更新者ID	`mail_tag_last_modified_by_null_safe_id`	数値型	NULLの場合作成者ID
最終更新者名	`mail_tag_last_modified_by_name`	文字列型
最終更新者名	`mail_tag_last_modified_by_null_safe_name`	文字列型	NULLの場合作成者名

サンプル

リクエスト

curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxxxxx &refresh_token=xxxxxxx&wait_flag=1&mail_tag_id-like=MyMailTag&mail_tag_month-eq=2' https://api.next-engine.org/api_v1_master_mailtag/count

レスポンス

{
  "result": "success",
  "count": "1",
  "access_token": "xxxxxxxxxxx",
  "access_token_end_date": "2017-04-13 18:24:53",
  "refresh_token": "xxxxxxxxxxx",
  "refresh_token_end_date": "2017-04-15 18:24:53"
}

エラー

エラーコード

エンドポイント固有のエラーコードはありません。共通エラーコードはメッセージコード一覧を参照してください。