Chilkat Online Tools

Ruby / Egyptian eInvoicing SDK R1.5 / 9. Search Published Codes

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()

queryParams = Chilkat::CkJsonObject.new()
queryParams.UpdateString("ParentLevelName","GPC Level 4 Code - Brick")
queryParams.UpdateString("OnlyActive","true")
queryParams.UpdateString("ActiveFrom","2019-01-01T00:00:00Z")
queryParams.UpdateInt("Ps",10)
queryParams.UpdateInt("Pn",1)
queryParams.UpdateString("OrdDir","Descending")
queryParams.UpdateInt("CodeTypeLevelNumber",5)

# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")
http.SetRequestHeader("Accept-Language","en")

# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://domain.com/api/v1.0/codetypes/:codeType/codes",queryParams)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";

Curl Command

curl -G -d "ParentLevelName=GPC%20Level%204%20Code%20-%20Brick"
	-d "OnlyActive=true"
	-d "ActiveFrom=2019-01-01T00%3A00%3A00Z"
	-d "Ps=10"
	-d "Pn=1"
	-d "OrdDir=Descending"
	-d "CodeTypeLevelNumber=5"
	-H "Authorization: Bearer <access_token>"
	-H "Accept-Language: en"
https://domain.com/api/v1.0/codetypes/:codeType/codes

Postman Collection Item JSON

{
  "name": "9. Search Published Codes",
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{generatedAccessToken}}",
          "type": "string"
        }
      ]
    },
    "method": "GET",
    "header": [
      {
        "key": "Accept-Language",
        "value": "en",
        "type": "text"
      }
    ],
    "url": {
      "raw": "{{apiBaseUrl}}/api/v1.0/codetypes/:codeType/codes?ParentLevelName=GPC Level 4 Code - Brick&OnlyActive=true&ActiveFrom=2019-01-01T00:00:00Z&Ps=10&Pn=1&OrdDir=Descending&CodeTypeLevelNumber=5",
      "host": [
        "{{apiBaseUrl}}"
      ],
      "path": [
        "api",
        "v1.0",
        "codetypes",
        ":codeType",
        "codes"
      ],
      "query": [
        {
          "key": "CodeLookupValue",
          "value": "6222007147906",
          "disabled": true
        },
        {
          "key": "ParentCodeLookupValue",
          "value": "10002443",
          "disabled": true
        },
        {
          "key": "CodeID",
          "value": "1127443",
          "disabled": true
        },
        {
          "key": "CodeName",
          "value": "CERAMICA INNOVA",
          "disabled": true
        },
        {
          "key": "CodeDescription",
          "value": "Code Description",
          "disabled": true
        },
        {
          "key": "TaxpayerRIN",
          "value": "RIN Of Taxpayer",
          "disabled": true
        },
        {
          "key": "ParentCodeID",
          "value": "4767",
          "disabled": true
        },
        {
          "key": "ParentLevelName",
          "value": "GPC Level 4 Code - Brick"
        },
        {
          "key": "OnlyActive",
          "value": "true"
        },
        {
          "key": "ActiveFrom",
          "value": "2019-01-01T00:00:00Z"
        },
        {
          "key": "ActiveTo",
          "value": "2022-01-01T00:00:00Z",
          "disabled": true
        },
        {
          "key": "Ps",
          "value": "10"
        },
        {
          "key": "Pn",
          "value": "1"
        },
        {
          "key": "OrdDir",
          "value": "Descending"
        },
        {
          "key": "CodeTypeLevelNumber",
          "value": "5"
        }
      ],
      "variable": [
        {
          "key": "codeType",
          "value": "GS1"
        }
      ]
    }
  },
  "response": [
  ]
}