4.8 INSERTメソッド

 クライアントがサーバにデータベースレコードの新規登録を要求するメソッドである。サーバは、リクエストで指定されたデータベースにレコードを登録し、その結果をレスポンスとして返す。また、リクエストの指定によっては登録したレコードを指定された編集形式でレスポンスとして返す。

4.8.1 リクエスト

4.8.1.1 Request-Line

        Request-Line    =       Method SP Handle SP Frame SP CATP-Version SP 
                                Request-Code SP Request-Phrase CRLF

 (1) Method

        Method          =       "INSERT"

 (2) Handle

 GETHANDLEリクエストによって取得したハンドルを指定する。

 (3) Frame

 フレームには3桁の任意の数字を指定する。但し、このフレームの値はサーバにて参照されない。

 (4) CATP-Version

 クライアントがサポートしている最新のCATPバージョンを指定する。

 (5) Request-Code

 リクエストコードは、リクエストを表すコードである数字3桁の0を指定する。

        Request-Code    =       "000"   ; 数字3桁の0

 (6) Request-Phrase

 リクエストの説明句として、下記のトークンを指定する。

        Request-Phrase  =       "REQUEST"       

4.8.1.2 Request-Header

        Request-Header  =       Database-names
                                [Returned-edit-type]

 (1) Database-names

 登録対象のデータベース名を指定する。データベース名は一つだけ指定可能である。

        Database-names  =       "Database-names" ":" Database-name CRLF
        Database-name   =       token

 (2) Returned-edit-type

 登録が成功した場合で、そのデータベースレコードの返送を望む場合の編集形式を指定する。本フィールドが省略された場合、登録したデータベースレコードの返送はされない。

        Returned-edit-type      =       "Returned-edit-type" ":" Edit-type CRLF
        Edit-type               =       1DIGIT

 尚、Edit-typeと編集形式の対応は、サーバの実装による。

4.8.1.3 Object-Header

 (1) Content-Length

 オブジェクトボディのレングスを指定する。

 (2) Encoding

 オブジェクトボディのエンコーディング方式を指定する。

4.8.1.4 Object-Body

 オブジェクトボディには、登録するデータベースレコードを設定する。登録可能なデータベースレコード数は1件であり、単一レコードとなる。

        Object-Body       =     Database-record
        Database-record   =     Record
        Record            = 1*DB-field
        DB-field          = Field | Group-field
        Group-field       = Group-field-start 1*Field Group-field-end
        Group-field-start = "<" Group-name ">" CRLF
        Group-field-end   = "&lt/" [Group-name] ">" CRLF
        Group-name        = token
        Field             = Tag "=" Value CRLF
        Tag               = token
        Value             = text

4.8.2 レスポンス

4.8.2.1 Status-Line

        Status-Line     =       Method SP Handle SP Frame SP CATP-Version SP 
                                Status-Code SP Reason-Phrase CRLF

 (1) Method

 メソッドはクライアントがリクエストラインに指定したメソッドと同じものを指定する。

 (2) Handle

 ハンドルはクライアントがリクエストラインに指定したハンドルと同じものを指定する。

 (3) Frame

 フレームはクライアントがリクエストラインに指定したフレームと同じものを指定する。

 (4) CATP-Version

 CATPバージョンは、サーバで使用されるプロトコールのバージョンを指定する。クライアントがリクエストラインで指定したCATPバージョンが、サーバがサポートしているバージョンよりも古い場合、サーバはそのバージョンをサポートしていることが望まれる。その場合クライアント指定のCATPバージョンをステータスラインに指定する。

 (5) Status-CodeとReason-Phrase

 サーバでのリクエストに対する処理結果を意味する。各コードの詳細並びにReason-Phraseはサーバの実装による。

  1. 2xx     :       成功
     本メソッドがサーバにおいて正常に処理されたことを意味する。
  2. 3xx     :      警告成功
     本メソッドがサーバにおいて警告つきで処理されたことを意味する。
  3. 4xx     :       クライアントエラー
     リクエストに間違った構文があるか、実行がもともと不可能である。
  4. 5xx     :       サーバエラー
       サーバはリクエストを遂行できなかったことを意味する。

4.8.2.2 Response-Header

        Response-Header =       [Registered-record-id]

 (1) Registered-record-id

 データベースレコードの登録の結果、新しく採番されたレコードのID指定する。

        Registered-record-id    =       "Record-id" ":" Record-id CRLF
        Record-id               =       token

4.8.2.3 Object-Header

 (1) Content-Length

 オブジェクトボディのレングスを指定する。

 (2) Encoding

 オブジェクトボディのエンコーディング方式を指定する。オブジェクトボディが存在しない場合は省略しても良い。

4.8.2.4 Object-Body

 オブジェクトボディには登録したデータベースレコードまたは診断レコードを設定する。データベースレコードの場合、その形式はRequest-HeaderのReturned-edit-typeフィールドの指定に従う。尚、データベースレコードは単一レコードである。

 尚、下記の場合はオブジェクトボディ部にデータベースレコードは設定されない。

        Object-Body             =       Diagnostic-record | Database-record
        Database-record         =       Record
        Record                  =       1*DB-field
        DB-field                =       Field | Group-field     ; 単一フィールドとグループフィールド
        Group-Field             =       Group-field-start 1*Field Group-field-end
        Group-field-start       =       "<" Group-name ">" CRLF
        Group-field-end         =       "</" [Group-name] ">" CRLF
        Group-name              =       token
        Field                   =       Tag "=" Value CRLF
        Tag                     =       token   ; データベースのフィールドタグ
        Value                   =       text