Swift3 / easybill REST API / Fetch a list of serial numbers for positions
Back to Collection Items
func chilkatTest() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
let http = CkoHttp()!
var success: Bool
let queryParams = CkoJsonObject()!
queryParams.update("limit", value: "<integer>")
queryParams.update("page", value: "<integer>")
queryParams.update("position_id", value: "<string>")
queryParams.update("document_id", value: "<string>")
queryParams.update("in_use", value: "<boolean>")
http.setRequestHeader("Authorization", value: "{{apiKey}}")
http.setRequestHeader("Accept", value: "application/json")
var resp: CkoHttpResponse? = http.quickRequestParams("GET", url: "https://api.easybill.de/rest/v1/serial-numbers", json: queryParams)
if http.lastMethodSuccess == false {
print("\(http.lastErrorText!)")
return
}
let sbResponseBody = CkoStringBuilder()!
resp!.getBodySb(sbResponseBody)
let jResp = CkoJsonObject()!
jResp.loadSb(sbResponseBody)
jResp.emitCompact = false
print("Response Body:")
print("\(jResp.emit()!)")
var respStatusCode: Int = resp!.statusCode.intValue
print("Response Status Code = \(respStatusCode)")
if respStatusCode >= 400 {
print("Response Header:")
print("\(resp!.header!)")
print("Failed.")
resp = nil
return
}
resp = nil
// 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
var serial_number: String?
var position_id: String?
var id: String?
var document_id: String?
var document_position_id: String?
var used_at: String?
var created_at: String?
var page: String? = jResp.string(of: "page")
var pages: String? = jResp.string(of: "pages")
var limit: String? = jResp.string(of: "limit")
var total: String? = jResp.string(of: "total")
var i: Int = 0
var count_i: Int = jResp.size(ofArray: "items").intValue
while i < count_i {
jResp.i = i
serial_number = jResp.string(of: "items[i].serial_number")
position_id = jResp.string(of: "items[i].position_id")
id = jResp.string(of: "items[i].id")
document_id = jResp.string(of: "items[i].document_id")
document_position_id = jResp.string(of: "items[i].document_position_id")
used_at = jResp.string(of: "items[i].used_at")
created_at = jResp.string(of: "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": ""
}
]
}
