cibs
View the WSDL for the service. Click on an operation name to view it's details.
- ws_session_login
- ws_session_logout
- ws_session_set_ct
- ws_bank_statement_upload
- ws_bank_statement_list
- ws_sipo_statement_upload
- ws_ts_export_transport_items
- ws_ts_export_confirm
- ws_users_export
- ws_user_service_export
- ws_user_payment_info
- ws_users_list
- ws_user_create
- ws_user_edit
- ws_user_param_edit
- ws_product_update
- ws_product_param_set
- ws_product_list_get
- ws_product_personalized_list
- ws_product_personalized_create
- ws_product_personalized_delete
- ws_product_linkage_create
- ws_product_linkage_delete
- ws_product_linkage_list_get
- ws_product_coupon_create
- ws_config_set
- ws_shop_stock_sync
- ws_shop_stock_correct
- ws_order_coverage
- ws_order_prepare
- ws_order_close
- ws_orders_list
- ws_order_items_get
- ws_order_item_params_get
- ws_order_item_paramdata_get
- ws_order_create
- ws_order_edit
- ws_order_realization
- ws_order_storno
- ws_order_items_create
- ws_order_items_delete
- ws_order_payment_create
- ws_konzumuo_temporary_order_fix
- ws_premises_list
- ws_premise_create
- ws_premise_edit
- ws_premise_delete
- ws_premise_param_update
- ws_network_nodes_list
- ws_network_node_create
- ws_network_node_edit
- ws_network_node_delete
- ws_network_event_alert
- ws_price_calculation_get
- crmSubscribeOffer
- crmUnsubscribeOffer
Close
Name: ws_session_login
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_session_loginRequest
parts:
login: xsd:string
password: xsd:string
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_session_loginResponse
parts:
session: xsd:string
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Logs in operator identified by password and authorized by password. Succesfull login creates CIBS AppBus session used for all ohter requests, empty string is returned on any failure.
Name: ws_session_login
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_session_loginRequest
parts:
login: xsd:string
password: xsd:string
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_session_loginResponse
parts:
session: xsd:string
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Logs in operator identified by password and authorized by password. Succesfull login creates CIBS AppBus session used for all ohter requests, empty string is returned on any failure.
Close
Name: ws_session_logout
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_session_logoutRequest
parts:
session: xsd:string
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_session_logoutResponse
parts:
result: xsd:int
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Logs out the operator identified by CIBS AppBus session. Integer return value is 1 for successfull logout, 0 otherwise.
Name: ws_session_logout
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_session_logoutRequest
parts:
session: xsd:string
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_session_logoutResponse
parts:
result: xsd:int
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Logs out the operator identified by CIBS AppBus session. Integer return value is 1 for successfull logout, 0 otherwise.
Close
Name: ws_session_set_ct
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_session_set_ctRequest
parts:
session: xsd:string
ct: xsd:string
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_session_set_ctResponse
parts:
result: xsd:int
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Select cibs location ct. Integer return value is 1 for correct settings, 0 otherwise (operator has insufficient rights for the location).
Name: ws_session_set_ct
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_session_set_ctRequest
parts:
session: xsd:string
ct: xsd:string
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_session_set_ctResponse
parts:
result: xsd:int
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Select cibs location ct. Integer return value is 1 for correct settings, 0 otherwise (operator has insufficient rights for the location).
Close
Name: ws_bank_statement_upload
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_bank_statement_uploadRequest
parts:
session: xsd:string
pa_id: xsd:int
file_name: xsd:string
file_content: xsd:string
file_md5: xsd:string
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_bank_statement_uploadResponse
parts:
result: xsd:int
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Uploads the bank statement file for future processing. Params: session - identifies operator, pa_id - identifies CIBS pay_account, file_name - original name of the file, file_content - Base64 encoded file content, file_md5 - MD5 sum of the file for check of transfer.
Returns: Integer - positive ID of the file upload record, neggative and 0 error code:
0 - ERROR - unexpected error
-1 - ERROR - invalid session
-2 - ERROR - Operator does not have right to upload bank statement files
-3 - ERROR - Operator can not access the account
-4 - ERROR - Given CIBS pay_account does not exist
-5 - ERROR - Given CIBS pay_account is not of correct type
-6 - ERROR - Given CIBS pay_account is not active
-1001 - ERROR - Unable to store file (storage file create)
-1002 - ERROR - Unable to store file (md5 checksum)
-1003 - ERROR - Unable to confirm the file for processing (file uploaded successfully but not confirmed).
-2001 - ERROR - WebServices upload of bank statement not permitted for selected location.
Name: ws_bank_statement_upload
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_bank_statement_uploadRequest
parts:
session: xsd:string
pa_id: xsd:int
file_name: xsd:string
file_content: xsd:string
file_md5: xsd:string
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_bank_statement_uploadResponse
parts:
result: xsd:int
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Uploads the bank statement file for future processing. Params: session - identifies operator, pa_id - identifies CIBS pay_account, file_name - original name of the file, file_content - Base64 encoded file content, file_md5 - MD5 sum of the file for check of transfer.
Returns: Integer - positive ID of the file upload record, neggative and 0 error code:
0 - ERROR - unexpected error
-1 - ERROR - invalid session
-2 - ERROR - Operator does not have right to upload bank statement files
-3 - ERROR - Operator can not access the account
-4 - ERROR - Given CIBS pay_account does not exist
-5 - ERROR - Given CIBS pay_account is not of correct type
-6 - ERROR - Given CIBS pay_account is not active
-1001 - ERROR - Unable to store file (storage file create)
-1002 - ERROR - Unable to store file (md5 checksum)
-1003 - ERROR - Unable to confirm the file for processing (file uploaded successfully but not confirmed).
-2001 - ERROR - WebServices upload of bank statement not permitted for selected location.
Close
Name: ws_bank_statement_list
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_bank_statement_listRequest
parts:
session: xsd:string
pa_id: xsd:int
from: xsd:string
till: xsd:string
count: xsd:int
offset: xsd:int
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_bank_statement_listResponse
parts:
result: tns:BankStatementList
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: List all the uploaded bank statement files. User can filter the pay account the files were imported to, the date, etc. The files are sorted by upload time from the latest to the oldest.
Params:
- session - Valid Mango application session with the CP information set.
- type - Optional type of the reference. This param is mandatory when the ref_id param is used. Values are 'bank' or 'sipo'.
- ref_id - Optional ID of the pay_account. When no ID given, all accounts are listed.
- from - Optional date to start the listing from. When no from date given all the files are listed.
- till - Optional date to stop the listing. When no till date given all the files up to now are listed.
- count - Optional number of files to be returned by one call. Default 100 items is used when no limit is given.
- offset - Optional offset to list the files from. When there are more than count files in the listing, you can walk throught the listing using this param.
Result - the list of URL to download the files.
Name: ws_bank_statement_list
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_bank_statement_listRequest
parts:
session: xsd:string
pa_id: xsd:int
from: xsd:string
till: xsd:string
count: xsd:int
offset: xsd:int
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_bank_statement_listResponse
parts:
result: tns:BankStatementList
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: List all the uploaded bank statement files. User can filter the pay account the files were imported to, the date, etc. The files are sorted by upload time from the latest to the oldest.
Params:
- session - Valid Mango application session with the CP information set.
- type - Optional type of the reference. This param is mandatory when the ref_id param is used. Values are 'bank' or 'sipo'.
- ref_id - Optional ID of the pay_account. When no ID given, all accounts are listed.
- from - Optional date to start the listing from. When no from date given all the files are listed.
- till - Optional date to stop the listing. When no till date given all the files up to now are listed.
- count - Optional number of files to be returned by one call. Default 100 items is used when no limit is given.
- offset - Optional offset to list the files from. When there are more than count files in the listing, you can walk throught the listing using this param.
Result - the list of URL to download the files.
Close
Name: ws_sipo_statement_upload
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_sipo_statement_uploadRequest
parts:
session: xsd:string
file_name: xsd:string
file_content: xsd:string
file_md5: xsd:string
repeated: xsd:boolean
date: xsd:date
orgnum: xsd:string
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_sipo_statement_uploadResponse
parts:
result: xsd:int
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Uploads SIPO statement file for future processing. Params: session - identifies operator, pa_id - identifies CIBS pay_account, file_name - original name of the file, file_content - Base64 encoded file content, file_md5 - MD5 sum of the file for check of transfer, repeated - try repeated import, defaults to false, date - date for repeated import, orgnum - variable symbol for repeated import.
Returns: Integer - positive ID of the file upload record, negative and 0 error code:
0 - ERROR - unexpected error
-1 - ERROR - invalid session
...
Name: ws_sipo_statement_upload
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_sipo_statement_uploadRequest
parts:
session: xsd:string
file_name: xsd:string
file_content: xsd:string
file_md5: xsd:string
repeated: xsd:boolean
date: xsd:date
orgnum: xsd:string
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_sipo_statement_uploadResponse
parts:
result: xsd:int
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Uploads SIPO statement file for future processing. Params: session - identifies operator, pa_id - identifies CIBS pay_account, file_name - original name of the file, file_content - Base64 encoded file content, file_md5 - MD5 sum of the file for check of transfer, repeated - try repeated import, defaults to false, date - date for repeated import, orgnum - variable symbol for repeated import.
Returns: Integer - positive ID of the file upload record, negative and 0 error code:
0 - ERROR - unexpected error
-1 - ERROR - invalid session
...
Close
Name: ws_ts_export_transport_items
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_ts_export_transport_itemsRequest
parts:
session: xsd:string
ts_id: xsd:int
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_ts_export_transport_itemsResponse
parts:
result: xsd:string
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Export transport items form travel service provider. Params: session - identifies operator, ts_id - travel service id.
Returns: String - XML with all items to trasport, Status codes:
0 - nothing to export
-1 - ERROR - invalid session
-2001 - ERROR - no right for this transport service.
Name: ws_ts_export_transport_items
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_ts_export_transport_itemsRequest
parts:
session: xsd:string
ts_id: xsd:int
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_ts_export_transport_itemsResponse
parts:
result: xsd:string
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Export transport items form travel service provider. Params: session - identifies operator, ts_id - travel service id.
Returns: String - XML with all items to trasport, Status codes:
0 - nothing to export
-1 - ERROR - invalid session
-2001 - ERROR - no right for this transport service.
Close
Name: ws_ts_export_confirm
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_ts_export_confirmRequest
parts:
session: xsd:string
ti_id: xsd:int
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_ts_export_confirmResponse
parts:
result: xsd:int
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Export transport confirm items. Params: session - identifies operator, ti_id - transporte item id.
Returns: String - XML with all items to trasport. Rreturns:
0 - ERROR - unexpected error
2001 - ERROR - no right or bad login
positive integer - confirm ok
.
Name: ws_ts_export_confirm
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_ts_export_confirmRequest
parts:
session: xsd:string
ti_id: xsd:int
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_ts_export_confirmResponse
parts:
result: xsd:int
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Export transport confirm items. Params: session - identifies operator, ti_id - transporte item id.
Returns: String - XML with all items to trasport. Rreturns:
0 - ERROR - unexpected error
2001 - ERROR - no right or bad login
positive integer - confirm ok
.
Close
Name: ws_users_export
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_users_exportRequest
parts:
session: xsd:string
services_state: xsd:string
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_users_exportResponse
parts:
result: xsd:string
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Export users. Params: session - identifies operator, services_state - BLOCKED, ACTIVE, CANCELED, NOTCONNECTED.
Returns: String - XML with all users, Status codes:
0 - nothing to export
-1 - ERROR - invalid session
-2001 - ERROR - no right for this users export
-2002 - ERROR - invalid services_state.
Name: ws_users_export
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_users_exportRequest
parts:
session: xsd:string
services_state: xsd:string
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_users_exportResponse
parts:
result: xsd:string
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Export users. Params: session - identifies operator, services_state - BLOCKED, ACTIVE, CANCELED, NOTCONNECTED.
Returns: String - XML with all users, Status codes:
0 - nothing to export
-1 - ERROR - invalid session
-2001 - ERROR - no right for this users export
-2002 - ERROR - invalid services_state.
Close
Name: ws_user_service_export
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_user_service_exportRequest
parts:
session: xsd:string
userId: xsd:int
services_state: xsd:string
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_user_service_exportResponse
parts:
result: xsd:string
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Export users. Params: session - identifies operator, userId - identifier of the user to export., services_state - BLOCKED, ACTIVE, CANCELED, NOTCONNECTED
Returns: String - XML with all users, Status codes:
0 - nothing to export
-1 - ERROR - invalid session
-2001 - ERROR - no right for this users export
-2002 - ERROR - invalid services_state.
Name: ws_user_service_export
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_user_service_exportRequest
parts:
session: xsd:string
userId: xsd:int
services_state: xsd:string
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_user_service_exportResponse
parts:
result: xsd:string
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Export users. Params: session - identifies operator, userId - identifier of the user to export., services_state - BLOCKED, ACTIVE, CANCELED, NOTCONNECTED
Returns: String - XML with all users, Status codes:
0 - nothing to export
-1 - ERROR - invalid session
-2001 - ERROR - no right for this users export
-2002 - ERROR - invalid services_state.
Close
Name: ws_user_payment_info
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_user_payment_infoRequest
parts:
session: xsd:string
user_id: xsd:int
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_user_payment_infoResponse
parts:
result: xsd:string
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Export users. Params: session - identifies operator.
Returns: String - XML with all users, Status codes:
0 - nothing to export
-1 - ERROR - invalid session
-2001 - ERROR - no right for this users export.
Name: ws_user_payment_info
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_user_payment_infoRequest
parts:
session: xsd:string
user_id: xsd:int
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_user_payment_infoResponse
parts:
result: xsd:string
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Export users. Params: session - identifies operator.
Returns: String - XML with all users, Status codes:
0 - nothing to export
-1 - ERROR - invalid session
-2001 - ERROR - no right for this users export.
Close
Name: ws_users_list
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_users_listRequest
parts:
session: xsd:string
search: tns:UserSearch
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_users_listResponse
parts:
result: tns:UserList
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Return list of end users matching specified search parameters.
Method parameters:
- session - operator session token as returned by ws_session_login
- search - search parameters specified as instance of UserSearch data type.
Returns:
- result - list of users as User data type
Exceptions:
The method will throw an exception if session token is invalid or expired.
UserSearch complex type:
All fields are optional. Users matching all fields specified will be returned.
- id - unique identification integer number of the user
- login - users login in system selfcare
- firstname - users first name
- surname - users surname
- company - users company
- identity_num - czech legal identity number of user (IČ or DIČ in case of company, RČ in case of person)
- agreement - users agreement number
- varsym - users bank connection variable symbol
- sipo - users SIPO number
User complex type:
- id - unique identification integer number of the user
- active - flag specifying, whether the user will be active (1 active)
- login - users login in system selfcare (optional)
- type - type of user as defined by Czech legislative ("S" = person (private), "F" = natural person, "P" = legal person) (always present)
- degree - persons degree (optional)
- firstname - persons first name (always present for persons)
- surname - persons last name (always present for persons)
- company - company name (always present for companies / users of type "P")
- address - default users address specified as Address data type (always present)
- delivery_address_as_default - boolean flag specifying, whether the users delivery address is same as the default one. If false or not present, delivery_address element must be present.
- delivery_address - users delivery address specified as Address data type
- billing_address_as_default - boolean flag specifying, whether the users delivery address is same as the default one. If neither this or billing_address_as_delivery is true, billing_address element must be present.
- billing_address_as_delivery - boolean flag specifying, whether the users delivery address is same as the delivery one. If neither this or billing_address_as_default is true, billing_address element must be present.
- billing_address - users delivery address specified as Address data type
- phones - user phone number(s). Multiple items may be separated by coma.
- fax - users fax number
- mail - user mail address(es)
- ico - company identification number as specified by Czech legislative
- dic - VAT registration number as specified by Czech legislative
- group_dic - group VAT number as specified by Czech legislative
- rc - persons identification number as specified by Czech legislative
- birthday - persons birth date
- mail_info_flag - boolean flag specifying, whether system will send mail notifications to user
- sms_info_flag - boolean flag specifying, whether system will send sms notifications to user
- premises_flag - boolean flag specifying, whether premise management is applied on user
- agreement - users agreement number
- varsym - users bank connection variable symbol
- sipo - users SIPO number
- account_pre_num - users bank account number prefix
- account_num - users bank account number
- account_bank - users account bank
- account_specsym - users bank accounts specific symbol (optional)
- iban - IBAN (users international bank account number)
- note - text note on user (optional)
- note_interval - internal text note on user, displayed in system (optional)
- note_invoice - text note, which will be printed on users invoices (optional)
- billing_plan_ids - ids of billing plans (methods in which user pays for services or products) which user is allowed to use (subset of values received during implementation)
- default_billing_plan_id - id of default billing plan (methods in which user pays for services or products)
- provider_user_id - id of users provider (if not present, default provider is used)
Address complex type:
Address may be specitied as complete UIR address (using ua_id, us_id and uc_id elements) or in textual form. Both textual and UIR form may be present.
- ua_id - UIR address ID (always present for UIR addresses)
- us_id - UIR address street ID
- uc_id - UIR address city ID
- recipient - recipient person name
- street - street name in textual address representation
- house_id - house id number in textual address representation
- city - city name in textual address representation
- zip - ZIP postal code in textual address representation
- country_id - country identification number - 1 for Czech Republic, 2 for Slovakia (always present)
Name: ws_users_list
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_users_listRequest
parts:
session: xsd:string
search: tns:UserSearch
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_users_listResponse
parts:
result: tns:UserList
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Return list of end users matching specified search parameters.
Method parameters:
- session - operator session token as returned by ws_session_login
- search - search parameters specified as instance of UserSearch data type.
Returns:
- result - list of users as User data type
Exceptions:
The method will throw an exception if session token is invalid or expired.
UserSearch complex type:
All fields are optional. Users matching all fields specified will be returned.
- id - unique identification integer number of the user
- login - users login in system selfcare
- firstname - users first name
- surname - users surname
- company - users company
- identity_num - czech legal identity number of user (IČ or DIČ in case of company, RČ in case of person)
- agreement - users agreement number
- varsym - users bank connection variable symbol
- sipo - users SIPO number
User complex type:
- id - unique identification integer number of the user
- active - flag specifying, whether the user will be active (1 active)
- login - users login in system selfcare (optional)
- type - type of user as defined by Czech legislative ("S" = person (private), "F" = natural person, "P" = legal person) (always present)
- degree - persons degree (optional)
- firstname - persons first name (always present for persons)
- surname - persons last name (always present for persons)
- company - company name (always present for companies / users of type "P")
- address - default users address specified as Address data type (always present)
- delivery_address_as_default - boolean flag specifying, whether the users delivery address is same as the default one. If false or not present, delivery_address element must be present.
- delivery_address - users delivery address specified as Address data type
- billing_address_as_default - boolean flag specifying, whether the users delivery address is same as the default one. If neither this or billing_address_as_delivery is true, billing_address element must be present.
- billing_address_as_delivery - boolean flag specifying, whether the users delivery address is same as the delivery one. If neither this or billing_address_as_default is true, billing_address element must be present.
- billing_address - users delivery address specified as Address data type
- phones - user phone number(s). Multiple items may be separated by coma.
- fax - users fax number
- mail - user mail address(es)
- ico - company identification number as specified by Czech legislative
- dic - VAT registration number as specified by Czech legislative
- group_dic - group VAT number as specified by Czech legislative
- rc - persons identification number as specified by Czech legislative
- birthday - persons birth date
- mail_info_flag - boolean flag specifying, whether system will send mail notifications to user
- sms_info_flag - boolean flag specifying, whether system will send sms notifications to user
- premises_flag - boolean flag specifying, whether premise management is applied on user
- agreement - users agreement number
- varsym - users bank connection variable symbol
- sipo - users SIPO number
- account_pre_num - users bank account number prefix
- account_num - users bank account number
- account_bank - users account bank
- account_specsym - users bank accounts specific symbol (optional)
- iban - IBAN (users international bank account number)
- note - text note on user (optional)
- note_interval - internal text note on user, displayed in system (optional)
- note_invoice - text note, which will be printed on users invoices (optional)
- billing_plan_ids - ids of billing plans (methods in which user pays for services or products) which user is allowed to use (subset of values received during implementation)
- default_billing_plan_id - id of default billing plan (methods in which user pays for services or products)
- provider_user_id - id of users provider (if not present, default provider is used)
Address complex type:
Address may be specitied as complete UIR address (using ua_id, us_id and uc_id elements) or in textual form. Both textual and UIR form may be present.
- ua_id - UIR address ID (always present for UIR addresses)
- us_id - UIR address street ID
- uc_id - UIR address city ID
- recipient - recipient person name
- street - street name in textual address representation
- house_id - house id number in textual address representation
- city - city name in textual address representation
- zip - ZIP postal code in textual address representation
- country_id - country identification number - 1 for Czech Republic, 2 for Slovakia (always present)
Close
Name: ws_user_create
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_user_createRequest
parts:
session: xsd:string
user: tns:User
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_user_createResponse
parts:
result: xsd:integer
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Create new end user
Method parameters:
- session - operator session token as returned by ws_session_login
- user - end user description as User data type
Returns:
- result - positive integer identification number of user (id) on success
Exceptions:
The method will throw an exception if session token is invalid or expired, any of required field is missing or some of values specified are conflicting.
User complex type:
- active - flag specifying, whether the user will be active (1 active)
- login - users login in system selfcare (optional)
- password - users password in system selfcare (optional)
- password_help_question - password help question for lost password condition in system slefcare (optional)
- password_help_answer - password help answer for lost password condition in system slefcare (optional)
- type - type of user as defined by Czech legislative ("S" = person (private), "F" = natural person, "P" = legal person) (required)
- degree - persons degree (optional)
- firstname - persons first name (required for persons)
- surname - persons last name (required for persons)
- company - company name (required for companies / users of type "P")
- address - default users address specified as Address data type (required)
- delivery_address_as_default - boolean flag specifying, whether the users delivery address is same as the default one. If false or not present, delivery_address element must be present.
- delivery_address - users delivery address specified as Address data type
- billing_address_as_default - boolean flag specifying, whether the users delivery address is same as the default one. If neither this or billing_address_as_delivery is true, billing_address element must be present.
- billing_address_as_delivery - boolean flag specifying, whether the users delivery address is same as the delivery one. If neither this or billing_address_as_default is true, billing_address element must be present.
- billing_address - users delivery address specified as Address data type
- phones - user phone number(s). Multiple items may be separated by coma.
- fax - users fax number
- mail - user mail address(es)
- ico - company identification number as specified by Czech legislative
- dic - VAT registration number as specified by Czech legislative
- group_dic - group VAT number as specified by Czech legislative
- rc - persons identification number as specified by Czech legislative
- birthday - persons birth date
- mail_info_flag - boolean flag specifying, whether system will send mail notifications to user
- sms_info_flag - boolean flag specifying, whether system will send sms notifications to user
- premises_flag - boolean flag specifying, whether premise management is applied on user
- agreement - users agreement number
- varsym - users bank connection variable symbol
- sipo - users SIPO number
- account_pre_num - users bank account number prefix
- account_num - users bank account number
- account_bank - users account bank
- account_specsym - users bank accounts specific symbol (optional)
- iban - IBAN (users international bank account number)
- note - text note on user (optional)
- note_interval - internal text note on user, displayed in system (optional)
- note_invoice - text note, which will be printed on users invoices (optional)
- billing_plan_ids - ids of billing plans (methods in which user pays for services or products) which user is allowed to use (subset of values received during implementation)
- default_billing_plan_id - id of default billing plan (methods in which user pays for services or products)
- provider_user_id - id of users provider (if not present, default provider is used)
Address complex type:
Any address may be specitied either using UIR address id element alone, as complete UIR address (using ua_id, us_id and uc_id elements) or in textual form. Both textual and UIR form may be present.
- ua_id - UIR address ID (required for UIR addresses)
- us_id - UIR address street ID
- uc_id - UIR address city ID
- recipient - recipient person name
- street - street name in textual address representation
- house_id - house id number in textual address representation
- city - city name in textual address representation
- zip - ZIP postal code in textual address representation
- country_id - country identification number - 1 for Czech Republic, 2 for Slovakia (required)
Name: ws_user_create
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_user_createRequest
parts:
session: xsd:string
user: tns:User
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_user_createResponse
parts:
result: xsd:integer
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Create new end user
Method parameters:
- session - operator session token as returned by ws_session_login
- user - end user description as User data type
Returns:
- result - positive integer identification number of user (id) on success
Exceptions:
The method will throw an exception if session token is invalid or expired, any of required field is missing or some of values specified are conflicting.
User complex type:
- active - flag specifying, whether the user will be active (1 active)
- login - users login in system selfcare (optional)
- password - users password in system selfcare (optional)
- password_help_question - password help question for lost password condition in system slefcare (optional)
- password_help_answer - password help answer for lost password condition in system slefcare (optional)
- type - type of user as defined by Czech legislative ("S" = person (private), "F" = natural person, "P" = legal person) (required)
- degree - persons degree (optional)
- firstname - persons first name (required for persons)
- surname - persons last name (required for persons)
- company - company name (required for companies / users of type "P")
- address - default users address specified as Address data type (required)
- delivery_address_as_default - boolean flag specifying, whether the users delivery address is same as the default one. If false or not present, delivery_address element must be present.
- delivery_address - users delivery address specified as Address data type
- billing_address_as_default - boolean flag specifying, whether the users delivery address is same as the default one. If neither this or billing_address_as_delivery is true, billing_address element must be present.
- billing_address_as_delivery - boolean flag specifying, whether the users delivery address is same as the delivery one. If neither this or billing_address_as_default is true, billing_address element must be present.
- billing_address - users delivery address specified as Address data type
- phones - user phone number(s). Multiple items may be separated by coma.
- fax - users fax number
- mail - user mail address(es)
- ico - company identification number as specified by Czech legislative
- dic - VAT registration number as specified by Czech legislative
- group_dic - group VAT number as specified by Czech legislative
- rc - persons identification number as specified by Czech legislative
- birthday - persons birth date
- mail_info_flag - boolean flag specifying, whether system will send mail notifications to user
- sms_info_flag - boolean flag specifying, whether system will send sms notifications to user
- premises_flag - boolean flag specifying, whether premise management is applied on user
- agreement - users agreement number
- varsym - users bank connection variable symbol
- sipo - users SIPO number
- account_pre_num - users bank account number prefix
- account_num - users bank account number
- account_bank - users account bank
- account_specsym - users bank accounts specific symbol (optional)
- iban - IBAN (users international bank account number)
- note - text note on user (optional)
- note_interval - internal text note on user, displayed in system (optional)
- note_invoice - text note, which will be printed on users invoices (optional)
- billing_plan_ids - ids of billing plans (methods in which user pays for services or products) which user is allowed to use (subset of values received during implementation)
- default_billing_plan_id - id of default billing plan (methods in which user pays for services or products)
- provider_user_id - id of users provider (if not present, default provider is used)
Address complex type:
Any address may be specitied either using UIR address id element alone, as complete UIR address (using ua_id, us_id and uc_id elements) or in textual form. Both textual and UIR form may be present.
- ua_id - UIR address ID (required for UIR addresses)
- us_id - UIR address street ID
- uc_id - UIR address city ID
- recipient - recipient person name
- street - street name in textual address representation
- house_id - house id number in textual address representation
- city - city name in textual address representation
- zip - ZIP postal code in textual address representation
- country_id - country identification number - 1 for Czech Republic, 2 for Slovakia (required)
Close
Name: ws_user_edit
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_user_editRequest
parts:
session: xsd:string
user: tns:User
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_user_editResponse
parts:
result: xsd:integer
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Edit end user specified by id. Fields omitted in user parameter will be left unchanged.
Method parameters:
- session - operator session token as returned by ws_session_login
- user - end user description as User data type
Returns:
- result - non-zero positive integer on success
Exceptions:
The method will throw an exception if session token is invalid or expired, if end user with id specified does not exist or is not accessible, any of required field is missing or some of values specified are conflicting.
User complex type:
- id - unique identification integer number of the user to be edited (required)
- active - flag specifying, whether the user is active (1 active, 0 temporarily inactive, -1 permanently inactive)
- login - users login in system selfcare (optional)
- password - users password in system selfcare (optional)
- password_help_question - password help question for lost password condition in system slefcare (optional)
- password_help_answer - password help answer for lost password condition in system slefcare (optional)
- type - type of user as defined by Czech legislative ("S" = person (private), "F" = natural person, "P" = legal person) (required)
- degree - persons degree (optional)
- firstname - persons first name (required for persons)
- surname - persons last name (required for persons)
- company - company name (required for companies / users of type "P")
- address - default users address specified as Address data type (required)
- delivery_address_as_default - boolean flag specifying, whether the users delivery address is same as the default one. If false or not present, delivery_address element must be present.
- delivery_address - users delivery address specified as Address data type
- billing_address_as_default - boolean flag specifying, whether the users delivery address is same as the default one. If neither this or billing_address_as_delivery is true, billing_address element must be present.
- billing_address_as_delivery - boolean flag specifying, whether the users delivery address is same as the delivery one. If neither this or billing_address_as_default is true, billing_address element must be present.
- billing_address - users delivery address specified as Address data type
- phones - user phone number(s). Multiple items may be separated by coma.
- fax - users fax number
- mail - user mail address(es)
- ico - company identification number as specified by Czech legislative
- dic - VAT registration number as specified by Czech legislative
- group_dic - group VAT number as specified by Czech legislative
- rc - persons identification number as specified by Czech legislative
- birthday - persons birth date
- mail_info_flag - boolean flag specifying, whether system will send mail notifications to user
- sms_info_flag - boolean flag specifying, whether system will send sms notifications to user
- premises_flag - boolean flag specifying, whether premise management is applied on user
- agreement - users agreement number
- varsym - users bank connection variable symbol
- sipo - users SIPO number
- account_pre_num - users bank account number prefix
- account_num - users bank account number
- account_bank - users account bank
- account_specsym - users bank accounts specific symbol (optional)
- iban - IBAN (users international bank account number)
- note - text note on user (optional)
- note_interval - internal text note on user, displayed in system (optional)
- note_invoice - text note, which will be printed on users invoices (optional)
- billing_plan_ids - ids of billing plans (methods in which user pays for services or products) which user is allowed to use (subset of values received during implementation)
- default_billing_plan_id - id of default billing plan (methods in which user pays for services or products)
- provider_user_id - id of users provider (if not present, default provider is used)
- marketing_info_flag - flag to enable marketing ifnormation beeing sent to thi customer
Address complex type:
Any address may be specitied either using UIR address id element alone, as complete UIR address (using ua_id, us_id and uc_id elements) or in textual form. Both textual and UIR form may be present.
- ua_id - UIR address ID (required for UIR addresses)
- us_id - UIR address street ID
- uc_id - UIR address city ID
- recipient - recipient person name
- street - street name in textual address representation
- house_id - house id number in textual address representation
- city - city name in textual address representation
- zip - ZIP postal code in textual address representation
- country_id - country identification number - 1 for Czech Republic, 2 for Slovakia (required)
Name: ws_user_edit
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_user_editRequest
parts:
session: xsd:string
user: tns:User
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_user_editResponse
parts:
result: xsd:integer
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Edit end user specified by id. Fields omitted in user parameter will be left unchanged.
Method parameters:
- session - operator session token as returned by ws_session_login
- user - end user description as User data type
Returns:
- result - non-zero positive integer on success
Exceptions:
The method will throw an exception if session token is invalid or expired, if end user with id specified does not exist or is not accessible, any of required field is missing or some of values specified are conflicting.
User complex type:
- id - unique identification integer number of the user to be edited (required)
- active - flag specifying, whether the user is active (1 active, 0 temporarily inactive, -1 permanently inactive)
- login - users login in system selfcare (optional)
- password - users password in system selfcare (optional)
- password_help_question - password help question for lost password condition in system slefcare (optional)
- password_help_answer - password help answer for lost password condition in system slefcare (optional)
- type - type of user as defined by Czech legislative ("S" = person (private), "F" = natural person, "P" = legal person) (required)
- degree - persons degree (optional)
- firstname - persons first name (required for persons)
- surname - persons last name (required for persons)
- company - company name (required for companies / users of type "P")
- address - default users address specified as Address data type (required)
- delivery_address_as_default - boolean flag specifying, whether the users delivery address is same as the default one. If false or not present, delivery_address element must be present.
- delivery_address - users delivery address specified as Address data type
- billing_address_as_default - boolean flag specifying, whether the users delivery address is same as the default one. If neither this or billing_address_as_delivery is true, billing_address element must be present.
- billing_address_as_delivery - boolean flag specifying, whether the users delivery address is same as the delivery one. If neither this or billing_address_as_default is true, billing_address element must be present.
- billing_address - users delivery address specified as Address data type
- phones - user phone number(s). Multiple items may be separated by coma.
- fax - users fax number
- mail - user mail address(es)
- ico - company identification number as specified by Czech legislative
- dic - VAT registration number as specified by Czech legislative
- group_dic - group VAT number as specified by Czech legislative
- rc - persons identification number as specified by Czech legislative
- birthday - persons birth date
- mail_info_flag - boolean flag specifying, whether system will send mail notifications to user
- sms_info_flag - boolean flag specifying, whether system will send sms notifications to user
- premises_flag - boolean flag specifying, whether premise management is applied on user
- agreement - users agreement number
- varsym - users bank connection variable symbol
- sipo - users SIPO number
- account_pre_num - users bank account number prefix
- account_num - users bank account number
- account_bank - users account bank
- account_specsym - users bank accounts specific symbol (optional)
- iban - IBAN (users international bank account number)
- note - text note on user (optional)
- note_interval - internal text note on user, displayed in system (optional)
- note_invoice - text note, which will be printed on users invoices (optional)
- billing_plan_ids - ids of billing plans (methods in which user pays for services or products) which user is allowed to use (subset of values received during implementation)
- default_billing_plan_id - id of default billing plan (methods in which user pays for services or products)
- provider_user_id - id of users provider (if not present, default provider is used)
- marketing_info_flag - flag to enable marketing ifnormation beeing sent to thi customer
Address complex type:
Any address may be specitied either using UIR address id element alone, as complete UIR address (using ua_id, us_id and uc_id elements) or in textual form. Both textual and UIR form may be present.
- ua_id - UIR address ID (required for UIR addresses)
- us_id - UIR address street ID
- uc_id - UIR address city ID
- recipient - recipient person name
- street - street name in textual address representation
- house_id - house id number in textual address representation
- city - city name in textual address representation
- zip - ZIP postal code in textual address representation
- country_id - country identification number - 1 for Czech Republic, 2 for Slovakia (required)
Close
Name: ws_user_param_edit
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_user_param_editRequest
parts:
session: xsd:string
user_id: xsd:int
par_name: xsd:string
par_value: xsd:string
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_user_param_editResponse
parts:
result: xsd:integer
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Target for this service is to be able modify values of user's parametres.
Method parameters:
- session - operator session token as returned by ws_session_login
- user_id - end user description
- par_name - parametres name
- par_value - parametres value
Returns:
- result - non-zero positive integer on success
Exceptions:
The method will throw an exception if session token is invalid or expired, if end user with id specified does not exist or is not accessible, any of required field is missing or some of values specified are conflicting.
Name: ws_user_param_edit
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_user_param_editRequest
parts:
session: xsd:string
user_id: xsd:int
par_name: xsd:string
par_value: xsd:string
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_user_param_editResponse
parts:
result: xsd:integer
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Target for this service is to be able modify values of user's parametres.
Method parameters:
- session - operator session token as returned by ws_session_login
- user_id - end user description
- par_name - parametres name
- par_value - parametres value
Returns:
- result - non-zero positive integer on success
Exceptions:
The method will throw an exception if session token is invalid or expired, if end user with id specified does not exist or is not accessible, any of required field is missing or some of values specified are conflicting.
Close
Name: ws_product_update
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_product_updateRequest
parts:
session: xsd:string
sn_id: xsd:int
sn_code: xsd:string
class: xsd:int
group: xsd:string
name: xsd:string
vat_rate: xsd:string
unit: xsd:string
common_unit: xsd:string
package_size: xsd:string
active: xsd:boolean
price: xsd:float
price_list: xsd:string
premiseAvailType: xsd:string
premise_list: xsd:string
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_product_updateResponse
parts:
result: xsd:int
result_message: xsd:string
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Create (or edit existing) product and set base parameters. The product can be identified either by its internal ID, or using its unique code.
If there is no product identification, the system always creates a new product.
Requested user rights: SERVICES_LIST.INSERT and SERVICES_LIST.EDIT
Function parameters:
- session - Operator session
- sn_id - Product ID (CIBS Internal) (must be filled in if the ID is missing)
- sn_code - Product code (must be filled in if the ID is missing)
- class - Product class
- group - Product Category. More category must be separated by commas. For example 101010,101015
- name - Product name
- vat_rate - VAT rate code. Values: BASE | LOW | LOW2 | NONE ( Currently, the rates in CZ 1.1.2015 are: 21% | 15% | 10% | 0% )
- unit - unit of Measure
- common_unit - standard unit of Measure
- package_size - weight, quantity, volume, size of package
- active - global product availability
- price (with VAT)
- price_list (JSON array)
- premiseAvailType ( all, selected )
- premise_list
- Price list is JSON encoded array in format:
{"455":{"PRICE":{"1":"50;0;0", "9":"50;0;0", "10":"40;0;1", "9999999":"40;0;0"}}}
corresponds to the order:
455 - Numeric code of premise
PRICE - Price with vat
1 - Quantity
50 - Cost of materials
0 - Price appreciation
0 - Indication price action (0/1)
etc...
Name: ws_product_update
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_product_updateRequest
parts:
session: xsd:string
sn_id: xsd:int
sn_code: xsd:string
class: xsd:int
group: xsd:string
name: xsd:string
vat_rate: xsd:string
unit: xsd:string
common_unit: xsd:string
package_size: xsd:string
active: xsd:boolean
price: xsd:float
price_list: xsd:string
premiseAvailType: xsd:string
premise_list: xsd:string
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_product_updateResponse
parts:
result: xsd:int
result_message: xsd:string
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Create (or edit existing) product and set base parameters. The product can be identified either by its internal ID, or using its unique code.
If there is no product identification, the system always creates a new product.
Requested user rights: SERVICES_LIST.INSERT and SERVICES_LIST.EDIT
Function parameters:
- session - Operator session
- sn_id - Product ID (CIBS Internal) (must be filled in if the ID is missing)
- sn_code - Product code (must be filled in if the ID is missing)
- class - Product class
- group - Product Category. More category must be separated by commas. For example 101010,101015
- name - Product name
- vat_rate - VAT rate code. Values: BASE | LOW | LOW2 | NONE ( Currently, the rates in CZ 1.1.2015 are: 21% | 15% | 10% | 0% )
- unit - unit of Measure
- common_unit - standard unit of Measure
- package_size - weight, quantity, volume, size of package
- active - global product availability
- price (with VAT)
- price_list (JSON array)
- premiseAvailType ( all, selected )
- premise_list
- Price list is JSON encoded array in format:
{"455":{"PRICE":{"1":"50;0;0", "9":"50;0;0", "10":"40;0;1", "9999999":"40;0;0"}}}
corresponds to the order:
455 - Numeric code of premise
PRICE - Price with vat
1 - Quantity
50 - Cost of materials
0 - Price appreciation
0 - Indication price action (0/1)
etc...
Close
Name: ws_product_param_set
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_product_param_setRequest
parts:
session: xsd:string
sn_id: xsd:int
sn_code: xsd:string
param_name: xsd:string
param_value: xsd:string
file_content: xsd:string
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_product_param_setResponse
parts:
result: xsd:int
result_message: xsd:string
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Set parameters for existing product.
Function parameters:
- session - Operator session
- sn_id - Product ID (CIBS Internal) (must be filled in if the ID is missing)
- sn_code - Product code (must be filled in if the ID is missing)
- param_name - Parameter name
- param_value - Parameter value. Filename for FILE parameters
- file_content - base64 file data
Name: ws_product_param_set
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_product_param_setRequest
parts:
session: xsd:string
sn_id: xsd:int
sn_code: xsd:string
param_name: xsd:string
param_value: xsd:string
file_content: xsd:string
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_product_param_setResponse
parts:
result: xsd:int
result_message: xsd:string
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Set parameters for existing product.
Function parameters:
- session - Operator session
- sn_id - Product ID (CIBS Internal) (must be filled in if the ID is missing)
- sn_code - Product code (must be filled in if the ID is missing)
- param_name - Parameter name
- param_value - Parameter value. Filename for FILE parameters
- file_content - base64 file data
Close
Name: ws_product_list_get
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_product_list_getRequest
parts:
session: xsd:string
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_product_list_getResponse
parts:
result: xsd:int
result_message: xsd:string
data: xsd:string
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Get list of products
Function parameters:
- session - Operator session
Returns:
data - JSON array of products:
SN_ID - Product ID (CIBS Internal)
SN_CODE - Product code
CLASS - product class
GROUP - Product group. The first three digits correspond to the three levels of groups
NAME - Product name
VAT_RATE - VAT rate code. Values: BASE | LOW | LOW2 | NONE ( Currently, the rates in CZ 1.1.2015 are: 21% | 15% | 10% | 0% )
UNIT - unit of Measure
COMMON_UNIT - standard unit of Measure
ACTIVE - global product availability
STOCK - Stocka state (count)
PRICE_LIST - Price list is JSON encoded array in format:
{"455":{"PRICE":{"1":"50;0;0", "9":"50;0;0", "10":"40;0;1", "9999999":"40;0;0"}}}
PREMISE_AVAIL_TYPE - value all, selected
SN_PRICE - product price
SN_PRICE_CALC - value LOC_PRICE, UNIT, CALCULATION
corresponds to the order:
455 - Numeric code of premise
PRICE - Price with vat
1 - Quantity
50 - Cost of materials
0 - Price appreciation
0 - Indication price action (0/1)
etc...
PARAMS - Product params in JSON encoded array. For file parameters array contains keys in form {param_name}_md5 with values containing md5 sum of file
Name: ws_product_list_get
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_product_list_getRequest
parts:
session: xsd:string
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_product_list_getResponse
parts:
result: xsd:int
result_message: xsd:string
data: xsd:string
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Get list of products
Function parameters:
- session - Operator session
Returns:
data - JSON array of products:
SN_ID - Product ID (CIBS Internal)
SN_CODE - Product code
CLASS - product class
GROUP - Product group. The first three digits correspond to the three levels of groups
NAME - Product name
VAT_RATE - VAT rate code. Values: BASE | LOW | LOW2 | NONE ( Currently, the rates in CZ 1.1.2015 are: 21% | 15% | 10% | 0% )
UNIT - unit of Measure
COMMON_UNIT - standard unit of Measure
ACTIVE - global product availability
STOCK - Stocka state (count)
PRICE_LIST - Price list is JSON encoded array in format:
{"455":{"PRICE":{"1":"50;0;0", "9":"50;0;0", "10":"40;0;1", "9999999":"40;0;0"}}}
PREMISE_AVAIL_TYPE - value all, selected
SN_PRICE - product price
SN_PRICE_CALC - value LOC_PRICE, UNIT, CALCULATION
corresponds to the order:
455 - Numeric code of premise
PRICE - Price with vat
1 - Quantity
50 - Cost of materials
0 - Price appreciation
0 - Indication price action (0/1)
etc...
PARAMS - Product params in JSON encoded array. For file parameters array contains keys in form {param_name}_md5 with values containing md5 sum of file
Close
Name: ws_product_personalized_list
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_product_personalized_listRequest
parts:
session: xsd:string
search: tns:ProductPersonalizedSearch
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_product_personalized_listResponse
parts:
result: tns:ProductPersonalizedList
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Returns list of personalized products of an user matching specified search parameters.
Method parameters:
- session - operator session token as returned by ws_session_login
- search - search parameters specified as instance of ProductPersonalizedSearch data type.
Returns:
- result - list of personalized products as ProductPersonalized data type
Exceptions:
The method will throw an exception if session token is invalid or expired, required search parameter is missing or invalid value is used for it.
ProductPersonalizedSearch complex type:
- user_id - end user owning the personalized product (required)
- id - unique integer identifier of personalized product (optional)
- name - personalized product name (optional)
- type - type of personalized product as ProductPersonalizedType data type
- product_definition_id - product definition id (accessible in "Produkty a služby" module in CIBS backoffice)
ProductPersonalizedType simple type:
Value may be one of:
- ORDER - for products which are to be used as order item
- ENQUIRY - for products to be used as item in enquiry
- OFFER - for products to be used as item in an offer (in response to enquiry)
- ALL
- USER
- UNKNOWN
ProductPersonalized complex type:
- id - unique integer identifier of personalized product (always present)
- name - personalized product name (always present)
- product_definition_id - product definition id (accessible in "Produkty a služby" module in CIBS backoffice) (always present)
- type - type of personalized product as ProductPersonalizedType data type (always present)
- copy_of - id of personalized product used as template for current product (eg. of product in enquiry from which an offer was created) (optional)
- user_id - id of the end user, who owns personalized product (always present)
- params - personalized product parameters as ParamList data type
- price_base - base price (may be with or without VAT depending on configured price calculation type)
- price - total price
- price_wo_vat - total price without VAT
- m_price - material price
- v_price - valuation price
- reward - reward for ordering product
ParamList complex type:
Zero or more elements of Param data type.
Param complex type:
- name - parameter name
- value - parameter value
Name: ws_product_personalized_list
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_product_personalized_listRequest
parts:
session: xsd:string
search: tns:ProductPersonalizedSearch
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_product_personalized_listResponse
parts:
result: tns:ProductPersonalizedList
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Returns list of personalized products of an user matching specified search parameters.
Method parameters:
- session - operator session token as returned by ws_session_login
- search - search parameters specified as instance of ProductPersonalizedSearch data type.
Returns:
- result - list of personalized products as ProductPersonalized data type
Exceptions:
The method will throw an exception if session token is invalid or expired, required search parameter is missing or invalid value is used for it.
ProductPersonalizedSearch complex type:
- user_id - end user owning the personalized product (required)
- id - unique integer identifier of personalized product (optional)
- name - personalized product name (optional)
- type - type of personalized product as ProductPersonalizedType data type
- product_definition_id - product definition id (accessible in "Produkty a služby" module in CIBS backoffice)
ProductPersonalizedType simple type:
Value may be one of:
- ORDER - for products which are to be used as order item
- ENQUIRY - for products to be used as item in enquiry
- OFFER - for products to be used as item in an offer (in response to enquiry)
- ALL
- USER
- UNKNOWN
ProductPersonalized complex type:
- id - unique integer identifier of personalized product (always present)
- name - personalized product name (always present)
- product_definition_id - product definition id (accessible in "Produkty a služby" module in CIBS backoffice) (always present)
- type - type of personalized product as ProductPersonalizedType data type (always present)
- copy_of - id of personalized product used as template for current product (eg. of product in enquiry from which an offer was created) (optional)
- user_id - id of the end user, who owns personalized product (always present)
- params - personalized product parameters as ParamList data type
- price_base - base price (may be with or without VAT depending on configured price calculation type)
- price - total price
- price_wo_vat - total price without VAT
- m_price - material price
- v_price - valuation price
- reward - reward for ordering product
ParamList complex type:
Zero or more elements of Param data type.
Param complex type:
- name - parameter name
- value - parameter value
Close
Name: ws_product_personalized_create
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_product_personalized_createRequest
parts:
session: xsd:string
personalized_product: tns:ProductPersonalized
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_product_personalized_createResponse
parts:
result: xsd:integer
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Creates new personalized product
Method parameters:
- session - operator session token as returned by ws_session_login
- personalized_product - product description as ProductPersonalized data type
Returns:
- result - nonzero positive integer unique identifier or created personalized product on success
Exceptions:
The method will throw an exception if session token is invalid or expired, operator cannot create personalized product or personalized product description supplied is invalid.
ProductPersonalized complex type:
- name - personalized product name (required)
- product_definition_id - product definition id (accessible in "Produkty a služby" module in CIBS backoffice) (required)
- type - type of personalized product as ProductPersonalizedType data type (required)
- copy_of - id of personalized product used as template for current product (eg. of product in enquiry from which an offer was created) (optional)
- user_id - id of the end user, who owns personalized product (required)
- params - personalized product parameters as ParamList data type
- price_base - base price (may be with or without VAT depending on configured price calculation type) (optional, ignored for types other then OFFER)
- price - total price (optional, ignored for types other then OFFER and ENQUIRY)
- price_wo_vat - total price without VAT (optional, ignored for types other then OFFER and ENQUIRY)
- m_price - material price (optional, ignored for types other then OFFER)
- v_price - valuation price (optional, ignored for types other then OFFER)
- reward - reward for ordering product (optional, ignored for type ORDER)
ProductPersonalizedType simple type:
Value may be one of:
- ORDER - for products which are to be used as order item
- ENQUIRY - for products to be used as item in enquiry
- OFFER - for products to be used as item in an offer (in response to enquiry)
- ALL
- USER
- UNKNOWN
ParamList complex type:
Zero or more elements of Param data type.
Param complex type:
- name - parameter name (required)
- value - parameter value (required)
Name: ws_product_personalized_create
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_product_personalized_createRequest
parts:
session: xsd:string
personalized_product: tns:ProductPersonalized
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_product_personalized_createResponse
parts:
result: xsd:integer
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Creates new personalized product
Method parameters:
- session - operator session token as returned by ws_session_login
- personalized_product - product description as ProductPersonalized data type
Returns:
- result - nonzero positive integer unique identifier or created personalized product on success
Exceptions:
The method will throw an exception if session token is invalid or expired, operator cannot create personalized product or personalized product description supplied is invalid.
ProductPersonalized complex type:
- name - personalized product name (required)
- product_definition_id - product definition id (accessible in "Produkty a služby" module in CIBS backoffice) (required)
- type - type of personalized product as ProductPersonalizedType data type (required)
- copy_of - id of personalized product used as template for current product (eg. of product in enquiry from which an offer was created) (optional)
- user_id - id of the end user, who owns personalized product (required)
- params - personalized product parameters as ParamList data type
- price_base - base price (may be with or without VAT depending on configured price calculation type) (optional, ignored for types other then OFFER)
- price - total price (optional, ignored for types other then OFFER and ENQUIRY)
- price_wo_vat - total price without VAT (optional, ignored for types other then OFFER and ENQUIRY)
- m_price - material price (optional, ignored for types other then OFFER)
- v_price - valuation price (optional, ignored for types other then OFFER)
- reward - reward for ordering product (optional, ignored for type ORDER)
ProductPersonalizedType simple type:
Value may be one of:
- ORDER - for products which are to be used as order item
- ENQUIRY - for products to be used as item in enquiry
- OFFER - for products to be used as item in an offer (in response to enquiry)
- ALL
- USER
- UNKNOWN
ParamList complex type:
Zero or more elements of Param data type.
Param complex type:
- name - parameter name (required)
- value - parameter value (required)
Close
Name: ws_product_personalized_delete
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_product_personalized_deleteRequest
parts:
session: xsd:string
personalized_product_id: xsd:integer
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_product_personalized_deleteResponse
parts:
result: xsd:integer
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Deletes a personalized product
Method parameters:
- session - operator session token as returned by ws_session_login
- personalized_product_id - unique identifier of the personalized product
Returns:
- result - nonzero positive integer on success
Exceptions:
The method will throw an exception if session token is invalid or expired, personalized product specified does not exist or figures as an item in an existing order, offer or enquiry (it must be removed before deletion)
Name: ws_product_personalized_delete
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_product_personalized_deleteRequest
parts:
session: xsd:string
personalized_product_id: xsd:integer
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_product_personalized_deleteResponse
parts:
result: xsd:integer
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Deletes a personalized product
Method parameters:
- session - operator session token as returned by ws_session_login
- personalized_product_id - unique identifier of the personalized product
Returns:
- result - nonzero positive integer on success
Exceptions:
The method will throw an exception if session token is invalid or expired, personalized product specified does not exist or figures as an item in an existing order, offer or enquiry (it must be removed before deletion)
Close
Name: ws_product_linkage_create
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_product_linkage_createRequest
parts:
session: xsd:string
product_linkage_create: tns:products_linkage
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_product_linkage_createResponse
parts:
result: xsd:int
result_message: xsd:string
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Documentation: Create new dependency
Function parameters:
- session - Operator session
- product_linkage_create ( array( // elements = array ( name = array(name=>'',type=>'') )
'code' => array('name' => 'code', 'type' => 'xsd:string') -- Product code base service
, 'code_linked' => array('name' => 'code_linked', 'type' => 'xsd:string') -- Product code dependency service
))
Name: ws_product_linkage_create
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_product_linkage_createRequest
parts:
session: xsd:string
product_linkage_create: tns:products_linkage
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_product_linkage_createResponse
parts:
result: xsd:int
result_message: xsd:string
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Documentation: Create new dependency
Function parameters:
- session - Operator session
- product_linkage_create ( array( // elements = array ( name = array(name=>'',type=>'') )
'code' => array('name' => 'code', 'type' => 'xsd:string') -- Product code base service
, 'code_linked' => array('name' => 'code_linked', 'type' => 'xsd:string') -- Product code dependency service
))
Close
Name: ws_product_linkage_delete
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_product_linkage_deleteRequest
parts:
session: xsd:string
product_linkage_delete: tns:products_linkage
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_product_linkage_deleteResponse
parts:
result: xsd:int
result_message: xsd:string
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Documentation: Delete dependency
Function parameters:
- session - Operator session
- product_linkage_delete ( array( // elements = array ( name = array(name=>'',type=>'') )
'code' => array('name' => 'code', 'type' => 'xsd:string') -- Product code base service
, 'code_linked' => array('name' => 'code_linked', 'type' => 'xsd:string') -- Product code dependency service
))
Name: ws_product_linkage_delete
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_product_linkage_deleteRequest
parts:
session: xsd:string
product_linkage_delete: tns:products_linkage
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_product_linkage_deleteResponse
parts:
result: xsd:int
result_message: xsd:string
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Documentation: Delete dependency
Function parameters:
- session - Operator session
- product_linkage_delete ( array( // elements = array ( name = array(name=>'',type=>'') )
'code' => array('name' => 'code', 'type' => 'xsd:string') -- Product code base service
, 'code_linked' => array('name' => 'code_linked', 'type' => 'xsd:string') -- Product code dependency service
))
Close
Name: ws_product_linkage_list_get
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_product_linkage_list_getRequest
parts:
session: xsd:string
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_product_linkage_list_getResponse
parts:
result: xsd:int
result_message: xsd:string
product_linked_list: tns:products_linkage
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Get list of services_name_fixed_dependencies
Function parameters:
- session - Operator session
code - Product code
code_linked - Product linked code
name - Product name
name_linked - Product linked name
Name: ws_product_linkage_list_get
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_product_linkage_list_getRequest
parts:
session: xsd:string
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_product_linkage_list_getResponse
parts:
result: xsd:int
result_message: xsd:string
product_linked_list: tns:products_linkage
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Get list of services_name_fixed_dependencies
Function parameters:
- session - Operator session
code - Product code
code_linked - Product linked code
name - Product name
name_linked - Product linked name
Close
Name: ws_product_coupon_create
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_product_coupon_createRequest
parts:
session: xsd:string
product_coupon_create: tns:products_coupon
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_product_coupon_createResponse
parts:
result: xsd:int
result_message: xsd:string
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Documentation: Vytvoří se nové kupony, před tím se smažou všechny vytvořené doposud
Function parameters:
- session - Operator session
- product_coupon_create ( array( // elements = array ( name = array(name=>'',type=>'') )
'coupon_name' => array('name' => 'coupon_name', 'type' => 'xsd:string') -- Název kuponu
, 'coupon_count' => array('name' => 'coupon_count', 'type' => 'xsd:int') -- Množství
, 'coupon_price' => array('name' => 'coupon_price', 'type' => 'xsd:decimal') -- Cena
, 'coupon_product_code_list' => array('name' => 'coupon_product_code', 'type' => 'tns:coupon_product_code_list')
))
- product_coupon_code_list'
( 'coupon_product_code' => array( 'type' => 'xsd:string', 'minOccurs'=>1, 'maxOccurs'=>1 )
Name: ws_product_coupon_create
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_product_coupon_createRequest
parts:
session: xsd:string
product_coupon_create: tns:products_coupon
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_product_coupon_createResponse
parts:
result: xsd:int
result_message: xsd:string
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Documentation: Vytvoří se nové kupony, před tím se smažou všechny vytvořené doposud
Function parameters:
- session - Operator session
- product_coupon_create ( array( // elements = array ( name = array(name=>'',type=>'') )
'coupon_name' => array('name' => 'coupon_name', 'type' => 'xsd:string') -- Název kuponu
, 'coupon_count' => array('name' => 'coupon_count', 'type' => 'xsd:int') -- Množství
, 'coupon_price' => array('name' => 'coupon_price', 'type' => 'xsd:decimal') -- Cena
, 'coupon_product_code_list' => array('name' => 'coupon_product_code', 'type' => 'tns:coupon_product_code_list')
))
- product_coupon_code_list'
( 'coupon_product_code' => array( 'type' => 'xsd:string', 'minOccurs'=>1, 'maxOccurs'=>1 )
Close
Name: ws_config_set
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_config_setRequest
parts:
session: xsd:string
config_name: xsd:string
config_value: xsd:string
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_config_setResponse
parts:
result: xsd:int
result_message: xsd:string
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Set config value
Configuration settings can be set only with permission XXX. The permission value is identical to the configuration name.
Function parameters:
- session - Operator session
- config_name - Config name
- config_value - Config value
Name: ws_config_set
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_config_setRequest
parts:
session: xsd:string
config_name: xsd:string
config_value: xsd:string
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_config_setResponse
parts:
result: xsd:int
result_message: xsd:string
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Set config value
Configuration settings can be set only with permission XXX. The permission value is identical to the configuration name.
Function parameters:
- session - Operator session
- config_name - Config name
- config_value - Config value
Close
Name: ws_shop_stock_sync
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_shop_stock_syncRequest
parts:
session: xsd:string
stock_update: tns:stock_products
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_shop_stock_syncResponse
parts:
result: xsd:int
result_message: xsd:string
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Sync stock state
Function parameters:
- session - Operator session
- stock_update ( array( // elements = array ( name = array(name=>'',type=>'') )
'code' => array('name' => 'code', 'type' => 'xsd:string')
, 'count' => array('name' => 'count', 'type' => 'xsd:int')
, 'order' => array('name' => 'order', 'type' => 'xsd:int')
))
Name: ws_shop_stock_sync
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_shop_stock_syncRequest
parts:
session: xsd:string
stock_update: tns:stock_products
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_shop_stock_syncResponse
parts:
result: xsd:int
result_message: xsd:string
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Sync stock state
Function parameters:
- session - Operator session
- stock_update ( array( // elements = array ( name = array(name=>'',type=>'') )
'code' => array('name' => 'code', 'type' => 'xsd:string')
, 'count' => array('name' => 'count', 'type' => 'xsd:int')
, 'order' => array('name' => 'order', 'type' => 'xsd:int')
))
Close
Name: ws_shop_stock_correct
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_shop_stock_correctRequest
parts:
session: xsd:string
stock_correction: tns:stock_products
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_shop_stock_correctResponse
parts:
result: xsd:int
result_message: xsd:string
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Correct stock_correction.
Function parameters:
- session - Operator session
- stock_correct ( array( // elements = array ( name = array(name=>'',type=>'') )
'code' => array('name' => 'code', 'type' => 'xsd:string')
, 'count' => array('name' => 'count', 'type' => 'xsd:int')
, 'order' => array('name' => 'order', 'type' => 'xsd:int')
))
Name: ws_shop_stock_correct
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_shop_stock_correctRequest
parts:
session: xsd:string
stock_correction: tns:stock_products
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_shop_stock_correctResponse
parts:
result: xsd:int
result_message: xsd:string
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Correct stock_correction.
Function parameters:
- session - Operator session
- stock_correct ( array( // elements = array ( name = array(name=>'',type=>'') )
'code' => array('name' => 'code', 'type' => 'xsd:string')
, 'count' => array('name' => 'count', 'type' => 'xsd:int')
, 'order' => array('name' => 'order', 'type' => 'xsd:int')
))
Close
Name: ws_order_coverage
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_order_coverageRequest
parts:
session: xsd:string
order_id: xsd:int
coverage: xsd:string
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_order_coverageResponse
parts:
result: xsd:int
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Order coverage
Function parameters:
- session - Operator session
- order_id - ID
- coverage (JSON array)
Order coverage is JSON encoded array in format
XXX1 =>
REG => Product code
COUNT => Covered count
PRICE => Product price
BASE => Base product
XXX1 =>
REG => ...
COUNT=> ...
PRICE=> ...
BASE=> ...
...
XXX = order product, format without restrictions
Name: ws_order_coverage
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_order_coverageRequest
parts:
session: xsd:string
order_id: xsd:int
coverage: xsd:string
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_order_coverageResponse
parts:
result: xsd:int
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Order coverage
Function parameters:
- session - Operator session
- order_id - ID
- coverage (JSON array)
Order coverage is JSON encoded array in format
XXX1 =>
REG => Product code
COUNT => Covered count
PRICE => Product price
BASE => Base product
XXX1 =>
REG => ...
COUNT=> ...
PRICE=> ...
BASE=> ...
...
XXX = order product, format without restrictions
Close
Name: ws_order_prepare
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_order_prepareRequest
parts:
session: xsd:string
order_id: xsd:int
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_order_prepareResponse
parts:
result: xsd:int
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Order prepare
Function parameters:
- session - Operator session
- order_id - ID
Name: ws_order_prepare
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_order_prepareRequest
parts:
session: xsd:string
order_id: xsd:int
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_order_prepareResponse
parts:
result: xsd:int
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Order prepare
Function parameters:
- session - Operator session
- order_id - ID
Close
Name: ws_order_close
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_order_closeRequest
parts:
session: xsd:string
order_id: xsd:int
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_order_closeResponse
parts:
result: xsd:int
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Order close
Function parameters:
- session - Operator session
- order_id - ID
Name: ws_order_close
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_order_closeRequest
parts:
session: xsd:string
order_id: xsd:int
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_order_closeResponse
parts:
result: xsd:int
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Order close
Function parameters:
- session - Operator session
- order_id - ID
Close
Name: ws_orders_list
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_orders_listRequest
parts:
session: xsd:string
search: tns:OrderSearch
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_orders_listResponse
parts:
result: tns:OrdersList
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Returns list of orders of an user matching specified search parameters.
Method parameters:
- session - operator session token as returned by ws_session_login
- search - search parameters specified as instance of ProductPersonalizedSearch data type.
Returns:
- result - list of orders as Order data type
Exceptions:
The method will throw an exception if session token is invalid or expired, required search parameter is missing or an invalid value is used for it.
OrderSearch complex type:
- up_user_id - required integer id of premise user
- id - unique integer identifier of the order (optional)
- user_id - unique integer identifier of the user (optional)
- up_id - unique integer identifier of the premise (optional)
- up_ident - number of the premise (optional)
- date_realization_from - date of order - from (optional)
- date_realization_to - date of order - to (optional)
- state - order state as OrderState data type (optional)
OrderState simple type:
Value may be one of: 'ACCEPT', 'REALIZATION', 'WAITING_FOR_PAYMENT', 'STORNO', 'DONE', 'EXPEDICE', 'PREPARE'.
Order complex type:
- id - unique order identification number
- state - order state as OrderState data type
- order_number - number of order
- date_filing - date of acceptation
- date_order - date of creation
- user_id - end user, to whoom the order belongs (required)
- user_name - end user name, to whoom the order belongs
- node_id - network node (bulk device) associated with order (optional)
- dealer - id of operator, who create the order
- crm_channel - code of CRM channel, by that the order was created (eg. 2 for telephonic order) (optional)
- note - order note (optional)
- reference_number - order identifier in an external system (optional)
- ct - number of location
- created - creation date of the order
- creator - creator of the order
- wizard - flag indicating that order was created in CIBS system frontends wizard (optional)
- transport_service_id - code of transport service (eg. 1 for PPL) (optional)
- billing_plan_id - billing blan id (code for way of checkout) (optional)
- date_delivery - date of delivery (optional)
- complete - boolean flag indicating, that only order with all items finished may be shipped (optional)
- moving_node_id - network node (bulk device), which is the target of moving the service concernet (optional)
- address - address associated with the order as text
- ua_id - UIR address associated with the order (optional)
- uc_id - (optional)
- up_id - orders premise id (optional)
- price - price with vat
- price_wo_vat - price without vat
- provider - provider, which is assigned to the customer
- voucher - voucher - automatically generated when ordering
- transport_up_id - premise id for collection if transport_service_id parameter specifies collection in person (optional)
- no_auto_dispatch - boolean flag indicating, that, if true, receipt and other documents for order will not be dispatched automatically by the system (optional)
- no_auto_transport - boolean flag indicating that transport price needs to be recalculated (optional)
- title - human readable order title (short note)
- hide_price_detail - boolean flag indicating, that, if true, detail items prices will be hidden when order is printed, in e-mail notifications and in system selfcare (optional)
- author_storno_done - operator who has completed or canceled the order
- date_storno_done - date of end or cancel the order
- reason_storno_done - the reason for canceling orders
- note_storno_done - note for the cancellation of the order
- author_realization - operator who carried out the order
- date_realization - date of realization
- box_order - identifies whether to pick up the order in the box
- po_order_num - orderNum to pay by card
- items - order items as OrderItemsList data type
OrderItemList complex type:
Zero or more elements of OrderItem data type.
Name: ws_orders_list
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_orders_listRequest
parts:
session: xsd:string
search: tns:OrderSearch
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_orders_listResponse
parts:
result: tns:OrdersList
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Returns list of orders of an user matching specified search parameters.
Method parameters:
- session - operator session token as returned by ws_session_login
- search - search parameters specified as instance of ProductPersonalizedSearch data type.
Returns:
- result - list of orders as Order data type
Exceptions:
The method will throw an exception if session token is invalid or expired, required search parameter is missing or an invalid value is used for it.
OrderSearch complex type:
- up_user_id - required integer id of premise user
- id - unique integer identifier of the order (optional)
- user_id - unique integer identifier of the user (optional)
- up_id - unique integer identifier of the premise (optional)
- up_ident - number of the premise (optional)
- date_realization_from - date of order - from (optional)
- date_realization_to - date of order - to (optional)
- state - order state as OrderState data type (optional)
OrderState simple type:
Value may be one of: 'ACCEPT', 'REALIZATION', 'WAITING_FOR_PAYMENT', 'STORNO', 'DONE', 'EXPEDICE', 'PREPARE'.
Order complex type:
- id - unique order identification number
- state - order state as OrderState data type
- order_number - number of order
- date_filing - date of acceptation
- date_order - date of creation
- user_id - end user, to whoom the order belongs (required)
- user_name - end user name, to whoom the order belongs
- node_id - network node (bulk device) associated with order (optional)
- dealer - id of operator, who create the order
- crm_channel - code of CRM channel, by that the order was created (eg. 2 for telephonic order) (optional)
- note - order note (optional)
- reference_number - order identifier in an external system (optional)
- ct - number of location
- created - creation date of the order
- creator - creator of the order
- wizard - flag indicating that order was created in CIBS system frontends wizard (optional)
- transport_service_id - code of transport service (eg. 1 for PPL) (optional)
- billing_plan_id - billing blan id (code for way of checkout) (optional)
- date_delivery - date of delivery (optional)
- complete - boolean flag indicating, that only order with all items finished may be shipped (optional)
- moving_node_id - network node (bulk device), which is the target of moving the service concernet (optional)
- address - address associated with the order as text
- ua_id - UIR address associated with the order (optional)
- uc_id - (optional)
- up_id - orders premise id (optional)
- price - price with vat
- price_wo_vat - price without vat
- provider - provider, which is assigned to the customer
- voucher - voucher - automatically generated when ordering
- transport_up_id - premise id for collection if transport_service_id parameter specifies collection in person (optional)
- no_auto_dispatch - boolean flag indicating, that, if true, receipt and other documents for order will not be dispatched automatically by the system (optional)
- no_auto_transport - boolean flag indicating that transport price needs to be recalculated (optional)
- title - human readable order title (short note)
- hide_price_detail - boolean flag indicating, that, if true, detail items prices will be hidden when order is printed, in e-mail notifications and in system selfcare (optional)
- author_storno_done - operator who has completed or canceled the order
- date_storno_done - date of end or cancel the order
- reason_storno_done - the reason for canceling orders
- note_storno_done - note for the cancellation of the order
- author_realization - operator who carried out the order
- date_realization - date of realization
- box_order - identifies whether to pick up the order in the box
- po_order_num - orderNum to pay by card
- items - order items as OrderItemsList data type
OrderItemList complex type:
Zero or more elements of OrderItem data type.
Close
Name: ws_order_items_get
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_order_items_getRequest
parts:
session: xsd:string
search: tns:ItemsInOrderSearch
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_order_items_getResponse
parts:
result: tns:ItemsInOrderList
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Returns items of an order.
Method parameters:
Order specification as ItemsInOrderSearch type (containing one of order_id - internal globaly unique order identifier, or order_number - human directed order identifier unique for installation)
Returns:
Array of order items, represented as ItemInOrder complex type.
Exceptions:
The method will throw an exception if session token is invalid or expired, requested order does not exist or is not accessible for session.
OrderItem complex type:
- item_id - globally unique order item identifier
- state - state of item in order, one of 'NONE', 'DONE', 'CANCEL', 'EXPEDICE', 'PREPARE', 'EXCLUDE'
- last_change - date and time of last order item record change
- expedant_id - identifier of operator who did order item expedition
- expedant_name - name of operator who did order item expedition
- coverage - states if and how much of order item can be fullfilled if applicable
- reserve - amount of pieces reserved for the order item
- crm_channel - channel over which the order was made
- date_from - start date (agreement start in case of service order items)
- date_start - start date (provisioning start in case of service order items)
- name - order item name (as listed on invoice if possible)
- note
- price - order item price with VAT
- price_wo_vat - order item price without VAT
- salesman_id - identifier of operator who is responsible for the order
- salesman_name - name of operator who is responsible for the order
- service_id - id of internal service structure associated with the order
- base_service_id - for items concerning linked products, id of base service associated with the order
Name: ws_order_items_get
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_order_items_getRequest
parts:
session: xsd:string
search: tns:ItemsInOrderSearch
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_order_items_getResponse
parts:
result: tns:ItemsInOrderList
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Returns items of an order.
Method parameters:
Order specification as ItemsInOrderSearch type (containing one of order_id - internal globaly unique order identifier, or order_number - human directed order identifier unique for installation)
Returns:
Array of order items, represented as ItemInOrder complex type.
Exceptions:
The method will throw an exception if session token is invalid or expired, requested order does not exist or is not accessible for session.
OrderItem complex type:
- item_id - globally unique order item identifier
- state - state of item in order, one of 'NONE', 'DONE', 'CANCEL', 'EXPEDICE', 'PREPARE', 'EXCLUDE'
- last_change - date and time of last order item record change
- expedant_id - identifier of operator who did order item expedition
- expedant_name - name of operator who did order item expedition
- coverage - states if and how much of order item can be fullfilled if applicable
- reserve - amount of pieces reserved for the order item
- crm_channel - channel over which the order was made
- date_from - start date (agreement start in case of service order items)
- date_start - start date (provisioning start in case of service order items)
- name - order item name (as listed on invoice if possible)
- note
- price - order item price with VAT
- price_wo_vat - order item price without VAT
- salesman_id - identifier of operator who is responsible for the order
- salesman_name - name of operator who is responsible for the order
- service_id - id of internal service structure associated with the order
- base_service_id - for items concerning linked products, id of base service associated with the order
Close
Name: ws_order_item_params_get
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_order_item_params_getRequest
parts:
session: xsd:string
order_item_id: xsd:integer
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_order_item_params_getResponse
parts:
result: tns:ItemInOrderParamList
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Returns list of order item parameters.
Method parameters:
- order_item_id - globally unique order item identifier
Returns:
Array of order item parameters, represented as ItemInOrderParam complex type.
ItemInOrderParam complex type:
- name - parameter name
- type - type of parameter, one of 'num', 'string', 'select', 'bool', 'price', 'time', 'text', 'memo', 'html', 'file', 'selfcare-editor', 'phone', 'ip', 'mac'
- value - parameter value; for large binary values of parameters of type 'file' and 'selfcare-editor' the value contains a placeholder
Name: ws_order_item_params_get
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_order_item_params_getRequest
parts:
session: xsd:string
order_item_id: xsd:integer
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_order_item_params_getResponse
parts:
result: tns:ItemInOrderParamList
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Returns list of order item parameters.
Method parameters:
- order_item_id - globally unique order item identifier
Returns:
Array of order item parameters, represented as ItemInOrderParam complex type.
ItemInOrderParam complex type:
- name - parameter name
- type - type of parameter, one of 'num', 'string', 'select', 'bool', 'price', 'time', 'text', 'memo', 'html', 'file', 'selfcare-editor', 'phone', 'ip', 'mac'
- value - parameter value; for large binary values of parameters of type 'file' and 'selfcare-editor' the value contains a placeholder
Close
Name: ws_order_item_paramdata_get
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_order_item_paramdata_getRequest
parts:
session: xsd:string
order_item_id: xsd:integer
param_name: xsd:string
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_order_item_paramdata_getResponse
parts:
result: xsd:string
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Returns value of an order item parameter, including large binary values of parameters of type 'file' and 'selfcare-values', encoded to safe transfer encoding
Method parameters:
- order_item_id - globally unique order item identifier
- param_name - name of parameter requested
Returns:
- data - encoded parameter value
- param_type - type of parameter, one of 'num', 'string', 'select', 'bool', 'price', 'time', 'text', 'memo', 'html', 'file', 'selfcare-editor', 'phone', 'ip', 'mac'
- encoding - encoding used to encode parameter value in response; currently just 'base64' encoding is used
- filename - for parameters of type 'file', original filename of parameter file
Name: ws_order_item_paramdata_get
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_order_item_paramdata_getRequest
parts:
session: xsd:string
order_item_id: xsd:integer
param_name: xsd:string
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_order_item_paramdata_getResponse
parts:
result: xsd:string
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Returns value of an order item parameter, including large binary values of parameters of type 'file' and 'selfcare-values', encoded to safe transfer encoding
Method parameters:
- order_item_id - globally unique order item identifier
- param_name - name of parameter requested
Returns:
- data - encoded parameter value
- param_type - type of parameter, one of 'num', 'string', 'select', 'bool', 'price', 'time', 'text', 'memo', 'html', 'file', 'selfcare-editor', 'phone', 'ip', 'mac'
- encoding - encoding used to encode parameter value in response; currently just 'base64' encoding is used
- filename - for parameters of type 'file', original filename of parameter file
Close
Name: ws_order_create
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_order_createRequest
parts:
session: xsd:string
order: tns:Order
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_order_createResponse
parts:
result: xsd:int
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Creates a new order
Method parameters:
- session - operator session token as returned by ws_session_login
- order - order description as Order data type
Returns:
- result - nonzero unique order identifier on success
Exceptions:
The method will throw an exception if session token is invalid or expired, required parameters were not suplied or their value is invalid
Order complex type:
- state - order state as OrderState data type
- date_filing - date of acceptation
- date_order - date of creation
- user_id - end user, to whoom the order belongs (required)
- node_id - network node (bulk device) associated with order (optional)
- dealer - id of operator, who create the order
- crm_channel - code of CRM channel, by that the order was created (eg. 2 for telephonic order) (optional)
- note - order note (optional)
- reference_number - order identifier in an external system (optional)
- wizard - flag indicating that order was created in CIBS system frontends wizard (optional)
- transport_service_id - code of transport service (eg. 1 for PPL) (optional)
- billing_plan_id - billing blan id (code for way of checkout) (optional)
- date_delivery - date of delivery (optional)
- complete - boolean flag indicating, that only order with all items finished may be shipped (optional)
- moving_node_id - network node (bulk device), which is the target of moving the service concernet (optional)
- ua_id - UIR address of (optional)
- uc_id - (optional)
- up_id - orders premise id (optional)
- transport_up_id - premise id for collection if transport_service_id parameter specifies collection in person (optional)
- no_auto_dispatch - boolean flag indicating, that, if true, receipt and other documents for order will not be dispatched automatically by the system (optional)
- no_auto_transport - boolean flag indicating that transport price needs to be recalculated (optional)
- title - human readable order title (short note)
- hide_price_detail - boolean flag indicating, that, if true, detail items prices will be hidden when order is printed, in e-mail notifications and in system selfcare
OrderState simple type:
Value may be one of: 'ACCEPT', 'REALIZATION', 'WAITING_FOR_PAYMENT', 'STORNO', 'DONE', 'EXPEDICE', 'PREPARE'.
Name: ws_order_create
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_order_createRequest
parts:
session: xsd:string
order: tns:Order
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_order_createResponse
parts:
result: xsd:int
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Creates a new order
Method parameters:
- session - operator session token as returned by ws_session_login
- order - order description as Order data type
Returns:
- result - nonzero unique order identifier on success
Exceptions:
The method will throw an exception if session token is invalid or expired, required parameters were not suplied or their value is invalid
Order complex type:
- state - order state as OrderState data type
- date_filing - date of acceptation
- date_order - date of creation
- user_id - end user, to whoom the order belongs (required)
- node_id - network node (bulk device) associated with order (optional)
- dealer - id of operator, who create the order
- crm_channel - code of CRM channel, by that the order was created (eg. 2 for telephonic order) (optional)
- note - order note (optional)
- reference_number - order identifier in an external system (optional)
- wizard - flag indicating that order was created in CIBS system frontends wizard (optional)
- transport_service_id - code of transport service (eg. 1 for PPL) (optional)
- billing_plan_id - billing blan id (code for way of checkout) (optional)
- date_delivery - date of delivery (optional)
- complete - boolean flag indicating, that only order with all items finished may be shipped (optional)
- moving_node_id - network node (bulk device), which is the target of moving the service concernet (optional)
- ua_id - UIR address of (optional)
- uc_id - (optional)
- up_id - orders premise id (optional)
- transport_up_id - premise id for collection if transport_service_id parameter specifies collection in person (optional)
- no_auto_dispatch - boolean flag indicating, that, if true, receipt and other documents for order will not be dispatched automatically by the system (optional)
- no_auto_transport - boolean flag indicating that transport price needs to be recalculated (optional)
- title - human readable order title (short note)
- hide_price_detail - boolean flag indicating, that, if true, detail items prices will be hidden when order is printed, in e-mail notifications and in system selfcare
OrderState simple type:
Value may be one of: 'ACCEPT', 'REALIZATION', 'WAITING_FOR_PAYMENT', 'STORNO', 'DONE', 'EXPEDICE', 'PREPARE'.
Close
Name: ws_order_edit
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_order_editRequest
parts:
session: xsd:string
order: tns:Order
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_order_editResponse
parts:
result: xsd:int
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Modifies an existing order
Method parameters:
- session - operator session token as returned by ws_session_login
- order - order description as Order data type
Returns:
- result - positive integer number on success
Exceptions:
The method will throw an exception if session token is invalid or expired, required parameters were not suplied or their value is invalid
Order complex type:
- id - unique integer identifier of the order to be edited (required)
- date_filing - date of acceptation
- date_order - date of creation
- node_id - network node (bulk device) associated with order (optional)
- dealer - id of operator, who create the order
- crm_channel - code of CRM channel, by that the order was created (eg. 2 for telephonic order) (optional)
- note - order note (optional)
- reference_number - order identifier in an external system (optional)
- wizard - flag indicating that order was created in CIBS system frontends wizard (optional)
- transport_service_id - code of transport service (eg. 1 for PPL) (optional)
- billing_plan_id - billing blan id (code for way of checkout) (optional)
- date_delivery - date of delivery (optional)
- complete - boolean flag indicating, that only order with all items finished may be shipped (optional)
- moving_node_id - network node (bulk device), which is the target of moving the service concernet (optional)
- ua_id - UIR address of (optional)
- uc_id - (optional)
- up_id - orders premise id (optional)
- transport_up_id - premise id for collection if transport_service_id parameter specifies collection in person (optional)
- no_auto_dispatch - boolean flag indicating, that, if true, receipt and other documents for order will not be dispatched automatically by the system (optional)
- no_auto_transport - boolean flag indicating that transport price needs to be recalculated (optional)
- title - short human readable order description for operators use
- hide_price_detail - boolean flag indicating, that, if true, detail items prices will be hidden when order is printed, in e-mail notifications and in system selfcare
Name: ws_order_edit
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_order_editRequest
parts:
session: xsd:string
order: tns:Order
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_order_editResponse
parts:
result: xsd:int
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Modifies an existing order
Method parameters:
- session - operator session token as returned by ws_session_login
- order - order description as Order data type
Returns:
- result - positive integer number on success
Exceptions:
The method will throw an exception if session token is invalid or expired, required parameters were not suplied or their value is invalid
Order complex type:
- id - unique integer identifier of the order to be edited (required)
- date_filing - date of acceptation
- date_order - date of creation
- node_id - network node (bulk device) associated with order (optional)
- dealer - id of operator, who create the order
- crm_channel - code of CRM channel, by that the order was created (eg. 2 for telephonic order) (optional)
- note - order note (optional)
- reference_number - order identifier in an external system (optional)
- wizard - flag indicating that order was created in CIBS system frontends wizard (optional)
- transport_service_id - code of transport service (eg. 1 for PPL) (optional)
- billing_plan_id - billing blan id (code for way of checkout) (optional)
- date_delivery - date of delivery (optional)
- complete - boolean flag indicating, that only order with all items finished may be shipped (optional)
- moving_node_id - network node (bulk device), which is the target of moving the service concernet (optional)
- ua_id - UIR address of (optional)
- uc_id - (optional)
- up_id - orders premise id (optional)
- transport_up_id - premise id for collection if transport_service_id parameter specifies collection in person (optional)
- no_auto_dispatch - boolean flag indicating, that, if true, receipt and other documents for order will not be dispatched automatically by the system (optional)
- no_auto_transport - boolean flag indicating that transport price needs to be recalculated (optional)
- title - short human readable order description for operators use
- hide_price_detail - boolean flag indicating, that, if true, detail items prices will be hidden when order is printed, in e-mail notifications and in system selfcare
Close
Name: ws_order_realization
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_order_realizationRequest
parts:
session: xsd:string
order_id: xsd:integer
params: tns:OrderRealizationParams
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_order_realizationResponse
parts:
result: xsd:int
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Confirms an existing offer
Method parameters:
- session - operator session token as returned by ws_session_login
- order_id - unique integer identifier of the order to be confirmed
- params - order realization parameters as OrderRealizationParams data type
Returns:
- result - positive integer number on success
Exceptions:
The method will throw an exception if session token is invalid or expired, order state does not allow it to be confirmed or required parameters were not suplied
OrderRealizationParams complex type:
- contact_id - identifier of contact at end user subject, responsible for the order (optional)
- note - order realization note (optional)
- reference_number - order reference number in an external system (optional)
- date_delivery - requested date of delivery (optional)
- complete_only - boolean flag indicating, that only order with all items finished may be shipped (optional)
- title - short human readable order description for operators use
Name: ws_order_realization
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_order_realizationRequest
parts:
session: xsd:string
order_id: xsd:integer
params: tns:OrderRealizationParams
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_order_realizationResponse
parts:
result: xsd:int
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Confirms an existing offer
Method parameters:
- session - operator session token as returned by ws_session_login
- order_id - unique integer identifier of the order to be confirmed
- params - order realization parameters as OrderRealizationParams data type
Returns:
- result - positive integer number on success
Exceptions:
The method will throw an exception if session token is invalid or expired, order state does not allow it to be confirmed or required parameters were not suplied
OrderRealizationParams complex type:
- contact_id - identifier of contact at end user subject, responsible for the order (optional)
- note - order realization note (optional)
- reference_number - order reference number in an external system (optional)
- date_delivery - requested date of delivery (optional)
- complete_only - boolean flag indicating, that only order with all items finished may be shipped (optional)
- title - short human readable order description for operators use
Close
Name: ws_order_storno
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_order_stornoRequest
parts:
session: xsd:string
order_id: xsd:integer
storno_reason: xsd:string
storno_note: xsd:string
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_order_stornoResponse
parts:
result: xsd:int
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Cancels an existing order
Method parameters:
- session - operator session token as returned by ws_session_login
- order_id - unique integer identifier of order to be cancelled
- storno_reason - integer storno reason code
- storno_note - note to order cancelation
Returns:
- result - positive integer number on success
Exceptions:
The method will throw an exception if session token is invalid or expired, order state does not allow cancelation or required parameters were not suplied
Name: ws_order_storno
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_order_stornoRequest
parts:
session: xsd:string
order_id: xsd:integer
storno_reason: xsd:string
storno_note: xsd:string
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_order_stornoResponse
parts:
result: xsd:int
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Cancels an existing order
Method parameters:
- session - operator session token as returned by ws_session_login
- order_id - unique integer identifier of order to be cancelled
- storno_reason - integer storno reason code
- storno_note - note to order cancelation
Returns:
- result - positive integer number on success
Exceptions:
The method will throw an exception if session token is invalid or expired, order state does not allow cancelation or required parameters were not suplied
Close
Name: ws_order_items_create
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_order_items_createRequest
parts:
session: xsd:string
order_id: xsd:integer
personalized_product_id: xsd:integer
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_order_items_createResponse
parts:
result: xsd:int
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Adds an item into order
Method parameters:
- session - operator session token as returned by ws_session_login
- order_id - unique integer identifier of the order
- personalized_product_id - unique integer identifier of (personalized) product to be ordered
Returns:
- result - unique integer identifier of order item created
Exceptions:
The method will throw an exception if session token is invalid or expired, order state does not allow it to accept new items or required parameters were not suplied
Name: ws_order_items_create
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_order_items_createRequest
parts:
session: xsd:string
order_id: xsd:integer
personalized_product_id: xsd:integer
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_order_items_createResponse
parts:
result: xsd:int
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Adds an item into order
Method parameters:
- session - operator session token as returned by ws_session_login
- order_id - unique integer identifier of the order
- personalized_product_id - unique integer identifier of (personalized) product to be ordered
Returns:
- result - unique integer identifier of order item created
Exceptions:
The method will throw an exception if session token is invalid or expired, order state does not allow it to accept new items or required parameters were not suplied
Close
Name: ws_order_items_delete
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_order_items_deleteRequest
parts:
session: xsd:string
order_item_id: xsd:integer
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_order_items_deleteResponse
parts:
result: xsd:int
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Removes an item from an order
Method parameters:
- session - operator session token as returned by ws_session_login
- order_item_id - unique integer identifier of the order item (as returned by ws_order_items_create)
Returns:
- result - positive integer number on success
Exceptions:
The method will throw an exception if session token is invalid or expired, order state does not allow to remove items from it or order item does not exist
Name: ws_order_items_delete
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_order_items_deleteRequest
parts:
session: xsd:string
order_item_id: xsd:integer
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_order_items_deleteResponse
parts:
result: xsd:int
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Removes an item from an order
Method parameters:
- session - operator session token as returned by ws_session_login
- order_item_id - unique integer identifier of the order item (as returned by ws_order_items_create)
Returns:
- result - positive integer number on success
Exceptions:
The method will throw an exception if session token is invalid or expired, order state does not allow to remove items from it or order item does not exist
Close
Name: ws_order_payment_create
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_order_payment_createRequest
parts:
session: xsd:string
id: xsd:int
number: xsd:int
paId: xsd:int
date: xsd:date
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_order_payment_createResponse
parts:
result: xsd:int
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Creates the payment corresponding given order.
Method parameters:
- id - Optional Id of the order to create payment to. Id or number must be given.
- number - Optional number of the order to create payment to. Id or number must be given.
- paId - Mandatory cash register or account Id the payment create in.
- date - Optional date the payment is done for. Default is today.
Returns:
- result - Positive numbers means success, neggative is the error code. SOAP fault is raised in case of neggative code.
Name: ws_order_payment_create
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_order_payment_createRequest
parts:
session: xsd:string
id: xsd:int
number: xsd:int
paId: xsd:int
date: xsd:date
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_order_payment_createResponse
parts:
result: xsd:int
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Creates the payment corresponding given order.
Method parameters:
- id - Optional Id of the order to create payment to. Id or number must be given.
- number - Optional number of the order to create payment to. Id or number must be given.
- paId - Mandatory cash register or account Id the payment create in.
- date - Optional date the payment is done for. Default is today.
Returns:
- result - Positive numbers means success, neggative is the error code. SOAP fault is raised in case of neggative code.
Close
Name: ws_konzumuo_temporary_order_fix
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_konzumuo_temporary_order_fixRequest
parts:
session: xsd:string
id: xsd:int
number: xsd:int
prices: tns:OrderVatPrices
date: xsd:string
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_konzumuo_temporary_order_fixResponse
parts:
result: xsd:int
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Temporary order fix and order payment for Konzum.
Method parameters:
- id - Optional Id of the order to create payment to. Id or number must be given.
- number - Optional number of the order to create payment to. Id or number must be given.
- prices - Mandatory array of prices devided by VAT level.
- date - Optional date the payment is done for. Default is today.
Returns:
- result - Positive numbers means success, neggative is the error code. SOAP fault is raised in case of neggative code.
Name: ws_konzumuo_temporary_order_fix
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_konzumuo_temporary_order_fixRequest
parts:
session: xsd:string
id: xsd:int
number: xsd:int
prices: tns:OrderVatPrices
date: xsd:string
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_konzumuo_temporary_order_fixResponse
parts:
result: xsd:int
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Temporary order fix and order payment for Konzum.
Method parameters:
- id - Optional Id of the order to create payment to. Id or number must be given.
- number - Optional number of the order to create payment to. Id or number must be given.
- prices - Mandatory array of prices devided by VAT level.
- date - Optional date the payment is done for. Default is today.
Returns:
- result - Positive numbers means success, neggative is the error code. SOAP fault is raised in case of neggative code.
Close
Name: ws_premises_list
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_premises_listRequest
parts:
session: xsd:string
user_id: xsd:int
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_premises_listResponse
parts:
result: xsd:int
result_message: xsd:string
premises: tns:cibsPremises
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation:
List of premises
Function parameters:
- session - Operator session
- user_id - Lists the sessions for given user only, null = location provider.
Name: ws_premises_list
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_premises_listRequest
parts:
session: xsd:string
user_id: xsd:int
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_premises_listResponse
parts:
result: xsd:int
result_message: xsd:string
premises: tns:cibsPremises
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation:
List of premises
Function parameters:
- session - Operator session
- user_id - Lists the sessions for given user only, null = location provider.
Close
Name: ws_premise_create
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_premise_createRequest
parts:
session: xsd:string
user_id: xsd:int
ident: xsd:string
name: xsd:string
email: xsd:string
phone: xsd:string
street: xsd:string
house_id: xsd:string
city: xsd:string
zip: xsd:string
ucp_id: xsd:integer
us_id: xsd:integer
ua_id: xsd:integer
gps_latitude: xsd:string
gps_longitude: xsd:string
type_sale: xsd:string
purchase: xsd:boolean
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_premise_createResponse
parts:
result: xsd:int
result_message: xsd:string
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Create new premise
Function parameters:
- session - Operator session
- user_id - Premise operator
- ident - Premise code
- name - Name
- email - Premise operator name
- phone - Premise operator phone
- street - Address (optional when ua_id given)
- house_id
- city
- zip
- ucp_id - City part identifier by address register (optional)
- us_id - Street identifier by address register (optional)
- ua_id - Address identifier by address register (optional). When ucp_id and us_id are null, and ua_id is set, the whole address is expanded from ua_id.
- gps_latitude - GPS coordinates (optional, coords are calculated from ua_id when given)
- gps_longitude
- type_sale - One of sale type (NONE | MEGA | BOX)
- purchase - Premise with personal pickup
Name: ws_premise_create
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_premise_createRequest
parts:
session: xsd:string
user_id: xsd:int
ident: xsd:string
name: xsd:string
email: xsd:string
phone: xsd:string
street: xsd:string
house_id: xsd:string
city: xsd:string
zip: xsd:string
ucp_id: xsd:integer
us_id: xsd:integer
ua_id: xsd:integer
gps_latitude: xsd:string
gps_longitude: xsd:string
type_sale: xsd:string
purchase: xsd:boolean
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_premise_createResponse
parts:
result: xsd:int
result_message: xsd:string
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Create new premise
Function parameters:
- session - Operator session
- user_id - Premise operator
- ident - Premise code
- name - Name
- email - Premise operator name
- phone - Premise operator phone
- street - Address (optional when ua_id given)
- house_id
- city
- zip
- ucp_id - City part identifier by address register (optional)
- us_id - Street identifier by address register (optional)
- ua_id - Address identifier by address register (optional). When ucp_id and us_id are null, and ua_id is set, the whole address is expanded from ua_id.
- gps_latitude - GPS coordinates (optional, coords are calculated from ua_id when given)
- gps_longitude
- type_sale - One of sale type (NONE | MEGA | BOX)
- purchase - Premise with personal pickup
Close
Name: ws_premise_edit
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_premise_editRequest
parts:
session: xsd:string
premise_id: xsd:int
ident: xsd:string
name: xsd:string
email: xsd:string
phone: xsd:string
street: xsd:string
house_id: xsd:string
city: xsd:string
zip: xsd:string
ucp_id: xsd:integer
us_id: xsd:integer
ua_id: xsd:integer
gps_latitude: xsd:string
gps_longitude: xsd:string
type_sale: xsd:string
purchase: xsd:boolean
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_premise_editResponse
parts:
result: xsd:int
result_message: xsd:string
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Edit existing premise
Function parameters
- session - Operator session
- premise_id - ID of existing premise
- ident - Premise code
- name - Name
- email - Premise operator name
- phone - Premise operator phone
- street - Address (optional when ua_id given)
- house_id
- city
- zip
- ucp_id - City part identifier by address register (optional)
- us_id - Street identifier by address register (optional)
- ua_id - Address identifier by address register (optional). When ucp_id and us_id are null, and ua_id is set, the whole address is expanded from ua_id.
- gps_latitude - GPS coordinates (optional, coords are calculated from ua_id when given)
- gps_longitude
- type_sale - One of sale type (NONE | MEGA | BOX)
- purchase - Premise with personal pickup
Name: ws_premise_edit
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_premise_editRequest
parts:
session: xsd:string
premise_id: xsd:int
ident: xsd:string
name: xsd:string
email: xsd:string
phone: xsd:string
street: xsd:string
house_id: xsd:string
city: xsd:string
zip: xsd:string
ucp_id: xsd:integer
us_id: xsd:integer
ua_id: xsd:integer
gps_latitude: xsd:string
gps_longitude: xsd:string
type_sale: xsd:string
purchase: xsd:boolean
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_premise_editResponse
parts:
result: xsd:int
result_message: xsd:string
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Edit existing premise
Function parameters
- session - Operator session
- premise_id - ID of existing premise
- ident - Premise code
- name - Name
- email - Premise operator name
- phone - Premise operator phone
- street - Address (optional when ua_id given)
- house_id
- city
- zip
- ucp_id - City part identifier by address register (optional)
- us_id - Street identifier by address register (optional)
- ua_id - Address identifier by address register (optional). When ucp_id and us_id are null, and ua_id is set, the whole address is expanded from ua_id.
- gps_latitude - GPS coordinates (optional, coords are calculated from ua_id when given)
- gps_longitude
- type_sale - One of sale type (NONE | MEGA | BOX)
- purchase - Premise with personal pickup
Close
Name: ws_premise_delete
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_premise_deleteRequest
parts:
session: xsd:string
id: xsd:int
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_premise_deleteResponse
parts:
result: xsd:int
result_message: xsd:string
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Delete existing premise
Function parameters
- session - Operator session
- id - ID of the premise to delete
Name: ws_premise_delete
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_premise_deleteRequest
parts:
session: xsd:string
id: xsd:int
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_premise_deleteResponse
parts:
result: xsd:int
result_message: xsd:string
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Delete existing premise
Function parameters
- session - Operator session
- id - ID of the premise to delete
Close
Name: ws_premise_param_update
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_premise_param_updateRequest
parts:
session: xsd:string
premise_id: xsd:int
par_name: xsd:string
par_value: xsd:string
content: xsd:string
date_from: xsd:date
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_premise_param_updateResponse
parts:
result: xsd:int
result_message: xsd:string
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Update premise parameter
Function parameters:
- session - Operator session
- premise_id
- par_name
- par_value
- content - hex encodeded file content (only for FILE type params)
- date_from
Name: ws_premise_param_update
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_premise_param_updateRequest
parts:
session: xsd:string
premise_id: xsd:int
par_name: xsd:string
par_value: xsd:string
content: xsd:string
date_from: xsd:date
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_premise_param_updateResponse
parts:
result: xsd:int
result_message: xsd:string
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Update premise parameter
Function parameters:
- session - Operator session
- premise_id
- par_name
- par_value
- content - hex encodeded file content (only for FILE type params)
- date_from
Close
Name: ws_network_nodes_list
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_network_nodes_listRequest
parts:
session: xsd:string
top: xsd:int
class: xsd:string
infrastructure: xsd:boolean
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_network_nodes_listResponse
parts:
result: xsd:int
result_message: xsd:string
nodes: tns:cibsNodes
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: List nodes (devices)
Function parameters:
- session - Operator session
- top - The top node to list devices connected to
- class - filtering devices by class (optional)
- infrastructure - filtering infrastructure devices only (optional)
Name: ws_network_nodes_list
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_network_nodes_listRequest
parts:
session: xsd:string
top: xsd:int
class: xsd:string
infrastructure: xsd:boolean
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_network_nodes_listResponse
parts:
result: xsd:int
result_message: xsd:string
nodes: tns:cibsNodes
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: List nodes (devices)
Function parameters:
- session - Operator session
- top - The top node to list devices connected to
- class - filtering devices by class (optional)
- infrastructure - filtering infrastructure devices only (optional)
Close
Name: ws_network_node_create
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_network_node_createRequest
parts:
session: xsd:string
customer: xsd:int
class: xsd:string
type: xsd:string
interface: xsd:string
name: xsd:string
parent: xsd:int
parent_interface: xsd:int
premise: xsd:int
serial_num: xsd:string
user_id: xsd:int
services: tns:cibsNodeServices
addr_id: xsd:int
street: xsd:string
house_id: xsd:string
zip: xsd:string
city: xsd:string
flat: xsd:string
note: xsd:string
gps_latitude: xsd:string
gps_longitude: xsd:string
params: tns:cibsNodeParams
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_network_node_createResponse
parts:
result: xsd:int
result_message: xsd:string
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Create network node (device)
Function parameters:
- session - Operator session
- customer - Flag the device is used by customer or not
- clas - device class
- type - device type
- interface - The device interface name used to connect to the parnt node.
- name - The device user name
- parent - Id of the parent device
- parent_interface - Id of the parent interface
- premise - Id of the premise the device assign to (infrastructure devices)
- serial_num - The device serial number
- user_id - The id of the customer (customer devices only)
- services - array of customer services (customer devices only)
- addr_id - The RUIAN (UIR) address id
- street - The address text (optional when addr_id given)
- house_id
- zip
- city
- flat - The flat the device is on.
- note
- gps_latitude (optional when addr_id is given)
- gps_longitude (optional when addr_id is given)
- params - The hash of param values (in form name1=>value1||name2=>value2...)
Name: ws_network_node_create
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_network_node_createRequest
parts:
session: xsd:string
customer: xsd:int
class: xsd:string
type: xsd:string
interface: xsd:string
name: xsd:string
parent: xsd:int
parent_interface: xsd:int
premise: xsd:int
serial_num: xsd:string
user_id: xsd:int
services: tns:cibsNodeServices
addr_id: xsd:int
street: xsd:string
house_id: xsd:string
zip: xsd:string
city: xsd:string
flat: xsd:string
note: xsd:string
gps_latitude: xsd:string
gps_longitude: xsd:string
params: tns:cibsNodeParams
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_network_node_createResponse
parts:
result: xsd:int
result_message: xsd:string
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Create network node (device)
Function parameters:
- session - Operator session
- customer - Flag the device is used by customer or not
- clas - device class
- type - device type
- interface - The device interface name used to connect to the parnt node.
- name - The device user name
- parent - Id of the parent device
- parent_interface - Id of the parent interface
- premise - Id of the premise the device assign to (infrastructure devices)
- serial_num - The device serial number
- user_id - The id of the customer (customer devices only)
- services - array of customer services (customer devices only)
- addr_id - The RUIAN (UIR) address id
- street - The address text (optional when addr_id given)
- house_id
- zip
- city
- flat - The flat the device is on.
- note
- gps_latitude (optional when addr_id is given)
- gps_longitude (optional when addr_id is given)
- params - The hash of param values (in form name1=>value1||name2=>value2...)
Close
Name: ws_network_node_edit
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_network_node_editRequest
parts:
session: xsd:string
id: xsd:int
customer: xsd:int
type: xsd:string
name: xsd:string
premise: xsd:int
serial_num: xsd:string
user_id: xsd:int
services: tns:cibsNodeServices
addr_id: xsd:int
street: xsd:string
house_id: xsd:string
zip: xsd:string
city: xsd:string
flat: xsd:string
note: xsd:string
gps_latitude: xsd:string
gps_longitude: xsd:string
params: tns:cibsNodeParams
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_network_node_editResponse
parts:
result: xsd:int
result_message: xsd:string
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Edit network node (device)
Function parameters:
- session - Operator session
- id - Device ID to edit
- customer - Flag the device is used by customer or not
- type - device type
- name - The device user name
- premise - Id of the premise the device assign to (infrastructure devices)
- serial_num - The device serial number
- user_id - The id of the customer (customer devices only)
- services - array of customer services (customer devices only)
- addr_id - The RUIAN (UIR) address id
- street - The address text (optional when addr_id given)
- house_id
- zip
- city
- flat - The flat the device is on.
- note
- gps_latitude (optional when addr_id is given)
- gps_longitude (optional when addr_id is given)
- params - The hash of param values (in form name1=>value1||name2=>value2...)
Name: ws_network_node_edit
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_network_node_editRequest
parts:
session: xsd:string
id: xsd:int
customer: xsd:int
type: xsd:string
name: xsd:string
premise: xsd:int
serial_num: xsd:string
user_id: xsd:int
services: tns:cibsNodeServices
addr_id: xsd:int
street: xsd:string
house_id: xsd:string
zip: xsd:string
city: xsd:string
flat: xsd:string
note: xsd:string
gps_latitude: xsd:string
gps_longitude: xsd:string
params: tns:cibsNodeParams
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_network_node_editResponse
parts:
result: xsd:int
result_message: xsd:string
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Edit network node (device)
Function parameters:
- session - Operator session
- id - Device ID to edit
- customer - Flag the device is used by customer or not
- type - device type
- name - The device user name
- premise - Id of the premise the device assign to (infrastructure devices)
- serial_num - The device serial number
- user_id - The id of the customer (customer devices only)
- services - array of customer services (customer devices only)
- addr_id - The RUIAN (UIR) address id
- street - The address text (optional when addr_id given)
- house_id
- zip
- city
- flat - The flat the device is on.
- note
- gps_latitude (optional when addr_id is given)
- gps_longitude (optional when addr_id is given)
- params - The hash of param values (in form name1=>value1||name2=>value2...)
Close
Name: ws_network_node_delete
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_network_node_deleteRequest
parts:
session: xsd:string
id: xsd:int
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_network_node_deleteResponse
parts:
result: xsd:int
result_message: xsd:string
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Delete the netwrok node (device)
Function parameters
- session - Operator session
- id - ID of the node to delete
Name: ws_network_node_delete
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_network_node_deleteRequest
parts:
session: xsd:string
id: xsd:int
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_network_node_deleteResponse
parts:
result: xsd:int
result_message: xsd:string
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Delete the netwrok node (device)
Function parameters
- session - Operator session
- id - ID of the node to delete
Close
Name: ws_network_event_alert
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_network_event_alertRequest
parts:
session: xsd:string
nodeId: xsd:int
name: xsd:string
value: xsd:string
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_network_event_alertResponse
parts:
result: xsd:int
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: PrintPDF placeholder
Toto je pouze testovací WS pro vývoj PrintPDF!!! nepoužívat!
Předpokládá se, že v rámci vývoje CIBS části PrintPDF dojde k celkovému předělání této funkce (včerně jména, parametrů a obecně popisu funkcionality)
Slouží pouze k testování.
Name: ws_network_event_alert
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_network_event_alertRequest
parts:
session: xsd:string
nodeId: xsd:int
name: xsd:string
value: xsd:string
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_network_event_alertResponse
parts:
result: xsd:int
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: PrintPDF placeholder
Toto je pouze testovací WS pro vývoj PrintPDF!!! nepoužívat!
Předpokládá se, že v rámci vývoje CIBS části PrintPDF dojde k celkovému předělání této funkce (včerně jména, parametrů a obecně popisu funkcionality)
Slouží pouze k testování.
Close
Name: ws_price_calculation_get
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: http://is.cibs.cz/ws_cibs.php/ws_price_calculation_get
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_price_calculation_getRequest
parts:
session: xsd:string
product_id: xsd:integer
premise_id: xsd:integer
params: tns:ParamList
use_points: xsd:boolean
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_price_calculation_getResponse
parts:
m_price: xsd:string
v_price: xsd:string
points_price: xsd:string
points_discount: xsd:string
total_weight: xsd:string
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Calculates price for an product with parameters specified
Method parameters:
- session - operator session token as returned by ws_session_login
- product_id - identifier of product definition (in CIBS system accessible in module "Služby")
- premise_id - identifier of associated premise if premises are used by provider, empty otherwise
- params - requested product parameters as ParamList data type
- use_points - boolean flag indicating, that points discount should be used (if allowed by provider)
Returns:
- m_price - material price
- v_price - valuation price
- points_price - price in points (in addition to price in money)
- points_discount - price discount based on using points
- total_weight - total product weight (will be used to calculate transport price)
Exceptions:
The method will throw an exception if session token is invalid or expired, required parameters were not supplied or their values are invalid
ParamList complex type:
Zero or more elements of Param data type.
Param complex type:
- name - parameter name
- value - parameter value
Name: ws_price_calculation_get
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: http://is.cibs.cz/ws_cibs.php/ws_price_calculation_get
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_price_calculation_getRequest
parts:
session: xsd:string
product_id: xsd:integer
premise_id: xsd:integer
params: tns:ParamList
use_points: xsd:boolean
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: ws_price_calculation_getResponse
parts:
m_price: xsd:string
v_price: xsd:string
points_price: xsd:string
points_discount: xsd:string
total_weight: xsd:string
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Calculates price for an product with parameters specified
Method parameters:
- session - operator session token as returned by ws_session_login
- product_id - identifier of product definition (in CIBS system accessible in module "Služby")
- premise_id - identifier of associated premise if premises are used by provider, empty otherwise
- params - requested product parameters as ParamList data type
- use_points - boolean flag indicating, that points discount should be used (if allowed by provider)
Returns:
- m_price - material price
- v_price - valuation price
- points_price - price in points (in addition to price in money)
- points_discount - price discount based on using points
- total_weight - total product weight (will be used to calculate transport price)
Exceptions:
The method will throw an exception if session token is invalid or expired, required parameters were not supplied or their values are invalid
ParamList complex type:
Zero or more elements of Param data type.
Param complex type:
- name - parameter name
- value - parameter value
Close
Name: crmSubscribeOffer
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: crmSubscribeOfferRequest
parts:
subscriptionCode: xsd:string
offerCode: xsd:string
ceil: xsd:boolean
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: crmSubscribeOfferResponse
parts:
subscribeDate: xsd:date
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation:
Name: crmSubscribeOffer
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: crmSubscribeOfferRequest
parts:
subscriptionCode: xsd:string
offerCode: xsd:string
ceil: xsd:boolean
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: crmSubscribeOfferResponse
parts:
subscribeDate: xsd:date
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation:
Close
Name: crmUnsubscribeOffer
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: crmUnsubscribeOfferRequest
parts:
subscriptionCode: xsd:string
offerCode: xsd:string
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: crmUnsubscribeOfferResponse
parts:
unsubscribeDate: xsd:date
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation:
Name: crmUnsubscribeOffer
Binding: cibsBinding
Endpoint: https://is.cibs.cz/ws_cibs.php
SoapAction: https://is.cibs.cz/ws_cibs.php
Style: rpc
Input:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: crmUnsubscribeOfferRequest
parts:
subscriptionCode: xsd:string
offerCode: xsd:string
Output:
use: encoded
namespace:
encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
message: crmUnsubscribeOfferResponse
parts:
unsubscribeDate: xsd:date
Namespace:
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: