記事 6 / 8

APIが返すもの

JSONで常にリソース全体を返し、問題があるときは安定したエラーコードを返します。

レスポンス

  • 時計の作成では、watchId付きの時計が返されます。カードの紐付けで次に指定するのは、このwatchIdです(idではありません)。
  • カードの確認(can-link-card)では、canLinkCardとpassportCheckが返されます:適用されるレベル、不足している項目、登録済みのシリアル番号。
  • カードの紐付けでは、作成されたパスポートがカード番号(certificateCardId)付きで返されます。
  • パスポートの読み取りでは、すべての情報が返されます:時計、写真、認証レベル、盗難ステータス、保証、そして閲覧権限の範囲での所有者情報。

一覧はページ分割されます。ラベルはaccept-languageヘッダーで指定した言語に従います(デフォルトは英語)。

独自の参照番号でパスポートを検索

GET /certificates/by-external-ref/{ref}は、お客様の参照番号で作成されたパスポートを返します。レスポンスはGET /certificates/{certificateCardId}と同じです。表示されるのはお客様が作成したものだけです。検索では大文字・小文字とスペースは区別されず、/を含む参照番号は%2Fとエンコードします。

カードが紐付けられるまでは404が返されます。GET /watches/by-external-ref/{ref}なら、どの段階でも時計を検索できます。

エラー

エラー時はHTTPコードが返され、本文には安定したコード(code)、リクエストの言語によるメッセージ(message)、場合によっては詳細(params)が含まれます。変わる可能性があるメッセージではなく、コードを読んでください。例:

HTTPコードcode意味
422PASSPORT_INCOMPLETE項目が不足しています:params.missingFieldsに一覧があります
409PASSPORT_SERIAL_ALREADY_REGISTERED同じメーカーの別のパスポートがこのシリアル番号を使用しています
403PASSPORT_AUTHENTICATION_TYPE_NOT_ALLOWEDこの認証レベルはお客様の業種では利用できません
400OWNERSHIP_PROFESSIONAL_OWNER_REFUSED所有者として登録されたメールアドレスはプロのものです
次の記事所有者の変更とアフターサービス