Contact Management
The contact management web service allows retrieving, creating, updating and deleting contacts.
Note: Retrieve the WSDL to get an overview of the general options. The JSON requests correspond to the SOAP XML requests as you can see in the examples below.
SOAP and WSDL
The WSDL can be retrieved via following URL:
https://<host>/<vdir>/fscdav/wsdl?WEBSVC=FSCCONTACTMGMT_1_1001_ContactWebService
Example:
JSON
You can call the operations the following way:
https://<host>/<vdir>/wsjson/FSCCONTACTMGMT_1_1001_ContactWebService/<operation>
Example:
Available Operations
The contact management web service provides following operations:
- GetContactsByKey
Retrieves contacts based on a key (Import ID or Fabasoft Cloud ID). Several contacts can be returned, e.g. in case of several identical import IDs. If more than 100 contacts or contact rooms are found, an error is returned. - GetContactsByName
Retrieves contacts based on a name (“LIKE” search in the Name field). Several contacts can be returned, e.g. if the search matches several contact names. If more than 100 contacts or contact rooms are found, an error is returned. - UpdateContact
Creates a new contact or updates an existing one. - DeleteContact
Deletes a contact.
More information about the parameters of the operations can be found here (the listed actions are mapped to the corresponding web service operations):
- WSGetContactsByKey
https://help.developer.fabasoft.com/doc/Reference-Documentation/actions-fsccontactmgmt.htm#FSCCONTACTMGMT_1_1001_WSGetContactsByKey: new window - WSGetContactsByName
https://help.developer.fabasoft.com/doc/Reference-Documentation/actions-fsccontactmgmt.htm#FSCCONTACTMGMT_1_1001_WSGetContactsByName: new window - WSUpdateContact
https://help.developer.fabasoft.com/doc/Reference-Documentation/actions-fsccontactmgmt.htm#FSCCONTACTMGMT_1_1001_WSUpdateContact: new window - WSDeleteContact
https://help.developer.fabasoft.com/doc/Reference-Documentation/actions-fsccontactmgmt.htm#FSCCONTACTMGMT_1_1001_WSDeleteContact: new window
Examples
The following chapters provide several contact management web service examples.
GetContactsByKey
In the following example all contact persons with Import ID “P1” of rooms with Import ID “Room_A1” of the configuration with Fabasoft Cloud ID “COO.1.506.2.586” are retrieved.
Note: In any case the Import ID or Fabasoft Cloud ID can be used to identify the objects.
Example |
|---|
SOAP Request <soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:fsc="http://schemas.fabasoft.com/websvc/FSCCONTACTMGMT_1_1001_ContactWebService/"> JSON Request { |
GetContactsByName
In the following example all contact persons and organizations with “jones” in the name (case-insensitive) of rooms with Import ID “Room_A1” are retrieved.
Example |
|---|
SOAP Request <soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:fsc="http://schemas.fabasoft.com/websvc/FSCCONTACTMGMT_1_1001_ContactWebService/"> JSON Request { |
UpdateContact
In the following example a contact person is created or updated (identified by Import ID “P1”) . In addition to the surname and first name two addresses and two websites are defined.
Note: If overridekeys is defined for a property, empty values are considered and in case of lists existing entries are removed. Otherwise, empty values are ignored and new values are added to a list. In this example, the websites property will have the defined two entries (existing entries are removed) and the academic title will be emptied.
A special case are general object class properties (like objsubject) and fields of user-defined forms. If you add a user-defined form category (COOTC_1_1001_objcategory) to a contact, you can also define the values of the user-defined fields within the FSCAPPTOOLS_1_1001_additionalfields block. Within this block the default override keys are not working. You can use FSCAPPTOOLS_1_1001_ftoverwrite instead (only works for list properties). Empty values of single properties are always considered. In the following example the user-defined form category COO.1.506.1.1005845 that provides a string property with programming name UDName and a list property with programming name UDList is assigned to the contact. ftoverwrite is set to true for the list.
Example |
|---|
SOAP Request <soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:fsc="http://schemas.fabasoft.com/websvc/FSCCONTACTMGMT_1_1001_ContactWebService/"> JSON Request { |
DeleteContact
In the following example the contact with Import ID “Contact_C12” of room with Import ID “Room_A1” is deleted. If more than one contact is found, an error is returned.
Example |
|---|
SOAP Request <soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:fsc="http://schemas.fabasoft.com/websvc/FSCCONTACTMGMT_1_1001_ContactWebService/"> JSON Request { |