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
$oQueryParams = ObjCreate("Chilkat.JsonObject")
$oQueryParams.UpdateString("dateFrom","{dateFrom}")
$oQueryParams.UpdateString("dateTo","{dateTo}")
$oQueryParams.UpdateString("type","{type}")
$oQueryParams.UpdateString("language","{language}")
$oQueryParams.UpdateString("status","{status}")
$oQueryParams.UpdateString("channel","{channel}")
$oQueryParams.UpdateString("pageNo","{pageNo}")
$oQueryParams.UpdateString("pageSize","{pageSize}")
; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"
Local $oResp = $oHttp.QuickRequestParams("GET","https://{apiBaseUrl}/api/v1.0/notifications/taxpayer",$oQueryParams)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
ConsoleWrite($oResp.StatusCode & @CRLF)
ConsoleWrite($oResp.BodyStr & @CRLF)
Curl Command
curl -G -d "dateFrom=%7BdateFrom%7D"
-d "dateTo=%7BdateTo%7D"
-d "type=%7Btype%7D"
-d "language=%7Blanguage%7D"
-d "status=%7Bstatus%7D"
-d "channel=%7Bchannel%7D"
-d "pageNo=%7BpageNo%7D"
-d "pageSize=%7BpageSize%7D"
-H "Authorization: Bearer <access_token>"
https://{apiBaseUrl}/api/v1.0/notifications/taxpayer
Postman Collection Item JSON
{
"name": "Get Notifications",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{generatedAccessToken}",
"type": "string"
}
]
},
"method": "GET",
"header": [
],
"url": {
"raw": "{apiBaseUrl}/api/v1.0/notifications/taxpayer?dateFrom={dateFrom}&dateTo={dateTo}&type={type}&language={language}&status={status}&channel={channel}&pageNo={pageNo}&pageSize={pageSize}",
"host": [
"{apiBaseUrl}"
],
"path": [
"api",
"v1.0",
"notifications",
"taxpayer"
],
"query": [
{
"key": "dateFrom",
"value": "{dateFrom}",
"description": "Optional: start date and time for notifications to retrieve based on the date sent\n"
},
{
"key": "dateTo",
"value": "{dateTo}",
"description": "Optional: end date and time for notifications to retrieve based on the date sent\n"
},
{
"key": "type",
"value": "{type}",
"description": "Optional: type of notifications to retrieve specified as ID of the type. (Notification types to be discussed later)\n"
},
{
"key": "language",
"value": "{language}",
"description": "Optional: used to get notifications only if they were sent out in a specific language. Values: ms and en\n"
},
{
"key": "status",
"value": "{status}",
"description": "Optional: used to get notifications of certain status only, e.g., only those that were not delivered. Values: pending, batched, delivered, error\n"
},
{
"key": "channel",
"value": "{channel}",
"description": "Optional: used to get notifications delivered over certain channel only. Values: email, push\n"
},
{
"key": "pageNo",
"value": "{pageNo}",
"description": "Optional: number of the page to retrieve. Typically this parameter value is derived from initial parameter less call when caller learns total amount of page of certain size\n"
},
{
"key": "pageSize",
"value": "{pageSize}",
"description": "Optional: number of the packages to retrieve per page. Page size cannot exceed system configured maximum page size for this API\n"
}
]
}
},
"response": [
]
}