Web Services SOAP API

Owned by IT Info
Jun 28, 2023

 

Ping Request Response

This verifies if the service is alive and can communicate with the service end point, and also verifies that DIIOP is enabled.

REQUEST  

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soapenv:Header>
    <RcEncryptedTimeStamp
        xmlns="http://webservices.reardencommerce.com/groupware/">rk+dFONzt6HDGTNvQm2NPvSmIPTR2MgA7IvCoXWykCEfar4jo3w0ie7cQq/60dQJ8BvqbPR6jZejcDztyTA28+gbJEboLR7KST9/GWAHhunETs9n8oMawZvXc2r5MaAhKm0BuYOAFnC4VStlvURivjOWLuNtVWTIMtB3zaQu2BA=</RcEncryptedTimeStamp>
  </soapenv:Header>
  <soapenv:Body>
    <initRequest
        xmlns="http://webservices.reardencommerce.com/groupware/">
      <testMessage xmlns="">PING</testMessage>
    </initRequest>
  </soapenv:Body>
</soapenv:Envelope>

RESPONSE

<?xml version="1.0" encoding="utf-8"?>
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soapenv:Body>
    <RcOperationStatus
        xmlns="http://webservices.reardencommerce.com/groupware/">
      <operationStatus xmlns="">true</operationStatus>
      <message xmlns="">SUCCESS</message>
    </RcOperationStatus>
  </soapenv:Body>
</soapenv:Envelope>

 

Login Request Response

Opens a session with Domino.

REQUEST

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soapenv:Header>
    <RcEncryptedTimeStamp
        xmlns="http://webservices.reardencommerce.com/groupware/">XjWAqDCfDhydgxkWRLL2TLdMDkiws0mI3OZI1lpqTK87tews5aLNGdT0BhidkfqWw5P+T3b+qus/Yf8lG75bZYoIRqMY8jS4Lye9W5DMvBrQVfKu59d5YSMcSz7iCHYLCfNdRdO69g6kVdnyNYtjO95S98VDCeE5tRWE79oOAzk=</RcEncryptedTimeStamp>
  </soapenv:Header>
  <soapenv:Body>
    <initRequest
        xmlns="http://webservices.reardencommerce.com/groupware/">
      <testMessage xmlns="">LOGIN</testMessage>
    </initRequest>
  </soapenv:Body>
</soapenv:Envelope>

 

RESPONSE

<?xml version="1.0" encoding="utf-8"?>
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soapenv:Body>
    <RcOperationStatus
        xmlns="http://webservices.reardencommerce.com/groupware/">
      <operationStatus xmlns="">true</operationStatus>
      <message xmlns="">SUCCESS</message>
    </RcOperationStatus>
  </soapenv:Body>
</soapenv:Envelope>

Create Appointment

REQUEST 

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soapenv:Header>
    <RcEncryptedTimeStamp
        xmlns="http://webservices.reardencommerce.com/groupware/">r2UOkcLlHhCC+DKF5pmIzNWHmohvHWuncUmu4GfMb0Pq44H63ubS/Al0OOKwmMHwH0JMsYBNd/wxaw0Zk6MdtpfZFashdoPWZO8A+ONBUXYbSHlacTRJb14qBf7thaLTbMKbNiSmJgclj00oHcAzCQPB+daFKjc3e3GLH1fa2r4=</RcEncryptedTimeStamp>
  </soapenv:Header>
  <soapenv:Body>
	<createAppointmentRequest
        xmlns="http://webservices.reardencommerce.com/groupware/">
	  <newAppointment xmlns="">
	    <groupwareId>Some User</groupwareId>
	    <appointmentType>0</appointmentType>
	    <subject>Some Test Appointment</subject>
	    <startTime>2014-11-30T09:00:00.000Z</startTime>
	    <endTime>2014-11-30T10:00:00.000Z</endTime>
	    <timeZoneId>PST</timeZoneId>
        <location>Some Test Location</location>
	    <body>Some Test Body</body>
	    <freeBusyStatus>1</freeBusyStatus>
	    <priority>1</priority>
	  </newAppointment>
	</createAppointmentRequest>
  </soapenv:Body>
