The SOAP API calls implement specific knowledgebase operations that your client applications can invoke at runtime to perform tasks, such as:

Using your development environment, you can construct Web Service (WS) client applications that use the standard WS protocols to:

Characteristics of API Calls

All SOAP API calls are:

Factors that Determine Data Access

When using the API, the following factors determine access to your organization's data:

Run-time access via the SOAP API is governed by the same access permissions as the GUI. Certain operations on the tables and fields can be performed only if the combined permissions in the logged-in user's group list permit such access. 
For example, values for the fields that are not visible to a given user are not returned in the results of the query. Another often reported issue is when one is not able to write a structure, retrieved in the very previous call, back to the server simply because the user has the necessary read permissions, but not the write ones. 
Please refer to the Groups section in your User Manual or Online Help for full details regarding permissions.

If any such constraints are required, it is up to the logic in the client application to enforce them explicitly.

Error Handling

In the event of an error the API calls return SOAP fault messages with additional information. 
There are currently six types of faults distinguished by the SOAP API:

Signals that the knowledgebase setup has become incompatible with the client application logic/expectations.

Signals that the operation may not be performed because of some dependencies between functions. This message should be considered in the context of the operation. It may signal a permanent condition, for example workflow forbidding transition from one state to another; or a temporary one, for example the record is locked by another user from another GUI or API session.

Signals that the username used to trigger the API call lacks sufficient privileges to perform certain operations.

Signals that client session has expired or has been removed.

Signals that an unknown, not handled and unexpected exception has happened on the server side. These exceptions should be reported to the vendor for further investigation. The message contains a token that helps to trace the root cause of the problem.

Signals that data passed by client is wrong in the context of the operation.

Related articles