Chilkat Online Tools

Ruby / easybill REST API / Create s serial number for a position

Back to Collection Items

require 'chilkat'

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

http = Chilkat::CkHttp.new()

# Use this online tool to generate code from sample JSON: Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "serial_number": "<string>",
#   "position_id": "<integer>",
#   "id": "<long>",
#   "document_id": "<long>",
#   "document_position_id": "<long>",
#   "used_at": "<string>",
#   "created_at": "<string>"
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("serial_number","<string>")
json.UpdateString("position_id","<integer>")
json.UpdateString("id","<long>")
json.UpdateString("document_id","<long>")
json.UpdateString("document_position_id","<long>")
json.UpdateString("used_at","<string>")
json.UpdateString("created_at","<string>")

http.SetRequestHeader("Content-Type","application/json")
http.SetRequestHeader("Authorization","{{apiKey}}")
http.SetRequestHeader("Accept","application/json")

# resp is a CkHttpResponse
resp = http.PostJson3("https://api.easybill.de/rest/v1/serial-numbers","application/json",json)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";

    exit
end

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "serial_number": "<string>",
#   "position_id": "<integer>",
#   "id": "<long>",
#   "document_id": "<long>",
#   "document_position_id": "<long>",
#   "used_at": "<string>",
#   "created_at": "<string>"
# }

# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

serial_number = jResp.stringOf("serial_number")
position_id = jResp.stringOf("position_id")
id = jResp.stringOf("id")
document_id = jResp.stringOf("document_id")
document_position_id = jResp.stringOf("document_position_id")
used_at = jResp.stringOf("used_at")
created_at = jResp.stringOf("created_at")

Curl Command

curl -X POST
	-H "Authorization: {{apiKey}}"
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "serial_number": "<string>",
  "position_id": "<integer>",
  "id": "<long>",
  "document_id": "<long>",
  "document_position_id": "<long>",
  "used_at": "<string>",
  "created_at": "<string>"
}'
https://api.easybill.de/rest/v1/serial-numbers

Postman Collection Item JSON

{
  "name": "Create s serial number for a position",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"serial_number\": \"<string>\",\n  \"position_id\": \"<integer>\",\n  \"id\": \"<long>\",\n  \"document_id\": \"<long>\",\n  \"document_position_id\": \"<long>\",\n  \"used_at\": \"<string>\",\n  \"created_at\": \"<string>\"\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/serial-numbers",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "serial-numbers"
      ]
    }
  },
  "response": [
    {
      "name": "Successful operation",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "Authorization",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"serial_number\": \"<string>\",\n  \"position_id\": \"<integer>\",\n  \"id\": \"<long>\",\n  \"document_id\": \"<long>\",\n  \"document_position_id\": \"<long>\",\n  \"used_at\": \"<string>\",\n  \"created_at\": \"<string>\"\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/serial-numbers",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "serial-numbers"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"serial_number\": \"<string>\",\n  \"position_id\": \"<integer>\",\n  \"id\": \"<long>\",\n  \"document_id\": \"<long>\",\n  \"document_position_id\": \"<long>\",\n  \"used_at\": \"<string>\",\n  \"created_at\": \"<string>\"\n}"
    },
    {
      "name": "Invalid PositionID",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "Authorization",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"serial_number\": \"<string>\",\n  \"position_id\": \"<integer>\",\n  \"id\": \"<long>\",\n  \"document_id\": \"<long>\",\n  \"document_position_id\": \"<long>\",\n  \"used_at\": \"<string>\",\n  \"created_at\": \"<string>\"\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/serial-numbers",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "serial-numbers"
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "Too Many Requests",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "Authorization",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"serial_number\": \"<string>\",\n  \"position_id\": \"<integer>\",\n  \"id\": \"<long>\",\n  \"document_id\": \"<long>\",\n  \"document_position_id\": \"<long>\",\n  \"used_at\": \"<string>\",\n  \"created_at\": \"<string>\"\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/serial-numbers",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "serial-numbers"
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}