メッセージ情報取得API

マーケティングプラットフォームのメッセージ情報を参照するためのAPIです。

メソッド名

messagestr.get

リクエスト情報

アクセスURL

メソッド	URL
GET	https://{domainname}/services/rest/messagestr

URL部パラメータ

パラメータ名	必須	内容
search_key{cid}	オプション	検索条件のキー項目指定可能なキー項目は下記「検索条件に指定可能なカラム」参照
search_operator{cid}	オプション	“検索条件の比較演算子を指定 eq( = ), ne( != ), ge( >= ), gt( > ), le( <= ), lt( < ), like”
search_value{cid}	オプション	検索値 Nullを指定する場合は、何も指定しません。例： search_value1=
order	オプション	並び順の項目指定可能な並び順の項目は下記「検索条件・並び順に指定可能なカラム」参照
direction	オプション	並び順を指定する「asc」（昇順）または「desc」（降順）
limit	オプション	1回のリクエストで取得するレコード数（最大1000）
offset	オプション	レコードのオフセット

検索条件・並び順に指定可能なカラム

カラム名	検索条件	並び順	内容
Id	○	○	メッセージ情報ID
Str	○	○	メッセージ情報
MessageId	○	○	メッセージID
MessageName	○	○	メッセージコード
LanguageID	○	○	言語ID
IsDefault	○	○	デフォルトフラグ
DateRegist	○	○	登録日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
DateUpdate	○	○	更新日時(JST) YYYY-mm-ddTHH:MM:SS+09:00

HTTPリクエストヘッダ

なし

HTTPリクエストボディ

なし

レスポンス情報

レスポンスコード

コード	内容
200	正常終了

HTTPレスポンスヘッダ

なし

HTTPレスポンスボディ

★ エレメント名：MessageStrList ★ データ型：MessageStrType

カラム名	データ型	内容
Id	string	メッセージ情報ID
Str	string	メッセージ情報
Message	MessageType	メッセージ MessageId：MessageName メッセージId：メッセージコード
Language	LanguageType	言語 LanguageId：LanguageName 言語ID：言語名
IsDefault	string	デフォルトフラグ 1:デフォルト 0:デフォルトではない
DateRegist	dateTime	登録日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
DateUpdate	dateTime	更新日時(JST) YYYY-mm-ddTHH:MM:SS+09:00

XMLサンプル

リクエストXMLサンプル

なし

レスポンスXMLサンプル

<?xml version="1.0" encoding="UTF-8"?>
<MessageStrList xmlns="http://smartseminar.jp/" version="1.44">
    <MessageStr>
        <IsDefault>0</IsDefault>
        <Id>70704</Id>
        <Language>
            <LanguageName>日本語</LanguageName>
            <LanguageId>1</LanguageId>
        </Language>
        <Str>対象IDが指定されていません</Str>
        <DateRegist>2016-09-05T11:24:35+08:00</DateRegist>
        <DateUpdate>2016-09-05T11:24:35+08:00</DateUpdate>
        <Message>
            <MessageName>C_SERVICES_SYSTEMSETTING_NOT_SUPPLIED_ID</MessageName>
            <MessageId>35022</MessageId>
        </Message>
    </MessageStr>
</MessageStrList>

制限事項

なし