KronoDesk: ImportExport SOAP Web Service
This web service enables the import and export of data to/from the system. Each function is prefixed by the area of the system that it relates to. For example, the Ticket_Retrieve function relates to the Help Desk module.
The following operations are supported. For a formal definition, please review the Service Description .
| Return Value | Operation |
|---|---|
| boolean | Connection_Authenticate ( string?
userName,
string?
password,
string?
pluginName,
boolean useLicense,
) Authenticates against the server. Need to call before using other methods |
| Connection_Disconnect Disconnects the currenly authenticated / authorized user | |
| RemoteDocument | Document_AddFile ( RemoteDocument?
remoteDocument,
base64Binary?
binaryData,
) Adds a new document (file) into the system and associates it with the provided artifact |
| ArrayOfRemoteDocument | Document_GetForArtifact ( int artType,
long artifactId,
boolean includeHash,
) Gets a list of attached documents to an item. |
| ArrayOfRemoteProduct | Product_Retrieve ( boolean includeDeleted,
) Retrieves a list of products in the system |
| string | System_GetExtensionFromMimeType ( string?
mimeType,
) Returns the extension for a mime-type (e.g. "image/gif") |
| string | System_GetMimeTypeFromExtension ( string?
extension,
) Returns the mime type for a file extension |
| RemoteVersion | System_GetProductVersion Retrieves the version number of the current installation. |
| dateTime | System_GetServerDateTime Retrieves the current date-time on the server in UTC |
| ArrayOfRemoteSetting | System_GetSettings Returns the current configuration settings for the installation. |
| string | System_GetWebServerUrl Gets the base URL of the website that the system is running under. Used for notifications and exported artifacts |
| ArrayOfRemoteSitemapEntry | System_RetrieveSitemapEntries Retrieves a list of publicly accessible web page urls, used in SEO sitemaps |
| RemoteTicketNote | Ticket_AddNote ( RemoteTicketNote?
remoteTicketNote,
) Adds a new note to an existing ticket |
| RemoteTicket | Ticket_Create ( RemoteTicket?
remoteTicket,
) Creates a new ticket in the system |
| RemoteTicket | Ticket_Update ( RemoteTicket?
remoteTicket,
) Updates a ticket in the system. |
| RemoteTicketNote | Ticket_UpdateNote ( RemoteTicketNote?
remoteTicketNote,
) Updates an existing note in the system |
| RemoteUser | User_Create ( RemoteUser?
remoteUser,
string?
password,
string?
passwordQuestion,
string?
passwordAnswer,
ArrayOfstring?
roles,
) Creates a new user (with profile) in the system and adds them to the specified roles |
| ArrayOfRemoteUser | User_RetrieveByEmailAddress ( string?
emailAddress,
) Retrieves a list of users that have a specific email address |
| RemoteUser | User_RetrieveById ( long userId,
) Retrieves a single user in the system |
| RemoteUser | User_RetrieveByLogin ( string?
login,
) Retrieves a single user in the system bh its login |