お知らせの削除 – Shopらんサポートサイト

お知らせの登録APIで登録したお知らせの削除を行うことができます。

呼び出し先URL

{your-domain} の部分をご利用の環境にあわせて変更してください。

https://{your-domain}/h2/STRNoticeManipurator.do

リクエスト

パラメータ名	意味	必須	制約
`func`	動作モード	〇	必ず `delete` を指定します。
`key`	WebAPIキー	〇	お知らせ操作APIが利用可能で、かつ削除対象のお知らせを登録した際に指定した WebAPIキーを指定します。
`id`	削除対象のお知らせNo.	〇	削除するお知らせのお知らせNo.を指定します。`create` 操作の結果として返された `notice-id` の値を指定します。

補足事項

ファイルのアップロードが不要なため、POST 時に application/x-www-form-urlencoded で送信できます。

制限事項

お知らせの削除APIには以下の制約があります。

お知らせの削除APIで削除可能なお知らせは、お知らせの登録APIで登録したお知らせのみ です。
お知らせ作成時に指定した WebAPIキーと異なるキーを指定した場合は、削除できません。

レスポンス

API の呼び出し結果は、以下のスキーマの XML 文書として返されます。

<?xml version="1.0"?>
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <xsd:element name="response">
    <xsd:sequence>
      <xsd:element name="result" type="xsd:int" minOccurs="1" maxOccurs="1" />
      <xsd:element name="errors" type="xsd:string" minOccurs="0" maxOccurs="1"/>
    </xsd:sequence>
  </xsd:element>
</xsd:schema>

レスポンス要素

要素	意味	備考
`//response/result`	リザルトコード	以下の値をとります。 `1`: 成功 `4`: 入力パラメータの内容にエラーがある `8`: その他のシステムエラーが発生
`//response/errors`	エラーメッセージ	エラーが発生した場合は、詳細なエラーメッセージが文字列として返されます。

削除操作に成功した場合のレスポンスXML例

<response>
  <result>1</result>
</response>

説明

上の例では、//response/result の値が 1 なので呼び出しは成功しています。

削除操作に失敗した場合のレスポンスXML例

<response>
  <result>4</result>
  <errors><![CDATA[
    * Specified notice is not created by WebAPI.
  ]]></errors>
</response>

説明

上の例では //response/result の値が 4 なので呼び出しは失敗しています。
//response/errors に、指定したお知らせが API で登録したお知らせではない旨のエラーメッセージが返されます。