Objective-C / easybill REST API / Fetch a list of serial numbers for positions
Back to Collection Items
#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.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;
CkoJsonObject *queryParams = [[CkoJsonObject alloc] init];
[queryParams UpdateString: @"limit" value: @"<integer>"];
[queryParams UpdateString: @"page" value: @"<integer>"];
[queryParams UpdateString: @"position_id" value: @"<string>"];
[queryParams UpdateString: @"document_id" value: @"<string>"];
[queryParams UpdateString: @"in_use" value: @"<boolean>"];
[http SetRequestHeader: @"Authorization" value: @"{{apiKey}}"];
[http SetRequestHeader: @"Accept" value: @"application/json"];
CkoHttpResponse *resp = [http QuickRequestParams: @"GET" url: @"https://api.easybill.de/rest/v1/serial-numbers" json: queryParams];
if (http.LastMethodSuccess == NO) {
NSLog(@"%@",http.LastErrorText);
return;
}
CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];
CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;
NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);
int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
NSLog(@"%@",@"Response Header:");
NSLog(@"%@",resp.Header);
NSLog(@"%@",@"Failed.");
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "page": "<integer>",
// "pages": "<integer>",
// "limit": "<integer>",
// "total": "<integer>",
// "items": [
// {
// "serial_number": "<string>",
// "position_id": "<integer>",
// "id": "<long>",
// "document_id": "<long>",
// "document_position_id": "<long>",
// "used_at": "<string>",
// "created_at": "<string>"
// },
// {
// "serial_number": "<string>",
// "position_id": "<integer>",
// "id": "<long>",
// "document_id": "<long>",
// "document_position_id": "<long>",
// "used_at": "<string>",
// "created_at": "<string>"
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
NSString *serial_number = 0;
NSString *position_id = 0;
NSString *id = 0;
NSString *document_id = 0;
NSString *document_position_id = 0;
NSString *used_at = 0;
NSString *created_at = 0;
NSString *page = [jResp StringOf: @"page"];
NSString *pages = [jResp StringOf: @"pages"];
NSString *limit = [jResp StringOf: @"limit"];
NSString *total = [jResp StringOf: @"total"];
int i = 0;
int count_i = [[jResp SizeOfArray: @"items"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: i];
serial_number = [jResp StringOf: @"items[i].serial_number"];
position_id = [jResp StringOf: @"items[i].position_id"];
id = [jResp StringOf: @"items[i].id"];
document_id = [jResp StringOf: @"items[i].document_id"];
document_position_id = [jResp StringOf: @"items[i].document_position_id"];
used_at = [jResp StringOf: @"items[i].used_at"];
created_at = [jResp StringOf: @"items[i].created_at"];
i = i + 1;
}
Curl Command
curl -G -d "limit=%3Cinteger%3E"
-d "page=%3Cinteger%3E"
-d "position_id=%3Cstring%3E"
-d "document_id=%3Cstring%3E"
-d "in_use=%3Cboolean%3E"
-H "Authorization: {{apiKey}}"
-H "Accept: application/json"
https://api.easybill.de/rest/v1/serial-numbers
Postman Collection Item JSON
{
"name": "Fetch a list of serial numbers for positions",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/serial-numbers?limit=<integer>&page=<integer>&position_id=<string>&document_id=<string>&in_use=<boolean>",
"host": [
"{{baseUrl}}"
],
"path": [
"serial-numbers"
],
"query": [
{
"key": "limit",
"value": "<integer>",
"description": "Limited the result. Default is 100. Maximum can be 1000."
},
{
"key": "page",
"value": "<integer>",
"description": "Set current Page. Default is 1."
},
{
"key": "position_id",
"value": "<string>",
"description": "Filter serial numbers by position id."
},
{
"key": "document_id",
"value": "<string>",
"description": "Filter serial numbers by document id."
},
{
"key": "in_use",
"value": "<boolean>",
"description": "Filter serial numbers by usage."
}
]
}
},
"response": [
{
"name": "Successful operation",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "Authorization",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/serial-numbers?limit=<integer>&page=<integer>&position_id=<string>&document_id=<string>&in_use=<boolean>",
"host": [
"{{baseUrl}}"
],
"path": [
"serial-numbers"
],
"query": [
{
"key": "limit",
"value": "<integer>",
"description": "Limited the result. Default is 100. Maximum can be 1000."
},
{
"key": "page",
"value": "<integer>",
"description": "Set current Page. Default is 1."
},
{
"key": "position_id",
"value": "<string>",
"description": "Filter serial numbers by position id."
},
{
"key": "document_id",
"value": "<string>",
"description": "Filter serial numbers by document id."
},
{
"key": "in_use",
"value": "<boolean>",
"description": "Filter serial numbers by usage."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"page\": \"<integer>\",\n \"pages\": \"<integer>\",\n \"limit\": \"<integer>\",\n \"total\": \"<integer>\",\n \"items\": [\n {\n \"serial_number\": \"<string>\",\n \"position_id\": \"<integer>\",\n \"id\": \"<long>\",\n \"document_id\": \"<long>\",\n \"document_position_id\": \"<long>\",\n \"used_at\": \"<string>\",\n \"created_at\": \"<string>\"\n },\n {\n \"serial_number\": \"<string>\",\n \"position_id\": \"<integer>\",\n \"id\": \"<long>\",\n \"document_id\": \"<long>\",\n \"document_position_id\": \"<long>\",\n \"used_at\": \"<string>\",\n \"created_at\": \"<string>\"\n }\n ]\n}"
},
{
"name": "Too Many Requests",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: apikey",
"key": "Authorization",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/serial-numbers?limit=<integer>&page=<integer>&position_id=<string>&document_id=<string>&in_use=<boolean>",
"host": [
"{{baseUrl}}"
],
"path": [
"serial-numbers"
],
"query": [
{
"key": "limit",
"value": "<integer>",
"description": "Limited the result. Default is 100. Maximum can be 1000."
},
{
"key": "page",
"value": "<integer>",
"description": "Set current Page. Default is 1."
},
{
"key": "position_id",
"value": "<string>",
"description": "Filter serial numbers by position id."
},
{
"key": "document_id",
"value": "<string>",
"description": "Filter serial numbers by document id."
},
{
"key": "in_use",
"value": "<boolean>",
"description": "Filter serial numbers by usage."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
}
]
}
