KronoDesk: SoapService 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 |
|---|---|
| ArrayOfRemoteArticle | Article_RetrievePopular Retrieves a list of most popular articles |
| ArrayOfRemoteArticle | Article_RetrieveRecent Retrieves a list of recent articles |
| ArrayOfRemoteArticle | Article_RetrieveSubscribed Retrieves a list of your user's subscribed articles |
| 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. |
| RemoteDocument | Document_RetrieveBydId ( long attachmentId,
) Retrieves a single attachment by its ID |
| RemoteOrganization | Organization_RetrieveById ( long organizationId,
) Returns the details of an organization by its ID |
| ArrayOfRemoteProduct | Product_Retrieve ( boolean includeDeleted,
) Retrieves a list of products in the system |
| ArrayOfstring | System_GetBlockedEmails Gets a list of email addresses blocked by the system |
| ArrayOfstring | System_GetEmailSeparator Gets the email separator used by KronoDesk in sending out emails |
| 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 |
| RemoteTicketEx | Ticket_Create2 ( RemoteTicketEx?
remoteTicket,
) Creates a new ticket in the system with custom properties |
| Ticket_Delete ( long ticketId,
) Deletes a single ticket by its ID | |
| Ticket_DeleteNote ( long ticketId,
long noteId,
) Deletes a note from a ticket | |
| ArrayOfRemoteTicket | Ticket_Retrieve ( RemoteSort?
remoteSort,
ArrayOfRemoteFilter?
remoteFilters,
int startRow,
int numberRows,
) Retrieves a list of tickets, sorted and filtered |
| RemoteTicket | Ticket_RetrieveById ( long ticketId,
) Retrieves a single ticket by its ID |
| RemoteTicketEx | Ticket_RetrieveById2 ( long ticketId,
) Retrieves a single ticket by its ID with custom properties |
| ArrayOfRemoteTicket | Ticket_RetrieveByOrganization1 ( long organizationId,
int startRow,
int numberRows,
) Retrieves a list of tickets for a specific organization, default filter and sort |
| ArrayOfRemoteTicket | Ticket_RetrieveByOrganization2 ( long organizationId,
RemoteSort?
remoteSort,
ArrayOfRemoteFilter?
remoteFilters,
int startRow,
int numberRows,
) Retrieves a list of tickets for a specific organization, sorted and filtered |
| RemoteTicketNote | Ticket_RetrieveNoteById ( long ticketId,
long noteId,
) Retrieves a single ticket note |
| ArrayOfRemoteTicketNote | Ticket_RetrieveNotesForTicket ( long ticketId,
) Retrieves all the notes for a specific ticket |
| RemoteTicket | Ticket_Update ( RemoteTicket?
remoteTicket,
) Updates a ticket in the system. |
| Ticket_Update2 ( RemoteTicketEx?
remoteTicket,
) Updates a ticket in the system, including custom properties | |
| RemoteTicketNote | Ticket_UpdateNote ( RemoteTicketNote?
remoteTicketNote,
) Updates an existing note in the system |
| ArrayOfRemoteTicketPriority | TicketPriority_Retrieve Retrieves the list of ticket priorities |
| ArrayOfRemoteTicketResolution | TicketResolution_Retrieve Retrieves the list of ticket resolutions |
| ArrayOfRemoteTicketStatus | TicketStatus_Retrieve Retrieves the list of ticket statuses |
| ArrayOfRemoteTicketType | TicketType_Retrieve Retrieves the list of ticket types |
| 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 |
| User_Delete ( long userId,
) Deletes the specified user | |
| ArrayOfRemoteUser | User_Retrieve ( int startRow,
int numberRows,
) Retrieves a paginated list of users in the system |
| RemoteUser | User_RetrieveByEmailAddress ( string?
emailAddress,
) Retrieves the user that has 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 |
| ArrayOfRemoteOrganizationUser | User_RetrieveByOrganization ( long organizationId,
) Retrieves a paginated list of users that belong to an organization |
| User_Update ( RemoteUser?
remoteUser,
) Updates a specific user in the system |