</soapenv:Envelope>

 

RESPONSE

<?xml version="1.0" encoding="utf-8"?>
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soapenv:Body>
    <RcOperationStatus
        xmlns="http://webservices.reardencommerce.com/groupware/">
      <appointmentId xmlns="">ACBE6117F2AFA4DB882574FE0000B39C</appointmentId>
      <operationStatus xmlns="">true</operationStatus>
      <message xmlns="">SUCCESS</message>
    </RcOperationStatus>
  </soapenv:Body>
</soapenv:Envelope>

Modify Appointment

REQUEST

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soapenv:Header>
    <RcEncryptedTimeStamp
        xmlns="http://webservices.reardencommerce.com/groupware/">os1keVUfgx2FG18B2IOIZOIXL+HnMaiHEhs9ZXLZ1IcacRK7OyXQAV/uFqICwzr0QYmteifEqG7oWX6rXf7RAJFYpiZACko78xbStp/zda/xHI2aGxS9WLRhyTEvc7SyaomQ0Yq5kAdQBPgrVHMWMUWAnyJUGzc4/nx1SobZkXs=</RcEncryptedTimeStamp>
  </soapenv:Header>
  <soapenv:Body>
	<updateAppointmentRequest
        xmlns="http://webservices.reardencommerce.com/groupware/">
	<updatedAppointment xmlns="">
	    <groupwareId>Some User</groupwareId>
	    <appointmentId>ACBE6117F2AFA4DB882574FE0000B39C</appointmentId>
	    <appointmentType>0</appointmentType>
	    <subject>Some Test Appointment Updates</subject>
	    <startTime>2014-12-01T09:00:00.000Z</startTime>
	    <endTime>2014-12-01T10:00:00.000Z</endTime>
	    <timeZoneId>PST</timeZoneId>
        <location>Some Test Location</location>
	    <body>Some Test Body</body>
	    <freeBusyStatus>1</freeBusyStatus>
	    <priority>1</priority>
	  </updatedAppointment>
	</updateAppointmentRequest>
  </soapenv:Body>
</soapenv:Envelope>

 

RESPONSE 

<?xml version="1.0" encoding="utf-8"?>
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soapenv:Body>
    <RcOperationStatus
        xmlns="http://webservices.reardencommerce.com/groupware/">
      <appointmentId xmlns="">ACBE6117F2AFA4DB882574FE0000B39C</appointmentId>
      <operationStatus xmlns="">true</operationStatus>
      <message xmlns="">SUCCESS</message>
    </RcOperationStatus>
  </soapenv:Body>
</soapenv:Envelope>

 

Delete Appointment

REQUEST 

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soapenv:Header>
    <RcEncryptedTimeStamp
        xmlns="http://webservices.reardencommerce.com/groupware/">jMF/GdOeElaON6jwOMQnmlbB0y7ZEkS+Z21SxeH0MqRg2yHZr6PvXHe2rOYKZEF4zkgl9Z2glBu+6b0eyYwojRg8D6RcN6dlGBPlVmed7nz7rRTtJpHlIbgPy8OOhRJADiBGTysJUhOQtZmq+hfhOWgNNRgs/wK5gcaLLac8tWI=</RcEncryptedTimeStamp>
  </soapenv:Header>
  <soapenv:Body>
	<deleteAppointmentRequest
        xmlns="http://webservices.reardencommerce.com/groupware/">
	  <appointmentId xmlns="">ACBE6117F2AFA4DB882574FE0000B39C</appointmentId>
	  <groupwareId>Some User</groupwareId>
	</deleteAppointmentRequest>
  </soapenv:Body>
</soapenv:Envelope>

 

RESPONSE

<?xml version="1.0" encoding="utf-8"?>
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soapenv:Body>
    <RcOperationStatus
        xmlns="http://webservices.reardencommerce.com/groupware/">
      <operationStatus xmlns="">true</operationStatus>
      <message xmlns="">SUCCESS</message>
    </RcOperationStatus>
  </soapenv:Body>
</soapenv:Envelope>