書庫文書の登録 – Shopらんサポートサイト

書庫文書の登録を行うことができます。

呼び出しURL

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

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

リクエスト

パラメータ名	意味	必須	制約
func	動作モード	〇	必ずcreateを指定します。
key	WebAPIキー	〇	書庫の操作が可能なWebAPIキーを指定します。
title	文書タイトル	〇	登録する書庫文書の文書タイトルを指定します。 UTF-8エンコーディングで240バイト以内の文字列を指定することができます。
description	メモ		登録する書庫文書のメモを指定します。 UTF-8エンコーディングで2000バイト以内の文字列を指定することができます。
recvStore	公開先店舗		特定の店舗・店舗グループに対してのみ公開する書庫文書を登録するには、店舗の店舗コードもしくは店舗グループのグループコードを指定することができます。補足事項・複数の店舗を指定する場合には同一パラメータ名を列挙し値を変えて指定してください。・パラメータの指定を省略した場合、または__$ALL（アンダーバー2つに$ALL）という特殊コードを指定した場合は全ての店舗に公開されます。・指定したコードが店舗コードおよび店舗グループコードどちらにも存在する場合は、店舗コードが優先されます。
colors	送り先の区分		環境の分割機能を有効にしているとき、書庫文書の公開先となる区分の識別コードを指定します。補足事項パラーメータの指定を省略した場合、全ての区分に公開されます。
openDate	公開期間の開始日		公開期間の開始日を'yyyy-MM-dd'のフォーマットで指定することができます。
closeDate	公開期間の終了日		公開期間の終了日を'yyyy-MM-dd'のフォーマットで指定することができます。
pubGroup	発信部署		発信部署として指定する本部グループのグループコードを指定することができます。
category(X)	カテゴリ項目		カテゴリ項目を指定します。パラメータ名のXの部分に、カテゴリグループのIDを指定します。例えば書庫で使用すると指定されているカテゴリグループのIDが123の場合、パラメータ名はcategory(123)となります。パラメータの値は、そのカテゴリグループに属するカテゴリ項目の項目IDを指定します。補足事項複数のカテゴリを指定する場合には同一パラメータ名を列挙し値を変えて指定してください。
keyword	キーワード		キーワード機能を有効にしているとき、書庫文書にキーワードを指定することができます。キーワードには、UTF-8エンコーディングで120バイト以内の文字列を指定することができます。補足事項複数のキーワードを指定する場合には同一パラメータ名を列挙し値を変えて指定してください。
path	フォルダーパス		フォルダー分類機能を有効にしているときに、書庫文書をツリーで表示するためのフォルダーパスを指定することができます。補足事項パラメータの指定を省略した場合、またはブランク文字列を指定した場合は第一階層「/」に登録されます。
printPdf	PDFの印刷		書庫にPDFファイルをアップロードする場合に利用できます。 PDFファイルの印刷を制限する場合に1を指定します。
file	アップロードするファイル	〇	書庫にアップロードするファイルを指定します。

補足事項

ファイルのアップロードが必須なため、フォームのPOST時には必ずmultipart/form-data形式で送信する必要があります。

HTMLによるリクエストサンプル

公開先店舗に複数指定したい場合

<form method="POST"
    enctype="multipart/form-data">
    　：
    <input name="recvStore" value="STR00001" />
    <input name="recvStore" value="STR00001" />
    　：
</form>

カテゴリを複数指定したい場合

<form method="POST"
    enctype="multipart/form-data">
    　：
    <input name="category(123)" value="11" />
    <input name="category(123)" value="51" />
    　：
</form>

レスポンス

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="doc-id" type="xsd:int" minOccurs="0" 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/doc-id	書庫文書番号	書庫文書の登録に成功した場合に、登録された書庫文書の文書番号が返されます。
//response/errors	エラーメッセージ	エラーが発生した場合は、詳細なエラーメッセージが文字列として返されます。

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

<response>
 <result>1</result>
 <doc-id>8727</doc-id>
</response>

上の例では、//response/resultの値が1なので呼び出しは成功しており、//response/doc-idに追加された書庫文書の文書番号が返されます。

呼び出しURL

リクエスト

HTMLによるリクエストサンプル

レスポンス

このセクションの記事

関連記事