Chilkat Online Tools

PureBasic / Egyptian eInvoicing SDK R1.5 / 11. Update EGS Code Usage

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.

    ; {
    ;   "itemCode": "EG-113317713-ABCD",
    ;   "codeName": "ABCD Updated",
    ;   "codeNameAr": "ABCD Updated Arabic",
    ;   "activeFrom": "2021-04-06T00:00:00Z",
    ;   "activeTo": "2021-06-30T23:59:59Z",
    ;   "description": "Description of code 123",
    ;   "descriptionAr": " 2314 وصف الكود بالعربي",
    ;   "parentCode": "10000051",
    ;   "requestReason": "Request reason text Updated",
    ;   "linkedCode": "EG-728466198-Yes"
    ; }

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"itemCode","EG-113317713-ABCD")
    CkJsonObject::ckUpdateString(json,"codeName","ABCD Updated")
    CkJsonObject::ckUpdateString(json,"codeNameAr","ABCD Updated Arabic")
    CkJsonObject::ckUpdateString(json,"activeFrom","2021-04-06T00:00:00Z")
    CkJsonObject::ckUpdateString(json,"activeTo","2021-06-30T23:59:59Z")
    CkJsonObject::ckUpdateString(json,"description","Description of code 123")
    CkJsonObject::ckUpdateString(json,"descriptionAr"," 2314 وصف الكود بالعربي")
    CkJsonObject::ckUpdateString(json,"parentCode","10000051")
    CkJsonObject::ckUpdateString(json,"requestReason","Request reason text Updated")
    CkJsonObject::ckUpdateString(json,"linkedCode","EG-728466198-Yes")

    CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
    CkHttp::ckSetRequestHeader(http,"Accept-Language","en")
    ; Adds the "Authorization: Bearer <access_token>" header.
    CkHttp::setCkAuthToken(http, "<access_token>")

    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://domain.com/api/v1.0/codetypes/requests/codes/:codeUsageRequestId",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

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)



    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)
    CkStringBuilder::ckDispose(sbRequestBody)


    ProcedureReturn
EndProcedure

Curl Command

curl -X PUT
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-H "Accept-Language: en"
	-d '{
    "itemCode": "EG-113317713-ABCD",
    "codeName": "ABCD Updated",
    "codeNameAr": "ABCD Updated Arabic",
    "activeFrom": "2021-04-06T00:00:00Z",
    "activeTo": "2021-06-30T23:59:59Z",
    "description": "Description of code 123",
    "descriptionAr": " 2314 وصف الكود بالعربي",
    "parentCode": "10000051",
    "requestReason": "Request reason text Updated",
    "linkedCode": "EG-728466198-Yes"
}'
https://domain.com/api/v1.0/codetypes/requests/codes/:codeUsageRequestId

Postman Collection Item JSON

{
  "name": "11. Update EGS Code Usage",
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{generatedAccessToken}}",
          "type": "string"
        }
      ]
    },
    "method": "PUT",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept-Language",
        "value": "en",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"itemCode\": \"EG-113317713-ABCD\",\n    \"codeName\": \"ABCD Updated\",\n    \"codeNameAr\": \"ABCD Updated Arabic\",\n    \"activeFrom\": \"2021-04-06T00:00:00Z\",\n    \"activeTo\": \"2021-06-30T23:59:59Z\",\n    \"description\": \"Description of code 123\",\n    \"descriptionAr\": \" 2314 وصف الكود بالعربي\",\n    \"parentCode\": \"10000051\",\n    \"requestReason\": \"Request reason text Updated\",\n    \"linkedCode\": \"EG-728466198-Yes\"\n}"
    },
    "url": {
      "raw": "{{apiBaseUrl}}/api/v1.0/codetypes/requests/codes/:codeUsageRequestId",
      "host": [
        "{{apiBaseUrl}}"
      ],
      "path": [
        "api",
        "v1.0",
        "codetypes",
        "requests",
        "codes",
        ":codeUsageRequestId"
      ],
      "variable": [
        {
          "key": "codeUsageRequestId",
          "value": ""
        }
      ]
    }
  },
  "response": [
  ]
}