Simplifa API API Reference

Elevator REST API

API Endpoint
http://api.simplifa.de
Contact: [email protected]
Version: 1.0.0

Paths

View a list of elevators

GET /elevator/all
200 OK

OK

type
object[]
401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: application/json
Response Example (200 OK)
[
  "object"
]

View a single elevator

GET /elevator/id/{id}
id: integer (int64)
in path

id

200 OK

OK

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: application/json
Response Example (200 OK)
{
  "address": {
    "city": "string",
    "street": "string",
    "streetNumber": "string",
    "zipCode": "string"
  },
  "amCompany": "string",
  "attendantContact": {
    "email": "string",
    "firstName": "string",
    "lastName": "string",
    "mobile": "string",
    "phone": "string"
  },
  "driveType": "string",
  "elevatorType": "string",
  "emergencyPlanFrom": "string",
  "emergencyRescuePlanFrom": "string",
  "factoryId": "string",
  "fmCompany": "string",
  "fmContact": {
    "email": "string",
    "firstName": "string",
    "lastName": "string",
    "mobile": "string",
    "phone": "string"
  },
  "gbuRiskScore": "string",
  "housekeeperContact": "string",
  "id": "integer (int32)",
  "lastGbu": "string",
  "locationMachineRoom": "string",
  "manufactureYear": "string",
  "manufacturer": "string",
  "modernizationDate": "string",
  "outOfOrderSince": "string",
  "payloadMax": "string",
  "pmCompany": "string",
  "pmContact": {
    "email": "string",
    "firstName": "string",
    "lastName": "string",
    "mobile": "string",
    "phone": "string"
  },
  "ropeRatio": "string",
  "serviceProvider": "string",
  "serviceProviderContact": {
    "email": "string",
    "firstName": "string",
    "lastName": "string",
    "mobile": "string",
    "phone": "string"
  },
  "speed": "string",
  "statusReportFrom": "string",
  "stops": "string",
  "travelHeight": "string"
}

Schema Definitions

Address: object

city: string
street: string
streetNumber: string
zipCode: string
Example
{
  "city": "string",
  "street": "string",
  "streetNumber": "string",
  "zipCode": "string"
}

Contact: object

email: string
firstName: string
lastName: string
mobile: string
phone: string
Example
{
  "email": "string",
  "firstName": "string",
  "lastName": "string",
  "mobile": "string",
  "phone": "string"
}

Elevator: object

address: Address
amCompany: string
attendantContact: Contact
driveType: string
elevatorType: string
emergencyPlanFrom: string
emergencyRescuePlanFrom: string
factoryId: string
fmCompany: string
fmContact: Contact
gbuRiskScore: string
housekeeperContact: string
id: integer (int32)
lastGbu: string
locationMachineRoom: string
manufactureYear: string
manufacturer: string
modernizationDate: string
outOfOrderSince: string
payloadMax: string
pmCompany: string
pmContact: Contact
ropeRatio: string
serviceProvider: string
serviceProviderContact: Contact
speed: string
statusReportFrom: string
stops: string
travelHeight: string
Example
{
  "address": {
    "city": "string",
    "street": "string",
    "streetNumber": "string",
    "zipCode": "string"
  },
  "amCompany": "string",
  "attendantContact": {
    "email": "string",
    "firstName": "string",
    "lastName": "string",
    "mobile": "string",
    "phone": "string"
  },
  "driveType": "string",
  "elevatorType": "string",
  "emergencyPlanFrom": "string",
  "emergencyRescuePlanFrom": "string",
  "factoryId": "string",
  "fmCompany": "string",
  "fmContact": {
    "email": "string",
    "firstName": "string",
    "lastName": "string",
    "mobile": "string",
    "phone": "string"
  },
  "gbuRiskScore": "string",
  "housekeeperContact": "string",
  "id": "integer (int32)",
  "lastGbu": "string",
  "locationMachineRoom": "string",
  "manufactureYear": "string",
  "manufacturer": "string",
  "modernizationDate": "string",
  "outOfOrderSince": "string",
  "payloadMax": "string",
  "pmCompany": "string",
  "pmContact": {
    "email": "string",
    "firstName": "string",
    "lastName": "string",
    "mobile": "string",
    "phone": "string"
  },
  "ropeRatio": "string",
  "serviceProvider": "string",
  "serviceProviderContact": {
    "email": "string",
    "firstName": "string",
    "lastName": "string",
    "mobile": "string",
    "phone": "string"
  },
  "speed": "string",
  "statusReportFrom": "string",
  "stops": "string",
  "travelHeight": "string"
}