PureBasic / easybill REST API / Update a position discount
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.
; {
; "customer_id": "<long>",
; "position_id": -79862919,
; "id": "<long>",
; "discount": 0,
; "discount_type": "PERCENT"
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"customer_id","<long>")
CkJsonObject::ckUpdateInt(json,"position_id",-79862919)
CkJsonObject::ckUpdateString(json,"id","<long>")
CkJsonObject::ckUpdateInt(json,"discount",0)
CkJsonObject::ckUpdateString(json,"discount_type","PERCENT")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
CkHttp::ckSetRequestHeader(http,"Authorization","{{apiKey}}")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
sbRequestBody.i = CkStringBuilder::ckCreate()
If sbRequestBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckEmitSb(json,sbRequestBody)
resp.i = CkHttp::ckPTextSb(http,"PUT","https://api.easybill.de/rest/v1/discounts/position/:id",sbRequestBody,"utf-8","application/json",0,0)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
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."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "customer_id": "<long>",
; "position_id": -79862919,
; "id": "<long>",
; "discount": 0,
; "discount_type": "PERCENT"
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
customer_id.s = CkJsonObject::ckStringOf(jResp,"customer_id")
position_id.i = CkJsonObject::ckIntOf(jResp,"position_id")
id.s = CkJsonObject::ckStringOf(jResp,"id")
discount.i = CkJsonObject::ckIntOf(jResp,"discount")
discount_type.s = CkJsonObject::ckStringOf(jResp,"discount_type")
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -X PUT
-H "Authorization: {{apiKey}}"
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"customer_id": "<long>",
"position_id": -79862919,
"id": "<long>",
"discount": 0,
"discount_type": "PERCENT"
}'
https://api.easybill.de/rest/v1/discounts/position/:id
Postman Collection Item JSON
{
"name": "Update a position discount",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"customer_id\": \"<long>\",\n \"position_id\": -79862919,\n \"id\": \"<long>\",\n \"discount\": 0,\n \"discount_type\": \"PERCENT\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/discounts/position/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"discounts",
"position",
":id"
],
"variable": [
{
"key": "id",
"value": "<long>",
"description": "(Required) ID of the to be soon updated discount"
}
]
}
},
"response": [
{
"name": "Successful operation",
"originalRequest": {
"method": "PUT",
"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 \"customer_id\": \"<long>\",\n \"position_id\": -79862919,\n \"id\": \"<long>\",\n \"discount\": 0,\n \"discount_type\": \"PERCENT\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/discounts/position/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"discounts",
"position",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"customer_id\": \"<long>\",\n \"position_id\": -79862919,\n \"id\": \"<long>\",\n \"discount\": 0,\n \"discount_type\": \"PERCENT\"\n}"
},
{
"name": "Not found",
"originalRequest": {
"method": "PUT",
"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 \"customer_id\": \"<long>\",\n \"position_id\": -79862919,\n \"id\": \"<long>\",\n \"discount\": 0,\n \"discount_type\": \"PERCENT\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/discounts/position/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"discounts",
"position",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
},
{
"name": "Too Many Requests",
"originalRequest": {
"method": "PUT",
"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 \"customer_id\": \"<long>\",\n \"position_id\": -79862919,\n \"id\": \"<long>\",\n \"discount\": 0,\n \"discount_type\": \"PERCENT\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/discounts/position/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"discounts",
"position",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
}
]
}
