PowerBuilder / Twitter API v2 / Retrieve Rules
Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Id
string ls_Value
string ls_Tag
string ls_Sent
integer i
integer li_Count_i
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
// Adds the "Authorization: Bearer <access_token>" header.
loo_Http.AuthToken = "<access_token>"
loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
li_Success = loo_Http.QuickGetSb("https://api.twitter.com/2/tweets/search/stream/rules",loo_SbResponseBody)
if li_Success = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_SbResponseBody
return
end if
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Http.LastStatus
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Http.LastHeader
Write-Debug "Failed."
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "data": [
// {
// "id": "1273636687768285186",
// "value": "meme has:images"
// },
// {
// "id": "1273636687768285187",
// "value": "puppy has:media",
// "tag": "puppies with media"
// }
// ],
// "meta": {
// "sent": "2020-06-18T15:21:58.638Z"
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
ls_Sent = loo_JResp.StringOf("meta.sent")
i = 0
li_Count_i = loo_JResp.SizeOfArray("data")
do while i < li_Count_i
loo_JResp.I = i
ls_Id = loo_JResp.StringOf("data[i].id")
ls_Value = loo_JResp.StringOf("data[i].value")
ls_Tag = loo_JResp.StringOf("data[i].tag")
i = i + 1
loop
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
https://api.twitter.com/2/tweets/search/stream/rules
Postman Collection Item JSON
{
"name": "Retrieve Rules",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.twitter.com/2/tweets/search/stream/rules",
"protocol": "https",
"host": [
"api",
"twitter",
"com"
],
"path": [
"2",
"tweets",
"search",
"stream",
"rules"
]
},
"description": "Returns a list of filter rules currently active on the streaming endpoint.\n\n[Sign up](https://t.co/signup) for the Twitter API"
},
"response": [
{
"name": "Success 200 - Retrieve Rules",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.twitter.com/2/tweets/search/stream/rules",
"protocol": "https",
"host": [
"api",
"twitter",
"com"
],
"path": [
"2",
"tweets",
"search",
"stream",
"rules"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "content-disposition",
"value": "attachment; filename=json.json"
},
{
"key": "content-encoding",
"value": "gzip"
},
{
"key": "content-length",
"value": "158"
},
{
"key": "content-type",
"value": "application/json; charset=utf-8"
},
{
"key": "date",
"value": "Thu, 18 Jun 2020 15:21:58 GMT"
},
{
"key": "server",
"value": "tsa_b"
},
{
"key": "strict-transport-security",
"value": "max-age=631138519"
},
{
"key": "x-access-level",
"value": "read"
},
{
"key": "x-connection-hash",
"value": "d3ecb7f3763b04c3289e94d8bdbbf298"
},
{
"key": "x-content-type-options",
"value": "nosniff"
},
{
"key": "x-frame-options",
"value": "SAMEORIGIN"
},
{
"key": "x-rate-limit-limit",
"value": "1800"
},
{
"key": "x-rate-limit-remaining",
"value": "1799"
},
{
"key": "x-rate-limit-reset",
"value": "1592494618"
},
{
"key": "x-response-time",
"value": "276"
},
{
"key": "x-xss-protection",
"value": "0"
}
],
"cookie": [
],
"body": "{\n \"data\": [\n {\n \"id\": \"1273636687768285186\",\n \"value\": \"meme has:images\"\n },\n {\n \"id\": \"1273636687768285187\",\n \"value\": \"puppy has:media\",\n \"tag\": \"puppies with media\"\n }\n ],\n \"meta\": {\n \"sent\": \"2020-06-18T15:21:58.638Z\"\n }\n}"
},
{
"name": "403 Forbidden - Client Not Enrolled",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.twitter.com/2/tweets/search/stream/rules",
"protocol": "https",
"host": [
"api",
"twitter",
"com"
],
"path": [
"2",
"tweets",
"search",
"stream",
"rules"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "content-disposition",
"value": "attachment; filename=json.json"
},
{
"key": "content-encoding",
"value": "gzip"
},
{
"key": "content-length",
"value": "275"
},
{
"key": "content-type",
"value": "application/json; charset=utf-8"
},
{
"key": "date",
"value": "Thu, 18 Jun 2020 15:25:53 GMT"
},
{
"key": "server",
"value": "tsa_b"
},
{
"key": "strict-transport-security",
"value": "max-age=631138519"
},
{
"key": "x-access-level",
"value": "read"
},
{
"key": "x-connection-hash",
"value": "d3ecb7f3763b04c3289e94d8bdbbf298"
},
{
"key": "x-content-type-options",
"value": "nosniff"
},
{
"key": "x-frame-options",
"value": "SAMEORIGIN"
},
{
"key": "x-response-time",
"value": "300"
},
{
"key": "x-xss-protection",
"value": "0"
}
],
"cookie": [
],
"body": "{\n \"client_id\": \"16340226\",\n \"required_enrollment\": \"Standard Basic\",\n \"registration_url\": \"https://developer.twitter.com/en/account\",\n \"title\": \"Client Forbidden\",\n \"detail\": \"This request must be made using an approved developer account that is enrolled in the requested endpoint. Learn more by visiting our documentation.\",\n \"reason\": \"client-not-enrolled\",\n \"type\": \"https://api.twitter.com/2/problems/client-forbidden\"\n}"
},
{
"name": "401 Unauthorized",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.twitter.com/2/tweets/search/stream/rules",
"protocol": "https",
"host": [
"api",
"twitter",
"com"
],
"path": [
"2",
"tweets",
"search",
"stream",
"rules"
]
}
},
"status": "Authorization Required",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "content-disposition",
"value": "attachment; filename=json.json"
},
{
"key": "content-encoding",
"value": "gzip"
},
{
"key": "content-length",
"value": "91"
},
{
"key": "content-type",
"value": "application/json; charset=utf-8"
},
{
"key": "date",
"value": "Thu, 18 Jun 2020 15:25:01 GMT"
},
{
"key": "server",
"value": "tsa_b"
},
{
"key": "strict-transport-security",
"value": "max-age=631138519"
},
{
"key": "x-connection-hash",
"value": "d3ecb7f3763b04c3289e94d8bdbbf298"
},
{
"key": "x-content-type-options",
"value": "nosniff"
},
{
"key": "x-frame-options",
"value": "SAMEORIGIN"
},
{
"key": "x-response-time",
"value": "265"
},
{
"key": "x-xss-protection",
"value": "0"
}
],
"cookie": [
],
"body": "{\n \"title\": \"Unauthorized\",\n \"type\": \"about:blank\",\n \"status\": 401,\n \"detail\": \"Unauthorized\"\n}"
}
]
}
