Download OpenAPI specification:
REST API for Octopus Online
| settings | boolean Default: false Include settings in each Compactor object. |
| details | boolean Default: false Include scheduled service moments and some extra metadata in each Compactor object. |
{- "compactors": [
- {
- "id": "boopmsr9ehkil187bpgg",
- "name": "Test Compactor",
- "feature_flags": 63,
- "timestamp": 1584093661,
- "status_flags": 9,
- "percentage": 51.234,
- "address": {
- "company": "De Rooij",
- "street": "Enterseweg 9",
- "postal_code": "7471 SB",
- "city": "Goor",
- "country_code": "NL",
- "dock_number": 12
}, - "fraction": {
- "name": "Rest Afval"
}
}
]
}| id required | string ID of the Compactor |
{- "compactor": {
- "id": "boopmsr9ehkil187bpgg",
- "name": "Test Compactor",
- "feature_flags": 63,
- "timestamp": 1584093661,
- "status_flags": 9,
- "percentage": 51.234,
- "metadata": {
- "description": "This is a Test Compactor with a description.",
- "serial_number": "1001",
- "manufacturer": "Manufacturer",
- "model": "Model",
- "volume": 100
}, - "address": {
- "company": "De Rooij",
- "street": "Enterseweg 9",
- "postal_code": "7471 SB",
- "city": "Goor",
- "country_code": "NL",
- "dock_number": 12
}, - "customer": {
- "name": "Some Customer",
- "contract_number": "1000",
- "address": {
- "street": "De Dam 1",
- "postal_code": "1200 AB",
- "city": "Amsterdam",
- "country_code": "NL"
}
}, - "fraction": {
- "name": "Rest Afval",
- "type": "rest"
}
}
}| id required | string ID of the Compactor |
| start_at | integer <int64> Example: start_at=1593554400 Retrieves only Fills since the given Unix Timestamp. When set to -1 the response will be a logical system-decided range consisting of max 4 sessions or 28 days. When no query parameters are set the response will be Fills of the last 28 days (2419200 seconds). |
| end_at | integer <int64> Example: end_at=1593554400 Retrieves only Fills up to the given Unix Timestamp.
When not set, all Fills up to the current time are selected, limited by |
| sanitize | boolean Example: sanitize=true When Sanitize is true we receive fills capped, when false we receive them uncapped (default) |
| extensive | boolean Example: extensive=true When extensive is true the response also includes the number of cycles and a number based on pressure, if present |
| limit | integer Only receive a maximum of |
{- "fills": [
- {
- "timestamp": 1582038898,
- "percentage": 44.68998702295866,
- "cycles": 129,
- "pressure": 43.23459823590295
}
]
}| id required | string ID of the Compactor |
| start_at | integer <int64> Example: start_at=1593554400 Retrieves only Events since the given Unix Timestamp |
| end_at | integer <int64> Example: end_at=1593554400 Retrieves only Events up to the given Unix Timestamp |
| limit | integer Only receive a maximum of |
{- "events": [
- {
- "timestamp": 1582038898,
- "event": "HitchOn"
}
]
}| id required | string ID of the Compactor |
| start_at | integer <int64> Example: start_at=1593554400 Retrieves only Sessions since the given Unix Timestamp |
| limit | integer Only receive a maximum of |
| sanitize | boolean Maximize percentages, only show 100% when full |
{- "sessions": [
- {
- "id": 0,
- "created_at": 1582038698,
- "completed_at": 1582038898,
- "cycles": 471,
- "percentage": 98.2948321880212,
- "mass_estimate": 25,
- "mass_corrected": 28
}
]
}| id required | string ID of the Compactor |
| session_id | integer <int64> ID of the session for this measurement |
| mass_corrected | number Manually corrected mass in kilos |
{- "session_id": 0,
- "mass_corrected": 44
}{- "error": "string"
}| id required | string ID of the Compactor |
{- "actions": [
- {
- "id": 297,
- "type": "EMAIL",
- "recipients": [
- {
- "address": "bob@example.org",
- "name": "Bob"
}, - {
- "address": "maintenance@example.org"
}
], - "events": [
- "EMERGENCY",
- "HITCH"
]
}
]
}| id required | string ID of the Compactor |
object (AlarmActionCompactor) |
{- "action": {
- "type": "EMAIL",
- "recipients": [
- {
- "address": "alice@example.org",
- "name": "Alice"
}, - {
- "address": "bob@example.org",
- "name": "Bob"
}
], - "events": [
- "FULL"
], - "template_id": "56"
}
}{- "error": "string"
}| id required | string ID of the Compactor |
| alarm_id required | string ID of the Alarm |
{- "action": {
- "id": 297,
- "type": "EMAIL",
- "recipients": [
- {
- "address": "bob@example.org",
- "name": "Bob"
}, - {
- "address": "maintenance@example.org"
}
], - "events": [
- "EMERGENCY",
- "HITCH"
]
}
}| id required | string ID of the Compactor |
| alarm_id required | string ID of the Alarm |
object (AlarmActionCompactor) |
{- "action": {
- "id": 297,
- "type": "EMAIL",
- "recipients": [
- {
- "address": "bob@example.org",
- "name": "Bob"
}, - {
- "address": "maintenance@example.org"
}
], - "events": [
- "EMERGENCY",
- "HITCH"
]
}
}{- "error": "string"
}| id required | string ID of the Compactor |
object (CompactorSettings) Settings for a Compactor |
{- "settings": {
- "almostfull_threshold": 90,
- "fraction_name": "Restafval",
- "fraction_type": "rest"
}
}{- "error": "string"
}| id required | string ID of the Compactor |
object (Customer) A customer with an optional address |
{- "customer": {
- "name": "Jan Raas",
- "contract_number": "string",
- "address": {
- "street": "Enterseweg 9",
- "additional": "string",
- "city": "Goor",
- "postal_code": "7500 AD",
- "country_code": "NL",
- "dock_number": 2,
- "company": "Elfii"
}
}
}{- "error": "string"
}| id required | string ID of the Compactor |
object (Location) An address of a location |
{- "address": {
- "street": "Enterseweg 9",
- "additional": "string",
- "city": "Goor",
- "postal_code": "7500 AD",
- "country_code": "NL",
- "dock_number": 2,
- "company": "Elfii"
}
}{- "error": "string"
}| id required | string ID of the Compactor |
| name | string Name of the Compactor object, defined by the user |
{- "name": "Testcompactor"
}{- "error": "string"
}