hotweb Business サポートサイト

トップ  »  APIリファレンス  »  付録

付録

エラーコード一覧
エラーコード エラーメッセージ
UnexpectedError 予期せぬエラーが発生しました。
InvalidAccessError アクセスが拒否されました。
MissingAPIKeyParameter リクエストには、APIKeyパラメータが含まれていません。
リクエストに APIKeyパラメータを追加し、再度リクエストを実行してください。
MissingOperationParameter リクエストには、Operationパラメータが含まれていません。
リクエストに Operationパラメータを追加し、再度リクエストを実行してください。
InvalidAPIKeyParameter APIKeyパラメータが無効です。
APIKeyパラメータを修正し、再度リクエストを実行してください。
InvalidOperationParameter Operationパラメータが無効です。
Operationパラメータを修正し、再度リクエストを実行してください。
InvalidPageThumbnailSizeParameter PageThumbnailSizeパラメータが無効です。
PageThumbnailSizeパラメータを修正し、再度リクエストを実行してください。
InvalidCategoryThumbnailSizeParameter CategoryThumbnailSizeパラメータが無効です。
CategoryThumbnailSizeパラメータを修正し、再度リクエストを実行してください。
InvalidPagingNumberParameter PagingNumberパラメータが無効です。
PagingNumberパラメータを修正し、再度リクエストを実行してください。
InvalidPagingUnitParameter PagingUnitパラメータが無効です。
PagingUnitパラメータを修正し、再度リクエストを実行してください。
InvalidSortParameter Sortパラメータが無効です。
Sortパラメータを修正し、再度リクエストを実行してください。
InvalidOrderParameter Orderパラメータが無効です。
Orderパラメータを修正し、再度リクエストを実行してください。
InvalidWithoutownpageParameter WithoutOwnPageパラメータが無効です。
WithoutOwnPageパラメータを修正し、再度リクエストを実行してください。
InvalidResponseItemParameter ResponseItemパラメータが無効です。
ResponseItemパラメータを修正し、再度リクエストを実行してください。
InvalidContentTypeParameter ContentTypeパラメータが無効です。
ContentTypeパラメータを修正し、再度リクエストを実行してください。
MissingPageIdParameter リクエストには、PageIdパラメータが含まれていません。
リクエストに PageIdパラメータを追加し、再度リクエストを実行してください。
InvalidPageIdParameter PageIdパラメータが無効です。
PageIdパラメータを修正し、再度リクエストを実行してください。
InvalidMainCategoryIdParameter MainCategoryIdパラメータが無効です。
MainCategoryIdパラメータを修正し、再度リクエストを実行してください。
InvalidCategoryIdParameter CategoryIdパラメータが無効です。
CategoryIdパラメータを修正し、再度リクエストを実行してください。
InvalidLimitParameter Limitパラメータが無効です。
Limitパラメータを修正し、再度リクエストを実行してください。
NoExactMatches リクエストに該当する結果がありません。
ページ検索XML出力例
<?xml version="1.0" encoding="UTF-8" ?
<APIRequest>
 <ResponseStatus>OK</ResponseStatus>
 <OperationRequest>
  <HTTPHeaders>
   <Header Name="UserAgent" Value="Mozilla/4.0 (compatible; MSIE 6.0; 
