API docs by Redocly

autarc 2.0 API (0.0.1)

Download OpenAPI specification:

License: proprietary

Projects

Creates a project

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
name
required
string
companyId
required
string <uuid>
customerId
string or null <uuid>
status
string (ProjectStatus)
Enum: "inProgress" "completed" "archived"

The status of the project. Must be set manually.

isLead
boolean or null
Default: false

Determines if the project is a lead project

humanId
string or null

Human readable identifier. E.g. "P-001"

projectValue
number or null <float>

The value of the project. E.g. 10.000EUR

installationDate
string or null <date>
buildingType
string or null (BuildingType)
Enum: "singleOrDoubleFamilyHouse" "semiDetachedHouse" "terracedHouse" "endTerracedHouse" "multiFamilyHouse" "commercialBuilding"
buildingAge
string or null (BuildingAge)
Enum: "from2002" "from1995To2001" "from1984To1994" "from1979To1983" "from1969To1978" "from1958To1968" "from1949To1957" "from1919To1948" "before1918"
isMonumentProtected
any
Default: false

Determines if the building is monument protected

numberOfResidents
number or null

The number of residents in the building

numberOfFloors
number or null

The number of floors in the building

heatedLivingAreaM2
number or null

The heated living area in square meters. Used in the heat pump check. This is an independent value and not the total sum of room areas.

currentHeatingSystemType
string (OldHeatingSystemType)
Enum: "gas" "oil" "condensingGas" "condensingOil" "pellet" "districtOrOther"
currentHeatingSystemConstructionYear
string (OldHeatingSystemConstructionYear)
Enum: "before1980" "between1980And1995" "after1995"
drinkingWaterHeatingSystemType
string (DrinkingWaterHeatingSystemType)
Enum: "withCirculation" "withoutCirculation"
Array of objects (HeatingCircuit)
technicalFeasibilityAssesment
string (AssessTechnicalFeasibilityType)
Enum: "feasible" "notFeasible"

The outcome of the technical feasibility assessment. If the assessment has not been completed yet, the value will be notStarted.

object (Address)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "status": "inProgress",
  • "isLead": false,
  • "humanId": "string",
  • "projectValue": 0,
  • "installationDate": "2019-08-24",
  • "buildingType": "singleOrDoubleFamilyHouse",
  • "buildingAge": "from2002",
  • "isMonumentProtected": false,
  • "numberOfResidents": 0,
  • "numberOfFloors": 0,
  • "heatedLivingAreaM2": 0,
  • "currentHeatingSystemType": "gas",
  • "currentHeatingSystemConstructionYear": "before1980",
  • "drinkingWaterHeatingSystemType": "withCirculation",
  • "heatingCircuits": [
    ],
  • "technicalFeasibilityAssesment": "feasible",
  • "address": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "status": "inProgress",
  • "isLead": false,
  • "humanId": "string",
  • "projectValue": 0,
  • "installationDate": "2019-08-24",
  • "buildingType": "singleOrDoubleFamilyHouse",
  • "buildingAge": "from2002",
  • "isMonumentProtected": false,
  • "numberOfResidents": 0,
  • "numberOfFloors": 0,
  • "heatedLivingAreaM2": 0,
  • "currentHeatingSystemType": "gas",
  • "currentHeatingSystemConstructionYear": "before1980",
  • "drinkingWaterHeatingSystemType": "withCirculation",
  • "heatingCircuits": [
    ],
  • "technicalFeasibilityAssesment": "feasible",
  • "address": {
    }
}

Gets all projects

Returns a list of projects that match the provided filter criteria

Authorizations:
apiKeyAuth
query Parameters
status
string (ProjectStatus)
Enum: "inProgress" "completed" "archived"
Example: status=inProgress
customerId
string or null <uuid>
Example: customerId=a52a94e4-bd5f-4e4c-bd1c-269cb5d49cb4
technicalFeasibilityAssesment
string (AssessTechnicalFeasibilityType)
Enum: "feasible" "notFeasible"
Example: technicalFeasibilityAssesment=feasible
isLead
boolean
Example: isLead=false
sortBy
string
Enum: "created_at" "status" "customer_id"
Example: sortBy=created_at
limit
integer
Example: limit=20

Maximum number of projects returned per page. The maximum allowed is 100 and the minimum is 1. Defaults to 100.

order
string
Enum: "asc" "desc"
Example: order=asc
nextCursor
string
Example: nextCursor=f47ac10b-58cc-4372-a567-0e02b2c3d479

A cursor for fetching the next page of results. A null value indicates that there is no more data.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Get project by id

Authorizations:
apiKeyAuth
path Parameters
projectId
required
string

ID of the project to fetch

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "status": "inProgress",
  • "isLead": false,
  • "humanId": "string",
  • "projectValue": 0,
  • "installationDate": "2019-08-24",
  • "buildingType": "singleOrDoubleFamilyHouse",
  • "buildingAge": "from2002",
  • "isMonumentProtected": false,
  • "numberOfResidents": 0,
  • "numberOfFloors": 0,
  • "heatedLivingAreaM2": 0,
  • "currentHeatingSystemType": "gas",
  • "currentHeatingSystemConstructionYear": "before1980",
  • "drinkingWaterHeatingSystemType": "withCirculation",
  • "heatingCircuits": [
    ],
  • "technicalFeasibilityAssesment": "feasible",
  • "address": {
    }
}

