Connector
Upsert
Inserts or updates a connector.
Name | Data Type | Default | Required |
---|---|---|---|
Name | nvarchar(MAX) | ||
Description | nvarchar(MAX) | ||
SourceApp | nvarchar(30) | ✔️ | |
SendAppointmentToWebService | bit | False | |
WebServiceAddress | bit | True | ✔️ |
Type | INT | 0 | |
AuthType | INT | 0 | |
ApiType | INT | 0 | |
Login | NVARCHAR (50) | ||
Password | NVARCHAR (MAX) |
- Import
- API
- This endpoint is available in the import API endpoint
/import
via the proceduremboc_upsertConnector
. - Example body:
[
{
"StoredProcedureName": "mboc_upsertConnector",
"ParameterNames": ["SourceApp","SendAppointmentToWebService", "WebServiceAddress", "Type", "Login", "Password"],
"ParameterValues": ["MYSOURCEAPP","true", "https://myendpoint.domain","1","test_user","test_password"]
}
]
- Endpoint:
/connector
- Supported HTTP methods: POST (create)
- Example body:
{
"SourceApp": "MYSOURCEAPP",
"Enabled": true,
"Uri": "https://myendpoint.domain",
"Login": "test_user",
"Password": "test_password",
"Type": 1
}
Delete
Removes a connector.
Name | Data Type | Default | Required |
---|---|---|---|
SourceApp | nvarchar(100) | ✔️ |
- Import
- API
- This endpoint is available in the import API endpoint
/import
via the proceduremboc_deleteConnector
. - Example body:
[
{
"StoredProcedureName": "mboc_deleteConnector",
"ParameterNames": ["SourceApp"],
"ParameterValues": ["MYSOURCEAPP"]
}
]
This endpoint is not yet available in the REST API.
API reference
Back-Office System
The back office type enum supports the following values:
Enum | Represents |
---|---|
0 | None |
1 | BC |
2 | NAV |
3 | Webhook |
warning
Use the enum integer value, not the text value.
Authentication Type
The authentication type enum supports the following values:
Enum | Represents |
---|---|
0 | None |
1 | Basic |
2 | NTLM |
3 | Windows |
4 | MS Entra ID |
5 | OAuth2: Client Credentials (Body Auth) |
6 | OAuth2: Client Credentials (Basic Auth) |
warning
Use the enum integer value, not the text value.
API type
Enum | Represents |
---|---|
0 | SOAP (XML) |
1 | REST (JSON) |
warning
Use the enum integer value, not the text value.