Windows NT 5.1; SV1; .NET CLR2.0.50727; .NET CLR 3.0.04506.30)" />
  </HTTPHeaders>
  <Arguments>
   <Argument Name="APIKey" Value="apikeyxxxxxxxxxxxxxxxxxxxx" />
   <Argument Name="Operation" Value="PageSearch" />
   <Argument Name="ResponseItem" Value="Category" />
  </Arguments>
 </OperationRequest>
 <Pages>
  <TotalResults>14</TotalResults>
  <TotalPages>2</TotalPages>
  <Page>
   <PageId>pageidxxxxxxxxxxxxxxxxxxxx</PageId>
   <PageEncoding>utf-8</PageEncoding>
   <Title><![CDATA[ タイトルが表示されます ]]></Title>
   <Summary><![CDATA[ 説明が表示されます ]]></Summary>
   <Keywords><![CDATA[ キーワード,カンマ,区切り,表示 ]]></Keywords>
   <Description><![CDATA[Descriptionが表示されます ]]></Description>
   <Thumbnail>
    <ImageURL>http://image.hotweb.bz/file/imagexxxxxxxxxxxxxxxxxxxx.gif/_/resize/100x100/.gif</ImageURL> 
    <Height>100</Height> 
    <Width>100</Width> 
   </Thumbnail>
   <Tags><![CDATA[ タグ 半角スペース 区切り 表示 ]]></Tags>
   <DisplayOption>
    <NewFlg>1</NewFlg>
   </DisplayOption>
   <PublicationDatetime>2008-11-22 01:57:00</PublicationDatetime>
   <CreateDatetime>2008-11-21 20:15:40</CreateDatetime>
   <CreateUser>demo</CreateUser>
   <UpdateDatetime>2008-11-22 02:03:35</UpdateDatetime>
   <UpdateUser>demo</UpdateUser>
   <Category>
    <MainCategory>
     <MainCategoryId>2</MainCategoryId> 
     <MainCategoryName><![CDATA[ メインカテゴリ名が表示されます ]]></MainCategoryName>
     <LongSummary><![CDATA[ 説明が表示されます ]]></LongSummary>
    </MainCategory>
    <CategoryId>4</CategoryId> 
    <CategoryName><![CDATA[ カテゴリ名が表示されます ]]></CategoryName>
    <ShortSummary><![CDATA[ 説明(小)が表示されます ]]> </ShortSummary>
    <LongSummary><![CDATA[ 説明(大)が表示されます ]]> </LongSummary>
    <Thumbnail>
     <ImageURL>http://image.hotweb.bz/file/imagexxxxxxxxxxxxxxxxxxxx.gif/_/resize/100x100/.gif</ImageURL> 
     <Height>100</Height> 
     <Width>100</Width> 
    </Thumbnail>
    <Tags><![CDATA[ タグ 半角スペース 区切り 表示 ]]></Tags>
   </Category>
  </Page>
  ・
  ・
  ・
 </Pages>
</APIRequest>
ページ詳細XML出力例
<?xml version="1.0" encoding="UTF-8" ?> 
<APIRequest>
 <ResponseStatus>OK</ResponseStatus> 
 <OperationRequest>
  <HTTPHeaders>
  <Header Name="UserAgent" Value="Mozilla/4.0 (compatible; MSIE 6.0; 
