Elfsquad Configurator API (v1)
Download OpenAPI specification:Download
Open existing configuration
path Parameters
configurationId required | string Identifier or code of the configuration session |
version required | string |
query Parameters
ignoreConflicts | boolean Default: false (Optional) You can choose to ignore conflicts that may have occurred because of changes in the underlying configuration model |
includeSearchbarResults | boolean Default: true |
lang | string |
Responses
Response samples
- 200
Update requirement
path Parameters
configurationId required | string <uuid> Identifier of the configuration |
version required | string |
query Parameters
ignoreConflicts | boolean (Optional) Ignore conflicts |
includeSearchbarResults | boolean Default: true |
debug | boolean Default: false |
Request Body schema:
Requirement
featureModelNodeId | string <uuid> |
value | number <double> |
isSelection | boolean |
Responses
Request samples
- Payload
{- "featureModelNodeId": "fd1b88e2-396c-47dc-aac2-ee7e5b668f17",
- "value": 0,
- "isSelection": true
}
Response samples
- 200
Update text value
Updates the text value of a feature model node in the configuration
path Parameters
id required | string <uuid> The configuration identifier |
version required | string |
query Parameters
includeSearchbarResults | boolean Default: true |
Request Body schema:
The updated requirement e.g. { featureModelNodeId: string, textValue: string }
featureModelNodeId | string <uuid> |
textValue | string or null |
Responses
Request samples
- Payload
{- "featureModelNodeId": "fd1b88e2-396c-47dc-aac2-ee7e5b668f17",
- "textValue": "string"
}
Response samples
- 200
Update multiple text values
Updates the text values of feature model nodes in the configuration
path Parameters
id required | string <uuid> The configuration identifier |
version required | string |
query Parameters
includeSearchbarResults | boolean Default: true |
Request Body schema:
The updated requirements e.g. [ { featureModelNodeId: string, textValue: string } ]
featureModelNodeId | string <uuid> |
textValue | string or null |
Responses
Request samples
- Payload
[- {
- "featureModelNodeId": "fd1b88e2-396c-47dc-aac2-ee7e5b668f17",
- "textValue": "string"
}
]
Response samples
- 200
/configurator/{version}/configurator/updatelinkedconfigurationcardinality
path Parameters
version required | string |
Request Body schema:
configurationId | string or null |
cardinality | integer <int32> |
parentNodeId | string or null |
Responses
Request samples
- Payload
{- "configurationId": "string",
- "cardinality": 0,
- "parentNodeId": "string"
}
Response samples
- 200
/configurator/{version}/configurator/{configurationId}/cardinality
path Parameters
configurationId required | string <uuid> |
version required | string |
Request Body schema:
nodeId | string <uuid> |
cardinality | integer <int32> |
index | integer <int32> |
Responses
Request samples
- Payload
{- "nodeId": "959356e3-6168-4a92-b4a5-b9d462be6177",
- "cardinality": 0,
- "index": 0
}
Response samples
- 200
Change language
path Parameters
configurationId required | string <uuid> Identifier of the configuration |
version required | string |
query Parameters
includeSearchbarResults | boolean Default: true |
Request Body schema:
Language ISO
Responses
Request samples
- Payload
"string"
Response samples
- 200
/configurator/{version}/configurator/changelanguage
path Parameters
version required | string |
query Parameters
includeSearchbarResults | boolean Default: true |
Request Body schema:
configurationId | string or null |
languageIso | string or null |
Responses
Request samples
- Payload
{- "configurationId": "string",
- "languageIso": "string"
}
Response samples
- 200
Get step image
path Parameters
id required | string <uuid> Identifier of the configuration |
version required | string |
query Parameters
stepId | string <uuid> Identifier of the step |
size | integer <int32> (Optional) size of the image in pixels |
background | boolean Default: true (Optional) Display background in the image |
c | string |
Responses
Response samples
- 200
Add configuration to quotation
path Parameters
version required | string |
Request Body schema:
quotationId | string <uuid> |
configurationIds | Array of strings or null <uuid> |
object or null |
Responses
Request samples
- Payload
{- "quotationId": "98c8afab-b1d9-462f-9483-5a2dbf34985f",
- "configurationIds": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "quantities": {
- "property1": 0,
- "property2": 0
}
}
/configurator/{version}/configurator/requestquote
path Parameters
version required | string |
Request Body schema:
object (QuotationRequestViewModel) | |
configurationIds | Array of strings or null <uuid> |
object or null |
Responses
Request samples
- Payload
{- "quotationRequest": {
- "firstName": "string",
- "lastName": "string",
- "lastNamePrefix": "string",
- "salutation": "string",
- "email": "string",
- "city": "string",
- "postalCode": "string",
- "streetName": "string",
- "houseNumber": "string",
- "countryIso": "st",
- "languageIso": "st",
- "phoneNumber": "string",
- "phoneNumber2": "string",
- "companyName": "string",
- "iban": "string",
- "cocNumber": "string",
- "vatNumber": "string",
- "shipto_FirstName": "string",
- "shipto_LastName": "string",
- "shipto_LastNamePrefix": "string",
- "shipto_Salutation": "string",
- "shipto_Email": "string",
- "shipto_City": "string",
- "shipto_PostalCode": "string",
- "shipto_StreetName": "string",
- "shipto_HouseNumber": "string",
- "shipto_CountryIso": "string",
- "shipto_LanguageIso": "string",
- "shipto_PhoneNumber": "string",
- "shipto_PhoneNumber2": "string",
- "shipto_CompanyName": "string",
- "remarks": "string",
- "grecaptcha": "string"
}, - "configurationIds": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "quantities": {
- "property1": 0,
- "property2": 0
}
}
Starts a new configuration session
path Parameters
featureModelName required | string Name of the configuration model. The name can be either the feature name, configuration model ID, or a previous configuration session code |
version required | string |
query Parameters
lang | string (Optional) Language ISO |
preview | boolean Default: false |
includeSearchbarResults | boolean Default: true |
debug | boolean Default: false |
Responses
Response samples
- 200