Update a project

You only need to provide the fields you want to update.

Authorizations:
apiKeyAuth
path Parameters
projectId
required
string
Request Body schema: application/json
required
name
string
companyId
string <uuid>
customerId
string or null <uuid>
status
string (ProjectStatus)
Enum: "inProgress" "completed" "archived"

The status of the project. Must be set manually.

isLead
boolean or null
Default: false

Determines if the project is a lead project

humanId
string or null

Human readable identifier. E.g. "P-001"

projectValue
number or null <float>

The value of the project. E.g. 10.000EUR

installationDate
string or null <date>
buildingType
string or null (BuildingType)
Enum: "singleOrDoubleFamilyHouse" "semiDetachedHouse" "terracedHouse" "endTerracedHouse" "multiFamilyHouse" "commercialBuilding"
buildingAge
string or null (BuildingAge)
Enum: "from2002" "from1995To2001" "from1984To1994" "from1979To1983" "from1969To1978" "from1958To1968" "from1949To1957" "from1919To1948" "before1918"
isMonumentProtected
any
Default: false

Determines if the building is monument protected

numberOfResidents
number or null

The number of residents in the building

numberOfFloors
number or null

The number of floors in the building

heatedLivingAreaM2
number or null

The heated living area in square meters. Used in the heat pump check. This is an independent value and not the total sum of room areas.

currentHeatingSystemType
string (OldHeatingSystemType)
Enum: "gas" "oil" "condensingGas" "condensingOil" "pellet" "districtOrOther"
currentHeatingSystemConstructionYear
string (OldHeatingSystemConstructionYear)
Enum: "before1980" "between1980And1995" "after1995"
drinkingWaterHeatingSystemType
string (DrinkingWaterHeatingSystemType)
Enum: "withCirculation" "withoutCirculation"
Array of objects (HeatingCircuit)
technicalFeasibilityAssesment
string (AssessTechnicalFeasibilityType)
Enum: "feasible" "notFeasible"

The outcome of the technical feasibility assessment. If the assessment has not been completed yet, the value will be notStarted.

object (Address)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "status": "inProgress",
  • "isLead": false,
  • "humanId": "string",
  • "projectValue": 0,
  • "installationDate": "2019-08-24",
  • "buildingType": "singleOrDoubleFamilyHouse",
  • "buildingAge": "from2002",
  • "isMonumentProtected": false,
  • "numberOfResidents": 0,
  • "numberOfFloors": 0,
  • "heatedLivingAreaM2": 0,
  • "currentHeatingSystemType": "gas",
  • "currentHeatingSystemConstructionYear": "before1980",
  • "drinkingWaterHeatingSystemType": "withCirculation",
  • "heatingCircuits": [
    ],
  • "technicalFeasibilityAssesment": "feasible",
  • "address": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "status": "inProgress",
  • "isLead": false,
  • "humanId": "string",
  • "projectValue": 0,
  • "installationDate": "2019-08-24",
  • "buildingType": "singleOrDoubleFamilyHouse",
  • "buildingAge": "from2002",
  • "isMonumentProtected": false,
  • "numberOfResidents": 0,
  • "numberOfFloors": 0,
  • "heatedLivingAreaM2": 0,
  • "currentHeatingSystemType": "gas",
  • "currentHeatingSystemConstructionYear": "before1980",
  • "drinkingWaterHeatingSystemType": "withCirculation",
  • "heatingCircuits": [
    ],
  • "technicalFeasibilityAssesment": "feasible",
  • "address": {
    }
}

Delete a project

This action is irreversible!

Authorizations:
apiKeyAuth
path Parameters
projectId
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Customers

Create a customer

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
companyId
required
string <uuid>
firstName
required
string
lastName
required
string
email
string or null <email>
invoiceEmail
string or null <email>
phoneNumber
string or null

Responses

Request samples

Content type
application/json
{
  • "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "user@example.com",
  • "invoiceEmail": "user@example.com",
  • "phoneNumber": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "firstName": "string",
  • "lastName": "string",
  • "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "address": {
    },
  • "email": "user@example.com",
  • "invoiceEmail": "user@example.com",
  • "phoneNumber": "string"
}

Get all customers

Authorizations:
apiKeyAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a customer by id

Authorizations:
apiKeyAuth
path Parameters
customerId
required
string

ID of the customer to fetch

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "firstName": "string",
  • "lastName": "string",
  • "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "address": {
    },
  • "email": "user@example.com",
  • "invoiceEmail": "user@example.com",
  • "phoneNumber": "string"
}

Update a customer

You only need to provide the fields you want to update.

Authorizations:
apiKeyAuth
path Parameters
customerId
required
string
Request Body schema: application/json
required
companyId
string <uuid>
firstName
string
lastName
string
email
string or null <email>
invoiceEmail
string or null <email>
phoneNumber
string or null

Responses

Request samples

Content type
application/json
{
  • "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "user@example.com",
  • "invoiceEmail": "user@example.com",
  • "phoneNumber": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "firstName": "string",
  • "lastName": "string",
  • "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "address": {
    },
  • "email": "user@example.com",
  • "invoiceEmail": "user@example.com",
  • "phoneNumber": "string"
}

Delete a customer

This action is irreversible!

Authorizations:
apiKeyAuth
path Parameters
customerId
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}