Windows NT 5.1; SV1; .NET CLR 2.0.50727; .NET CLR 3.0.04506.30)" /> 
  </HTTPHeaders>
  <Arguments>
   <Argument Name="APIKey" Value="apikeyxxxxxxxxxxxxxxxxxxxx" /> 
   <Argument Name="Operation" Value="PageDetail" /> 
   <Argument Name="PageId" Value="pageidxxxxxxxxxxxxxxxxxxxx" /> 
   <Argument Name="ResponseItem" Value="Category,BackNumber,SimilarPages" /> 
  </Arguments>
 </OperationRequest>
 <Pages>
  <Page>
   <PageId>pageidxxxxxxxxxxxxxxxxxxxx</PageId> 
   <PageEncoding>utf-8</PageEncoding> 
   <Title><![CDATA[ タイトルが表示されます ]]></Title>
   <Summary><![CDATA[ 説明が表示されます ]]></Summary>
   <Keywords><![CDATA[ キーワード,カンマ,区切り,表示 ]]></Keywords>
   <Description><![CDATA[Descriptionが表示されます ]]></Description>
   <PageURL>http://api.hotweb.bz/page/hw_id/hotwebidxxxxxxxxxxxxxxxxxxxx/pg_id/pageidxxxxxxxxxxxxxxxxxxxx/encoding/utf-8</PageURL>
   <Thumbnail>
    <ImageURL>http://image.hotweb.bz/file/imagexxxxxxxxxxxxxxxxxxxx.jpg/_/resize/100x100/.jpg</ImageURL> 
    <Height>66</Height> 
    <Width>100</Width> 
   </Thumbnail>
   <Tags><![CDATA[ タグ 半角スペース 区切り 表示 ]]></Tags>
   <DisplayOption>
    <NewFlg>1</NewFlg>
   </DisplayOption>
   <PublicationDatetime>2008-11-19 19:48:00</PublicationDatetime> 
   <CreateDatetime>2008-11-19 19:47:56</CreateDatetime> 
   <CreateUser>demo</CreateUser> 
   <UpdateDatetime>2008-12-08 00:54:45</UpdateDatetime> 
   <UpdateUser>demo</UpdateUser>
   <Stylesheets>
    <StylesheetURL>http://api.hotweb.bz/file/U1YACZ/css/cssxxxxxxxxxxxxxxxxxxxx/hw_main.css/encoding/utf-8</StylesheetURL> 
   </Stylesheets>
   <Javascripts>
    <JavascriptURL>http://api.hotweb.bz/file/U1YACZ/js/jsxxxxxxxxxxxxxxxxxxxx/hw_main.js/encoding/utf-8</JavascriptURL> 
   </Javascripts>
   <Category>
    <MainCategory>
     <MainCategoryId></MainCategoryId> 
     <MainCategoryName><![CDATA[ メインカテゴリ名が表示されます ]]></MainCategoryName>
     <LongSummary><![CDATA[ 説明が表示されます ]]></LongSummary>
    </MainCategory>
    <CategoryId>4</CategoryId> 
    <CategoryName><![CDATA[ カテゴリ名が表示されます ]]></CategoryName>
    <ShortSummary><![CDATA[ 説明(小)が表示されます ]]></ShortSummary>
    <LongSummary><![CDATA[ 説明(大)が表示されます ]]></LongSummary>
    <Thumbnail>
     <ImageURL>http://image.hotweb.bz/file/imagexxxxxxxxxxxxxxxxxxxx.gif/_/resize/100x100/.gif</ImageURL> 
     <Height>100</Height> 
     <Width>100</Width> 
    </Thumbnail>
    <Tags><![CDATA[ タグ 半角スペース 区切り 表示 ]]></Tags>
   </Category>
   <BackNumber>
    <Pages>
     <Page>
      <PageId>pageidxxxxxxxxxxxxxxxxxxxx</PageId> 
      <PageEncoding>utf-8</PageEncoding> 
      <Title><![CDATA[ タイトルが表示されます ]]></Title>
      <Summary><![CDATA[ 説明が表示されます ]]></Summary>
      <Keywords><![CDATA[ キーワード,カンマ,区切り,表示 ]]></Keywords>
      <Description><![CDATA[Descriptionが表示されます ]]></Description>
      <Thumbnail>
       <ImageURL>http://image.hotweb.bz/file/imagexxxxxxxxxxxxxxxxxxxx.gif/_/resize/100x100/.gif</ImageURL> 
       <Height>100</Height> 
       <Width>100</Width> 
      </Thumbnail>
      <Tags><![CDATA[ タグ 半角スペース 区切り 表示 ]]></Tags>
      <DisplayOption>
       <NewFlg>1</NewFlg> 
      </DisplayOption>
      <PublicationDatetime>2008-11-22 01:57:00</PublicationDatetime> 
      <CreateDatetime>2008-11-21 20:15:40</CreateDatetime> 
      <CreateUser>demo</CreateUser> 
      <UpdateDatetime>2008-11-22 02:03:35</UpdateDatetime> 
      <UpdateUser>demo</UpdateUser> 
     </Page>
      ・
      ・
      ・
     </Pages>
   </BackNumber>
   <SimilarPages>
    <Pages>
     <Page>
      <PageId>pageidxxxxxxxxxxxxxxxxxxxx</PageId> 
      <PageEncoding>utf-8</PageEncoding> 
      <Title><![CDATA[ タイトルが表示されます ]]></Title>
      <Summary><![CDATA[ 説明が表示されます ]]></Summary>
      <Keywords><![CDATA[ キーワード,カンマ,区切り,表示 ]]></Keywords>
      <Description><![CDATA[Descriptionが表示されます ]]></Description>
      <Thumbnail>
       <ImageURL>http://image.hotweb.bz/file/imagexxxxxxxxxxxxxxxxxxxx.gif/_/resize/100x100/.gif</ImageURL> 
       <Height>100</Height> 
       <Width>100</Width> 
      </Thumbnail>
      <Tags><![CDATA[ タグ 半角スペース 区切り 表示 ]]></Tags>
      <DisplayOption>
       <NewFlg>1</NewFlg> 
      </DisplayOption>
      <PublicationDatetime>2008-11-22 01:57:00</PublicationDatetime> 
      <CreateDatetime>2008-11-21 20:15:40</CreateDatetime> 
      <CreateUser>demo</CreateUser> 
      <UpdateDatetime>2008-11-22 02:03:35</UpdateDatetime> 
      <UpdateUser>demo</UpdateUser> 
     </Page>
       ・
       ・
       ・
    </Pages>
   </SimilarPages>
  </Page>
 </Pages>
