Back to Collection Items
IncludeFile "CkJsonObject.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
queryParams.i = CkJsonObject::ckCreate()
If queryParams.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(queryParams,"FreeText","ut dolore")
CkJsonObject::ckUpdateString(queryParams,"Direction","Submitted")
CkJsonObject::ckUpdateString(queryParams,"DateTimeIssuedFrom","1997-06-27T10:04:59.938Z")
CkJsonObject::ckUpdateString(queryParams,"DateTimeIssuedTo","1997-06-27T10:04:59.938Z")
CkJsonObject::ckUpdateString(queryParams,"DateTimeReceivedFrom","1997-06-27T10:04:59.938Z")
CkJsonObject::ckUpdateString(queryParams,"DateTimeReceivedTo","1997-06-27T10:04:59.938Z")
CkJsonObject::ckUpdateString(queryParams,"DocumentTypeCode","ut dolore")
CkJsonObject::ckUpdateString(queryParams,"DocumentTypeVersion","ut dolore")
CkJsonObject::ckUpdateString(queryParams,"ReceiverName","ut dolore")
CkJsonObject::ckUpdateString(queryParams,"ReceiverRegisterationNumber","ut dolore")
CkJsonObject::ckUpdateString(queryParams,"PosSerialNumber","ut dolore")
CkJsonObject::ckUpdateString(queryParams,"SubmissionChannel","POS")
CkJsonObject::ckUpdateString(queryParams,"SortBy","None")
CkJsonObject::ckUpdateString(queryParams,"SortDir","None")
CkJsonObject::ckUpdateInt(queryParams,"PageNo",63021623)
CkJsonObject::ckUpdateInt(queryParams,"PageSize",63021623)
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://domain.com/api/v1/receipts/search",queryParams)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
ProcedureReturn
EndIf
Debug Str(CkHttpResponse::ckStatusCode(resp))
Debug CkHttpResponse::ckBodyStr(resp)
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
ProcedureReturn
EndProcedure
Curl Command
curl -G -d "FreeText=ut%20dolore"
-d "Direction=Submitted"
-d "DateTimeIssuedFrom=1997-06-27T10%3A04%3A59.938Z"
-d "DateTimeIssuedTo=1997-06-27T10%3A04%3A59.938Z"
-d "DateTimeReceivedFrom=1997-06-27T10%3A04%3A59.938Z"
-d "DateTimeReceivedTo=1997-06-27T10%3A04%3A59.938Z"
-d "DocumentTypeCode=ut%20dolore"
-d "DocumentTypeVersion=ut%20dolore"
-d "ReceiverName=ut%20dolore"
-d "ReceiverRegisterationNumber=ut%20dolore"
-d "PosSerialNumber=ut%20dolore"
-d "SubmissionChannel=POS"
-d "SortBy=None"
-d "SortDir=None"
-d "PageNo=63021623"
-d "PageSize=63021623"
-H "Authorization: Bearer <access_token>"
https://domain.com/api/v1/receipts/search
Postman Collection Item JSON
{
"name": "7. Search Receipts",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{generatedAccessToken}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{apiBaseUrl}}/api/v1/receipts/search?FreeText=ut dolore&Direction=Submitted&DateTimeIssuedFrom=1997-06-27T10:04:59.938Z&DateTimeIssuedTo=1997-06-27T10:04:59.938Z&DateTimeReceivedFrom=1997-06-27T10:04:59.938Z&DateTimeReceivedTo=1997-06-27T10:04:59.938Z&DocumentTypeCode=ut dolore&DocumentTypeVersion=ut dolore&ReceiverName=ut dolore&ReceiverRegisterationNumber=ut dolore&PosSerialNumber=ut dolore&SubmissionChannel=POS&SortBy=None&SortDir=None&PageNo=63021623&PageSize=63021623",
"host": [
"{{apiBaseUrl}}"
],
"path": [
"api",
"v1",
"receipts",
"search"
],
"query": [
{
"key": "FreeText",
"value": "ut dolore"
},
{
"key": "Direction",
"value": "Submitted"
},
{
"key": "DateTimeIssuedFrom",
"value": "1997-06-27T10:04:59.938Z"
},
{
"key": "DateTimeIssuedTo",
"value": "1997-06-27T10:04:59.938Z"
},
{
"key": "DateTimeReceivedFrom",
"value": "1997-06-27T10:04:59.938Z"
},
{
"key": "DateTimeReceivedTo",
"value": "1997-06-27T10:04:59.938Z"
},
{
"key": "DocumentTypeCode",
"value": "ut dolore"
},
{
"key": "DocumentTypeVersion",
"value": "ut dolore"
},
{
"key": "ReceiverName",
"value": "ut dolore"
},
{
"key": "ReceiverRegisterationNumber",
"value": "ut dolore"
},
{
"key": "PosSerialNumber",
"value": "ut dolore"
},
{
"key": "SubmissionChannel",
"value": "POS"
},
{
"key": "SortBy",
"value": "None"
},
{
"key": "SortDir",
"value": "None"
},
{
"key": "PageNo",
"value": "63021623"
},
{
"key": "PageSize",
"value": "63021623"
}
]
}
},
"response": [
]
}