Chilkat Online Tools

autoit / easybill REST API / Update position group

Back to Collection Items

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

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

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

; The following JSON is sent in the request body.

; {
;   "number": "<string>",
;   "name": "<string>",
;   "description": null,
;   "login_id": "<long>",
;   "display_name": "<string>",
;   "id": "<long>"
; }

$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("number","<string>")
$oJson.UpdateString("name","<string>")
$oJson.UpdateNull("description")
$oJson.UpdateString("login_id","<long>")
$oJson.UpdateString("display_name","<string>")
$oJson.UpdateString("id","<long>")

$oHttp.SetRequestHeader "Content-Type","application/json"
$oHttp.SetRequestHeader "Authorization","{{apiKey}}"
$oHttp.SetRequestHeader "Accept","application/json"

$oSbRequestBody = ObjCreate("Chilkat.StringBuilder")
$oJson.EmitSb($oSbRequestBody)

Local $oResp = $oHttp.PTextSb("PUT","https://api.easybill.de/rest/v1/position-groups/:id",$oSbRequestBody,"utf-8","application/json",False,False)
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)

$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oResp.Header & @CRLF)
    ConsoleWrite("Failed." & @CRLF)

    Exit
EndIf

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

; {
;   "number": "<string>",
;   "name": "<string>",
;   "description": null,
;   "login_id": "<long>",
;   "display_name": "<string>",
;   "id": "<long>"
; }

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

Local $sV_number = $oJResp.StringOf("number")
Local $sName = $oJResp.StringOf("name")
Local $sDescription = $oJResp.StringOf("description")
Local $sLogin_id = $oJResp.StringOf("login_id")
Local $sDisplay_name = $oJResp.StringOf("display_name")
Local $sId = $oJResp.StringOf("id")

Curl Command

curl -X PUT
	-H "Authorization: {{apiKey}}"
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "number": "<string>",
  "name": "<string>",
  "description": null,
  "login_id": "<long>",
  "display_name": "<string>",
  "id": "<long>"
}'
https://api.easybill.de/rest/v1/position-groups/:id

Postman Collection Item JSON

{
  "name": "Update position group",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"number\": \"<string>\",\n  \"name\": \"<string>\",\n  \"description\": null,\n  \"login_id\": \"<long>\",\n  \"display_name\": \"<string>\",\n  \"id\": \"<long>\"\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/position-groups/:id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "position-groups",
        ":id"
      ],
      "variable": [
        {
          "key": "id",
          "value": "<long>",
          "description": "(Required) ID of position goup"
        }
      ]
    }
  },
  "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  \"number\": \"<string>\",\n  \"name\": \"<string>\",\n  \"description\": null,\n  \"login_id\": \"<long>\",\n  \"display_name\": \"<string>\",\n  \"id\": \"<long>\"\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/position-groups/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "position-groups",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"number\": \"<string>\",\n  \"name\": \"<string>\",\n  \"description\": null,\n  \"login_id\": \"<long>\",\n  \"display_name\": \"<string>\",\n  \"id\": \"<long>\"\n}"
    },
    {
      "name": "Invalid position group",
      "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  \"number\": \"<string>\",\n  \"name\": \"<string>\",\n  \"description\": null,\n  \"login_id\": \"<long>\",\n  \"display_name\": \"<string>\",\n  \"id\": \"<long>\"\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/position-groups/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "position-groups",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_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  \"number\": \"<string>\",\n  \"name\": \"<string>\",\n  \"description\": null,\n  \"login_id\": \"<long>\",\n  \"display_name\": \"<string>\",\n  \"id\": \"<long>\"\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/position-groups/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "position-groups",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}