Objective-C / Squadcast API V3 / Get Service By ID
Back to Collection Items
#import <CkoHttp.h>
#import <CkoStringBuilder.h>
#import <CkoJsonObject.h>
#import <NSString.h>
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;
[http SetRequestHeader: @"Authorization" value: @""];
CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
success = [http QuickGetSb: @"https://api.squadcast.com/v3/services/:serviceID" sbContent: sbResponseBody];
if (success == NO) {
NSLog(@"%@",http.LastErrorText);
return;
}
CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;
NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);
int respStatusCode = [http.LastStatus intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
NSLog(@"%@",@"Response Header:");
NSLog(@"%@",http.LastHeader);
NSLog(@"%@",@"Failed.");
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "data": {
// "id": "5e8edb24668e003cb0b18ba1",
// "name": "Payment API Service",
// "slug": "payment-api-service",
// "email": "unique_string@gopherhut.incidents.squadcast.com",
// "escalation_policy_id": "5d81d9407000fb6b9def7e33",
// "organization_id": "5d81d9187000fb6b9def7e32",
// "api_key": "2f81ac8b2362990dd220f8bb4f7cd30ccc3dac43",
// "description": "Payment API Service monitor",
// "depends": null,
// "escalation_policy": {
// "id": "5d81d9407000fb6b9def7e33",
// "name": "Example Escalation Policy",
// "description": "On-Boarding Example",
// "slug": "example-escalation-policy"
// }
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
NSString *Id = [jResp StringOf: @"data.id"];
NSString *Name = [jResp StringOf: @"data.name"];
NSString *Slug = [jResp StringOf: @"data.slug"];
NSString *v_Email = [jResp StringOf: @"data.email"];
NSString *Escalation_policy_id = [jResp StringOf: @"data.escalation_policy_id"];
NSString *Organization_id = [jResp StringOf: @"data.organization_id"];
NSString *Api_key = [jResp StringOf: @"data.api_key"];
NSString *Description = [jResp StringOf: @"data.description"];
NSString *Depends = [jResp StringOf: @"data.depends"];
NSString *Escalation_policyId = [jResp StringOf: @"data.escalation_policy.id"];
NSString *Escalation_policyName = [jResp StringOf: @"data.escalation_policy.name"];
NSString *Escalation_policyDescription = [jResp StringOf: @"data.escalation_policy.description"];
NSString *Escalation_policySlug = [jResp StringOf: @"data.escalation_policy.slug"];
Curl Command
curl -X GET
-H "Authorization: "
https://api.squadcast.com/v3/services/:serviceID
Postman Collection Item JSON
{
"name": "Get Service By ID",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Authorization",
"value": ""
}
],
"url": {
"raw": "{{baseUrl}}/services/:serviceID",
"host": [
"{{baseUrl}}"
],
"path": [
"services",
":serviceID"
],
"variable": [
{
"key": "serviceID",
"value": "<string>",
"type": "string",
"description": "(Required) service id"
}
]
},
"description": "Returns a service details of the given `serviceID` in the request param.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `read` scope."
},
"response": [
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/services/:serviceID",
"host": [
"{{baseUrl}}"
],
"path": [
"services",
":serviceID"
],
"variable": [
{
"key": "serviceID"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"meta\": {\n \"status\": \"<integer>\",\n \"error_message\": \"<string>\"\n }\n}"
},
{
"name": "Internal Server Error",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/services/:serviceID",
"host": [
"{{baseUrl}}"
],
"path": [
"services",
":serviceID"
],
"variable": [
{
"key": "serviceID"
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"meta\": {\n \"status\": \"<integer>\",\n \"error_message\": \"<string>\"\n }\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/services/:serviceID",
"host": [
"{{baseUrl}}"
],
"path": [
"services",
":serviceID"
],
"variable": [
{
"key": "serviceID"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"meta\": {\n \"status\": \"<integer>\",\n \"error_message\": \"<string>\"\n }\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/services/:serviceID",
"host": [
"{{baseUrl}}"
],
"path": [
"services",
":serviceID"
],
"variable": [
{
"key": "serviceID"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"meta\": {\n \"status\": \"<integer>\",\n \"error_message\": \"<string>\"\n }\n}"
},
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/services/:serviceID",
"host": [
"{{baseUrl}}"
],
"path": [
"services",
":serviceID"
],
"variable": [
{
"key": "serviceID"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\n \"id\": \"5e8edb24668e003cb0b18ba1\",\n \"name\": \"Payment API Service\",\n \"slug\": \"payment-api-service\",\n \"email\": \"unique_string@gopherhut.incidents.squadcast.com\",\n \"escalation_policy_id\": \"5d81d9407000fb6b9def7e33\",\n \"organization_id\": \"5d81d9187000fb6b9def7e32\",\n \"api_key\": \"2f81ac8b2362990dd220f8bb4f7cd30ccc3dac43\",\n \"description\": \"Payment API Service monitor\",\n \"depends\": null,\n \"escalation_policy\": {\n \"id\": \"5d81d9407000fb6b9def7e33\",\n \"name\": \"Example Escalation Policy\",\n \"description\": \"On-Boarding Example\",\n \"slug\": \"example-escalation-policy\"\n }\n }\n}"
}
]
}