</APIRequest>
カテゴリ検索XML出力例
<?xml version="1.0" encoding="UTF-8" ?> 
<APIRequest>
 <ResponseStatus>OK</ResponseStatus> 
 <OperationRequest>
  <HTTPHeaders>
  <Header Name="UserAgent" Value="Mozilla/4.0 (compatible; MSIE 6.0; 
Windows NT 5.1; SV1; .NET CLR 2.0.50727; .NET CLR 3.0.04506.30)" /> 
  </HTTPHeaders>
  <Arguments>
   <Argument Name="APIKey" Value="apikeyxxxxxxxxxxxxxxxxxxxx" /> 
   <Argument Name="Operation" Value="CategorySearch" />
   <Argument Name="CategoryId" Value="1" />
   <Argument Name="ResponseItem" Value="Pages" />
  </Arguments>
 </OperationRequest>
 <Categories>
  <TotalResults>4</TotalResults> 
  <TotalPages>1</TotalPages> 
 <Category>
  <MainCategory>
   <MainCategoryId>2</MainCategoryId> 
   <MainCategoryName><![CDATA[ メインカテゴリ名が表示されます ]]></MainCategoryName>
   <LongSummary><![CDATA[ 説明が表示されます ]]></LongSummary>
  </MainCategory>
  <CategoryId>1</CategoryId> 
  <CategoryName><![CDATA[ カテゴリ名が表示されます ]]></CategoryName>
  <ShortSummary><![CDATA[ 説明(小)が表示されます ]]> </ShortSummary>
  <LongSummary><![CDATA[ 説明(大)が表示されます ]]> </LongSummary>            
  <Thumbnail>
   <ImageURL>http://image.hotweb.bz/file/imagexxxxxxxxxxxxxxxxxxxx.jpg/_/resize/100x100/.jpg</ImageURL> 
   <Height>100</Height> 
   <Width>100</Width> 
  </Thumbnail>
  <Tags><![CDATA[ タグ 半角スペース 区切り 表示 ]]></Tags>
  <TotalPageCount>4</TotalPageCount> 
 </Category>
 ・
 ・
 ・
 </Categories>
 <Pages>
  <TotalResults>11</TotalResults> 
  <TotalPages>2</TotalPages>
  <Page>
   <PageId>pageidxxxxxxxxxxxxxxxxxxxx</PageId> 
   <PageEncoding>utf-8</PageEncoding> 
   <Title><![CDATA[ タイトルが表示されます ]]> </Title>
   <Summary><![CDATA[ 説明が表示されます ]]></Summary>
   <Keywords><![CDATA[ キーワード,カンマ,区切り,表示 ]]></Keywords>
   <Description><![CDATA[Descriptionが表示されます ]]> </Description>
   <Tags><![CDATA[ タグ 半角スペース 区切り 表示 ]]></Tags>
   <DisplayOption>
    <NewFlg>1</NewFlg> 
   </DisplayOption>
   <PublicationDatetime>2008-11-22 01:57:00</PublicationDatetime> 
   <CreateDatetime>2008-11-21 20:15:40</CreateDatetime> 
   <CreateUser>demo</CreateUser> 
   <UpdateDatetime>2008-11-22 02:03:35</UpdateDatetime> 
   <UpdateUser>demo</UpdateUser>
  </Page>
  ・
  ・
  ・
  </Pages>
</APIRequest>

APIリファレンス メニュー