Go to documentation repository
Documentation for Axxon PSIM 2.0. Documentation for other versions of Axxon PSIM is available too.
Previous page Next page
On the page:
You can add, update, and delete system objects using the following commands:
- CORE||CREATE_OBJECT to create a new object.
- CORE||UPDATE_OBJECT to change an existing object or create a new one.
- CORE||DELETE_OBJECT to delete an object.
Add a user to a department
Below is a message that, after being processed, adds the specified user to the specified department, with the specified parameters:
CORE||CREATE_OBJECT|objtype<PERSON>,objid<12341>,parent_id<1>,surname<Tim>,name<Kovac>,card<12362>,facility_code<0>
IIDK returns the following message in response to this command:
CORE||CREATE_OBJECT_RESPONSE|card<12362>,objid<12341>,facility_code<0>,module<iidk_client_test_x64.exe>,name<Kovac>,surname<Tim>,TRANSPORT_ID<iidk_proxy_>,objtype<PERSON>,parent_id<1>,slave_id<A-ZHASHUEV.12>,endpoint_uid<53659>,reason<0>,date<19-05-26>,time<09:22:20>,fraction<742>,owner<A-ZHASHUEV>,success<0>,guid_pk<{16673855-534B-0085-8550-60452ED6DF39}>,response<Finished successfully>,core_global<1>
This allows receiving the ID of the created object in the objid<> parameter.
Add and delete a video capture device
If there is no object in the system with the specified values for the objtype and objid parameters, you can add the object with the UPDATE_OBJECT command.
CORE||UPDATE_OBJECT|objtype<GRABBER>,objid<12>,core_global<0>,parent_id<SLAVAXP>,name<Video capture device 1>,params<5>,param0_name<format>,param0_val<NTSC>,param1_name<mode>,param1_val<1>,param2_name<chan>,param2_val<2>,param3_name<type>,param3_val<FX 4>,param4_name<resolution>,param4_val<0>
After receiving the following message, the system changes the name of an existing object:
CORE||UPDATE_OBJECT|objtype<GRABBER>,objid<12>,core_global<0>,parent_id<SLAVAXP>,name<Device 2>
To delete an object and all its child objects, use the DELETE_OBJECT command:
CORE||DELETE_OBJECT|objtype<GRABBER>,objid<12>
Response parameters
The IIDK response message contains the result of the command execution. The success parameter takes the value 1 if the command is executed successfully and 0 if an error occurred. The response parameter provides a text explanation of the reason, and the reason parameter contains the corresponding numeric code.
| reason | response | Comment |
|---|---|---|
| 0 | Finished successfully | Finished successfully |
| 1 | The type of object does not exist | The type of the object being created was not found. The type is likely not registered on this server |
| 2 | The object id parameter is empty and cannot be generated | The id parameter of the object being created is missing and cannot be generated by the kernel |
| 3 | The parent of the creating object does not exist | The specified parent object was not found |
| 4 | The name of the creating object already exists | The object name must be unique (there are exceptions) |
| 5 | Cannot create child object for parent object | It is not possible to create a child object for the specified parent object |
| 6 | The maximum number of objects has been reached | The maximum number of objects of this type allowed by the key has been reached |
| 7 | The single object already exists | Only one object of a certain type can be created |
| 8 | Licensing Server error | The licensing server returned an error when requesting a license for the object being created |
| 9 | UI creation is failure | An error occurred while adding to the UI |
| 10 | The object's param list creation was failure | An error occurred while creating the parameter list of the object |
| 11 | Deleting object does not exist | The object being deleted was not found |
Overview
Content Tools