Aufträge

Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren.

Aufträge abrufen

Version 1.0

---

GET/openwowi/v1.0/Commissioning/Commissions

Authorization

Authorization

Query parameters

Response

200400401

OK

Body

text/plainapplication/jsontext/json

Idinteger (int32)

IdNumnullable string

CraftsProcessnullable all of

CommissionTypeIdinteger (int32)

EconomicUnitIdnullable integer (int32)

BuildingIdnullable integer (int32)

UseUnitIdnullable integer (int32)

LicenseAgreementIdnullable integer (int32)

PropertyManagementContractIdnullable integer (int32)

CraftsmanIdnullable integer (int32)

RecordingDatestring (date-time)

PlacingDatenullable string (date-time)

AcceptanceDatenullable string (date-time)

CurrentStatusStepIdnullable integer (int32)

CurrentStatusStepCodenullable string

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.0/Commissioning/Commissions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

[
  {
    "Id": 1,
    "IdNum": "text",
    "CraftsProcess": {
      "Id": 1,
      "IdNum": "text",
      "ProjectId": 1,
      "CraftProcessTypeId": 1
    },
    "CommissionTypeId": 1,
    "EconomicUnitId": 1,
    "BuildingId": 1,
    "UseUnitId": 1,
    "LicenseAgreementId": 1,
    "PropertyManagementContractId": 1,
    "CraftsmanId": 1,
    "RecordingDate": "2025-02-05T03:50:54.185Z",
    "PlacingDate": "2025-02-05T03:50:54.185Z",
    "AcceptanceDate": "2025-02-05T03:50:54.185Z",
    "CurrentStatusStepId": 1,
    "CurrentStatusStepCode": "text"
  }
]

---

Version 1.2

---

GET/openwowi/v1.2/CommissioningRead/Commissions

Authorization

Authorization

Query parameters

Response

200400401

OK

Body

text/plainapplication/jsontext/json

Idinteger (int32)

IdNumnullable string

Codenullable string

DamageReportCodenullable string

DamageLocationnullable string

DamageReportBynullable string

ReasonForRefusalnullable string

ContactPersonOnSitenullable string

ContactPersonEngineeringnullable string

RecordingDatestring (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

ReleaseDatenullable string (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

PlacingDatenullable string (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

ExecutionFromnullable string (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

ExecutionTonullable string (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

AcceptanceDatenullable string (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

CompletionDatenullable string (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

CraftsmanPortalImportDatenullable string (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

CommissionTypenullable all of

CommissionStatusnullable all of

CraftsProcessnullable all of

CompanyCodenullable all of

Craftsmannullable all of

LicenseAgreementnullable all of

UseUnitnullable all of

EconomicUnitnullable all of

Buildingnullable all of

ResponsibleOfficialRepairnullable all of

Caretakernullable all of

Architectnullable all of

EstateAddressnullable all of

CommissionDetailsnullable all of

CommissionItemsnullable array of object

AdditionalFieldsnullable array of object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.2/CommissioningRead/Commissions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

[
  {
    "Id": 1,
    "IdNum": "text",
    "Code": "text",
    "DamageReportCode": "text",
    "DamageLocation": "text",
    "DamageReportBy": "text",
    "ReasonForRefusal": "text",
    "ContactPersonOnSite": "text",
    "ContactPersonEngineering": "text",
    "RecordingDate": "2025-02-05",
    "ReleaseDate": "2025-02-05",
    "PlacingDate": "2025-02-05",
    "ExecutionFrom": "2025-02-05",
    "ExecutionTo": "2025-02-05",
    "AcceptanceDate": "2025-02-05",
    "CompletionDate": "2025-02-05",
    "CraftsmanPortalImportDate": "2025-02-05",
    "CommissionType": {
      "Id": 1,
      "Code": "text"
    },
    "CommissionStatus": {
      "Id": 1,
      "Code": "text"
    },
    "CraftsProcess": {
      "Id": 1,
      "IdNum": "text"
    },
    "CompanyCode": {
      "Id": 1,
      "Name": "text",
      "Code": "text"
    },
    "Craftsman": {
      "Id": 1,
      "CreditorId": 1,
      "CreditorNumber": "text"
    },
    "LicenseAgreement": {
      "Id": 1,
      "IdNum": "text"
    },
    "UseUnit": {
      "Id": 1,
      "UseUnitNumber": "text"
    },
    "EconomicUnit": {
      "Id": 1,
      "IdNum": "text"
    },
    "Building": {
      "Id": 1,
      "IdNum": "text",
      "BuildingLandType": "text"
    },
    "ResponsibleOfficialRepair": {
      "Id": 1,
      "CodeShort": "text",
      "AutomaticMailsActivated": true,
      "UniversalResponsibilityPossible": true,
      "PersonId": 1,
      "PersonName": "text",
      "UserId": 1
    },
    "Caretaker": {
      "Id": 1,
      "PersonId": 1,
      "PersonIdNum": "text",
      "PersonName": "text"
    },
    "Architect": {
      "Id": 1,
      "PersonId": 1,
      "PersonIdNum": "text",
      "PersonName": "text"
    },
    "EstateAddress": {
      "Zip": "text",
      "Town": "text",
      "Street": "text",
      "HouseNumber": "text",
      "HouseNumberAddition": "text",
      "CountryId": 1,
      "CountryCode": "text",
      "StreetComplete": "text",
      "HouseNumberComplete": "text"
    },
    "CommissionDetails": {
      "AlternativeDiscountPercentage": 1,
      "AlternativeDiscountInDays": 1,
      "SecurityWithhold": {
        "Id": 1,
        "Name": "text",
        "Percentage": 1,
        "MaturityInMonths": 1
      },
      "WarrantyWithhold": {
        "Id": 1,
        "Name": "text",
        "Percentage": 1,
        "MaturityInMonths": 1
      }
    },
    "CommissionItems": [
      {
        "Id": 1,
        "Code": "text",
        "UnitPrice": 1,
        "GrossAmount": 1,
        "NetAmount": 1,
        "Units": 1,
        "CommissionText": "text",
        "InternalDescription": "text",
        "PositionNumber": 1,
        "IsCanceled": true,
        "IsSmallRepair": true,
        "TransferToCraftsmanPortalWithoutCosts": true,
        "BudgetData": {
          "Budget": {
            "Id": 1,
            "Code": "text"
          },
          "BudgetDetail": {
            "Id": 1,
            "BudgetId": 1,
            "Hierarchy1Value": "text",
            "Hierarchy2Value": "text",
            "Hierarchy3Value": "text"
          }
        },
        "SalesTax": {
          "Id": 1,
          "Code": "text"
        },
        "ServiceCatalogue": {
          "Id": 1,
          "IdNum": "text",
          "Description": "text",
          "QuantityType": {
            "Id": 1,
            "Name": "text",
            "Code": "text",
            "ArgeCode": "text"
          }
        },
        "CraftActivity": {
          "Id": 1,
          "Code": "text"
        },
        "QuantityType": {
          "Id": 1,
          "Name": "text",
          "Code": "text",
          "ArgeCode": "text"
        },
        "Component": {
          "Id": 1,
          "Name": "text"
        },
        "Facility": {
          "Id": 1,
          "Name": "text"
        },
        "ComponentCatalog": {
          "Id": 1,
          "Name": "text"
        },
        "FacilityCatalog": {
          "Id": 1,
          "Name": "text"
        }
      }
    ],
    "AdditionalFields": [
      {
        "Name": "text",
        "Content": "text",
        "Type": "text"
      }
    ]
  }
]

---

Aufträge anlegen

Version 1.2

Aufträge im Status "Erfasst" anlegen

---

POST/openwowi/v1.2/CommissioningEdit/Commission

Authorization

Authorization

Query parameters

Body

application/jsontext/jsonapplication/*+json

CraftsProcessIdinteger (int32)

IdNumnullable string

Codenullable string

ExternalIdentificationNumbernullable string

CommissionTypeIdinteger (int32)

CreditorIdnullable integer (int32)

UseUnitIdnullable integer (int32)

BuildingIdnullable integer (int32)

LandIdnullable integer (int32)

EconomicUnitIdnullable integer (int32)

LicenseAgreementIdnullable integer (int32)

PropertyManagementContractIdnullable integer (int32)

ResponsibleOfficialRepairIdnullable integer (int32)

DepartmentIdnullable integer (int32)

RecordingDatenullable string (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

CompletionDatenullable string (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

PlacingDatenullable string (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

AcceptanceDatenullable string (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

ExecutionFromnullable string (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

ExecutionTonullable string (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

Positionsnullable array of object

CommissionStatusIdinteger (int32)

Response

201400401

Created

Body

text/plainapplication/jsontext/json

Idinteger (int32)

IdNumnullable string

CraftsProcessnullable all of

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.2/CommissioningEdit/Commission?apiKey=text', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "RecordingDate": "2025-02-05",
      "CompletionDate": "2025-02-05",
      "PlacingDate": "2025-02-05",
      "AcceptanceDate": "2025-02-05",
      "ExecutionFrom": "2025-02-05",
      "ExecutionTo": "2025-02-05",
      "Positions": [
        {}
      ]
    }),
});
const data = await response.json();

Response

201400

{
  "Id": 1,
  "IdNum": "text",
  "CraftsProcess": {
    "Id": 1,
    "IdNum": "text"
  }
}

---

Aufträge im Status "Warte auf Annahme" anlegen

---

POST/openwowi/v1.2/CommissioningEdit/Commission/WaitForCraftsmanFeedback

Authorization

Authorization

Query parameters

Body

application/jsontext/jsonapplication/*+json

CraftsProcessIdinteger (int32)

IdNumnullable string

Codenullable string

ExternalIdentificationNumbernullable string

CommissionTypeIdinteger (int32)

CreditorIdnullable integer (int32)

UseUnitIdnullable integer (int32)

BuildingIdnullable integer (int32)

LandIdnullable integer (int32)

EconomicUnitIdnullable integer (int32)

LicenseAgreementIdnullable integer (int32)

PropertyManagementContractIdnullable integer (int32)

ResponsibleOfficialRepairIdnullable integer (int32)

DepartmentIdnullable integer (int32)

RecordingDatenullable string (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

CompletionDatenullable string (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

PlacingDatenullable string (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

AcceptanceDatenullable string (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

ExecutionFromnullable string (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

ExecutionTonullable string (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

Positionsnullable array of object

Response

200400401

OK

Body

text/plainapplication/jsontext/json

Idinteger (int32)

IdNumnullable string

CraftsProcessnullable all of

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.2/CommissioningEdit/Commission/WaitForCraftsmanFeedback?apiKey=text', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "RecordingDate": "2025-02-05",
      "CompletionDate": "2025-02-05",
      "PlacingDate": "2025-02-05",
      "AcceptanceDate": "2025-02-05",
      "ExecutionFrom": "2025-02-05",
      "ExecutionTo": "2025-02-05",
      "Positions": [
        {}
      ]
    }),
});
const data = await response.json();

Response

200400

{
  "Id": 1,
  "IdNum": "text",
  "CraftsProcess": {
    "Id": 1,
    "IdNum": "text"
  }
}

---

Ändern des Auftragsstatus

Version 1.2

Ändern auf "Angenommen"

---

PUT/openwowi/v1.2/CommissioningEdit/Commission/{commissionId}/Accepted

Authorization

Authorization

Path parameters

commissionId*integer (int32)

Query parameters

Response

200400401

OK

Body

text/plainapplication/jsontext/json

Idinteger (int32)

IdNumnullable string

CraftsProcessnullable all of

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.2/CommissioningEdit/Commission/{commissionId}/Accepted?apiKey=text', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "Id": 1,
  "IdNum": "text",
  "CraftsProcess": {
    "Id": 1,
    "IdNum": "text"
  }
}

---

Ändern auf "Abgelehnt"

---

PUT/openwowi/v1.2/CommissioningEdit/Commission/{commissionId}/Refused

Authorization

Authorization

Path parameters

commissionId*integer (int32)

Query parameters

Body

application/jsontext/jsonapplication/*+json

ReasonForRefusalnullable string

Response

200400401

OK

Body

text/plainapplication/jsontext/json

Idinteger (int32)

IdNumnullable string

CraftsProcessnullable all of

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.2/CommissioningEdit/Commission/{commissionId}/Refused?apiKey=text', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400

{
  "Id": 1,
  "IdNum": "text",
  "CraftsProcess": {
    "Id": 1,
    "IdNum": "text"
  }
}

---

Ändern auf "Erledigt"

---

PUT/openwowi/v1.2/CommissioningEdit/Commission/{commissionId}/Done

Authorization

Authorization

Path parameters

commissionId*integer (int32)

Query parameters

Response

200400401

OK

Body

text/plainapplication/jsontext/json

Idinteger (int32)

IdNumnullable string

CraftsProcessnullable all of

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.2/CommissioningEdit/Commission/{commissionId}/Done?apiKey=text', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "Id": 1,
  "IdNum": "text",
  "CraftsProcess": {
    "Id": 1,
    "IdNum": "text"
  }
}

---

Ändern auf "An Handwerkerportal übertragen"

---

PUT/openwowi/v1.2/CommissioningEdit/Commission/{commissionId}/Imported

Authorization

Authorization

Path parameters

commissionId*integer (int32)

Query parameters

Response

200400401

OK

Body

text/plainapplication/jsontext/json

Idinteger (int32)

IdNumnullable string

CraftsProcessnullable all of

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.2/CommissioningEdit/Commission/{commissionId}/Imported?apiKey=text', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "Id": 1,
  "IdNum": "text",
  "CraftsProcess": {
    "Id": 1,
    "IdNum": "text"
  }
}

---

Ändern auf "Rechnungseingang erwartet"

---

PUT/openwowi/v1.2/CommissioningEdit/Commission/{commissionId}/AwaitInvoice

Authorization

Authorization

Path parameters

commissionId*integer (int32)

Query parameters

Response

200400401

OK

Body

text/plainapplication/jsontext/json

Idinteger (int32)

IdNumnullable string

CraftsProcessnullable all of

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.2/CommissioningEdit/Commission/{commissionId}/AwaitInvoice?apiKey=text', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "Id": 1,
  "IdNum": "text",
  "CraftsProcess": {
    "Id": 1,
    "IdNum": "text"
  }
}

---

Ändern auf "Storniert"

---

PUT/openwowi/v1.2/CommissioningEdit/Commission/{commissionId}/Canceled

Authorization

Authorization

Path parameters

commissionId*integer (int32)

Query parameters

Response

200400401

OK

Body

text/plainapplication/jsontext/json

Idinteger (int32)

IdNumnullable string

CraftsProcessnullable all of

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.2/CommissioningEdit/Commission/{commissionId}/Canceled?apiKey=text', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "Id": 1,
  "IdNum": "text",
  "CraftsProcess": {
    "Id": 1,
    "IdNum": "text"
  }
}

---

Enumerator für "CommissionStatus" und "Id"

Id	Code	Deutsch
1	EffortRecording	Leistungserfassung
2	CommissionRecorded	Erfasst
3	CommissionPlaced	Auftragsvergabe
4	ApprovalRequired	Freigabe erforderlich
6	Approved	Freigegeben
7	Accepted	Angenommen
8	Refused	Abgelehnt
9	Done	Erledigt
10	Suspended	Aussetzen
11	AwaitInvoice	Rechnungseingang erwartet
12	WaitForCraftsmanFeedback	Warte auf Annahme
13	Canceled	Storniert
14	InvoiceRecorded	Rechnung erfasst
15	PartSettled	Teilabgerechnet
16	CraftsmanPortalImported	An Handwerkerportal übertragen