PureBasic / easybill REST API / Create s serial number for a position
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; 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.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"serial_number","<string>")
CkJsonObject::ckUpdateString(json,"position_id","<integer>")
CkJsonObject::ckUpdateString(json,"id","<long>")
CkJsonObject::ckUpdateString(json,"document_id","<long>")
CkJsonObject::ckUpdateString(json,"document_position_id","<long>")
CkJsonObject::ckUpdateString(json,"used_at","<string>")
CkJsonObject::ckUpdateString(json,"created_at","<string>")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
CkHttp::ckSetRequestHeader(http,"Authorization","{{apiKey}}")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
resp.i = CkHttpResponse::ckCreate()
If resp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckHttpJson(http,"POST","https://api.easybill.de/rest/v1/serial-numbers",json,"application/json",resp)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkHttpResponse::ckDispose(resp)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkHttpResponse::ckDispose(resp)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
; 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.s = CkJsonObject::ckStringOf(jResp,"serial_number")
position_id.s = CkJsonObject::ckStringOf(jResp,"position_id")
id.s = CkJsonObject::ckStringOf(jResp,"id")
document_id.s = CkJsonObject::ckStringOf(jResp,"document_id")
document_position_id.s = CkJsonObject::ckStringOf(jResp,"document_position_id")
used_at.s = CkJsonObject::ckStringOf(jResp,"used_at")
created_at.s = CkJsonObject::ckStringOf(jResp,"created_at")
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkHttpResponse::ckDispose(resp)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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": ""
}
]
}
