Data Web Service

Data

Click here for a complete list of operations.

dataChange

CRUD api for contacts

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /WebServices/Data.asmx HTTP/1.1
Host: alert.groupcall.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://alert.groupcall.com/dataChange"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <dataChange xmlns="http://alert.groupcall.com/">
      <crud>
        <username>string</username>
        <password>string</password>
        <APIKey>string</APIKey>
        <metaData>string</metaData>
        <type>Add or Update or Delete</type>
        <contacts>
          <Contact>
            <ID>string</ID>
            <forename>string</forename>
            <surname>string</surname>
            <name>string</name>
            <contacttype>string</contacttype>
          </Contact>
          <Contact>
            <ID>string</ID>
            <forename>string</forename>
            <surname>string</surname>
            <name>string</name>
            <contacttype>string</contacttype>
          </Contact>
        </contacts>
        <addresses>
          <Address>
            <ID>string</ID>
            <ContactId>string</ContactId>
            <type>string</type>
            <location>string</location>
            <value>string</value>
            <priority>int</priority>
          </Address>
          <Address>
            <ID>string</ID>
            <ContactId>string</ContactId>
            <type>string</type>
            <location>string</location>
            <value>string</value>
            <priority>int</priority>
          </Address>
        </addresses>
        <attributes>
          <Attribute>
            <ID>string</ID>
            <ContactId>string</ContactId>
            <name>string</name>
            <value>string</value>
          </Attribute>
          <Attribute>
            <ID>string</ID>
            <ContactId>string</ContactId>
            <name>string</name>
            <value>string</value>
          </Attribute>
        </attributes>
        <groups>
          <Group>
            <ID>string</ID>
            <type>string</type>
            <name>string</name>
          </Group>
          <Group>
            <ID>string</ID>
            <type>string</type>
            <name>string</name>
          </Group>
        </groups>
        <groupMembership>
          <Membership>
            <ID>string</ID>
            <ContactId>string</ContactId>
            <GroupId>string</GroupId>
          </Membership>
          <Membership>
            <ID>string</ID>
            <ContactId>string</ContactId>
            <GroupId>string</GroupId>
          </Membership>
        </groupMembership>
        <relationships>
          <Relationship>
            <ID>string</ID>
            <ContactId1>string</ContactId1>
            <ContactId2>string</ContactId2>
            <Relation>string</Relation>
            <Priority>int</Priority>
            <ReceiveCorrespondence>boolean</ReceiveCorrespondence>
          </Relationship>
          <Relationship>
            <ID>string</ID>
            <ContactId1>string</ContactId1>
            <ContactId2>string</ContactId2>
            <Relation>string</Relation>
            <Priority>int</Priority>
            <ReceiveCorrespondence>boolean</ReceiveCorrespondence>
          </Relationship>
        </relationships>
        <attendanceCodes>
          <AttendanceCode>
            <AttendCode>string</AttendCode>
            <Description>string</Description>
            <StatisticalMeaning>string</StatisticalMeaning>
          </AttendanceCode>
          <AttendanceCode>
            <AttendCode>string</AttendCode>
            <Description>string</Description>
            <StatisticalMeaning>string</StatisticalMeaning>
          </AttendanceCode>
        </attendanceCodes>
        <customMessageTemplates>
          <CustomMessageTemplate>
            <MessageType>string</MessageType>
            <SavedAsName>string</SavedAsName>
            <SavedAsFolder>string</SavedAsFolder>
            <SMSHeader>string</SMSHeader>
            <SMSMessage>string</SMSMessage>
            <EmailSubject>string</EmailSubject>
            <EmailMessage>string</EmailMessage>
          </CustomMessageTemplate>
          <CustomMessageTemplate>
            <MessageType>string</MessageType>
            <SavedAsName>string</SavedAsName>
            <SavedAsFolder>string</SavedAsFolder>
            <SMSHeader>string</SMSHeader>
            <SMSMessage>string</SMSMessage>
            <EmailSubject>string</EmailSubject>
            <EmailMessage>string</EmailMessage>
          </CustomMessageTemplate>
        </customMessageTemplates>
        <postalAddresses>
          <PostalAddress>
            <AddressId>string</AddressId>
            <Addressblock>string</Addressblock>
            <PostCode>string</PostCode>
          </PostalAddress>
          <PostalAddress>
            <AddressId>string</AddressId>
            <Addressblock>string</Addressblock>
            <PostCode>string</PostCode>
          </PostalAddress>
        </postalAddresses>
        <postalAddressLinks>
          <PostalAddressLink>
            <AddressLinkId>string</AddressLinkId>
            <Id>string</Id>
            <AddressId>string</AddressId>
          </PostalAddressLink>
          <PostalAddressLink>
            <AddressLinkId>string</AddressLinkId>
            <Id>string</Id>
            <AddressId>string</AddressId>
          </PostalAddressLink>
        </postalAddressLinks>
      </crud>
    </dataChange>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <dataChangeResponse xmlns="http://alert.groupcall.com/">
      <dataChangeResult>string</dataChangeResult>
    </dataChangeResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /WebServices/Data.asmx HTTP/1.1
Host: alert.groupcall.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <dataChange xmlns="http://alert.groupcall.com/">
      <crud>
        <username>string</username>
        <password>string</password>
        <APIKey>string</APIKey>
        <metaData>string</metaData>
        <type>Add or Update or Delete</type>
        <contacts>
          <Contact>
            <ID>string</ID>
            <forename>string</forename>
            <surname>string</surname>
            <name>string</name>
            <contacttype>string</contacttype>
          </Contact>
          <Contact>
            <ID>string</ID>
            <forename>string</forename>
            <surname>string</surname>
            <name>string</name>
            <contacttype>string</contacttype>
          </Contact>
        </contacts>
        <addresses>
          <Address>
            <ID>string</ID>
            <ContactId>string</ContactId>
            <type>string</type>
            <location>string</location>
            <value>string</value>
            <priority>int</priority>
          </Address>
          <Address>
            <ID>string</ID>
            <ContactId>string</ContactId>
            <type>string</type>
            <location>string</location>
            <value>string</value>
            <priority>int</priority>
          </Address>
        </addresses>
        <attributes>
          <Attribute>
            <ID>string</ID>
            <ContactId>string</ContactId>
            <name>string</name>
            <value>string</value>
          </Attribute>
          <Attribute>
            <ID>string</ID>
            <ContactId>string</ContactId>
            <name>string</name>
            <value>string</value>
          </Attribute>
        </attributes>
        <groups>
          <Group>
            <ID>string</ID>
            <type>string</type>
            <name>string</name>
          </Group>
          <Group>
            <ID>string</ID>
            <type>string</type>
            <name>string</name>
          </Group>
        </groups>
        <groupMembership>
          <Membership>
            <ID>string</ID>
            <ContactId>string</ContactId>
            <GroupId>string</GroupId>
          </Membership>
          <Membership>
            <ID>string</ID>
            <ContactId>string</ContactId>
            <GroupId>string</GroupId>
          </Membership>
        </groupMembership>
        <relationships>
          <Relationship>
            <ID>string</ID>
            <ContactId1>string</ContactId1>
            <ContactId2>string</ContactId2>
            <Relation>string</Relation>
            <Priority>int</Priority>
            <ReceiveCorrespondence>boolean</ReceiveCorrespondence>
          </Relationship>
          <Relationship>
            <ID>string</ID>
            <ContactId1>string</ContactId1>
            <ContactId2>string</ContactId2>
            <Relation>string</Relation>
            <Priority>int</Priority>
            <ReceiveCorrespondence>boolean</ReceiveCorrespondence>
          </Relationship>
        </relationships>
        <attendanceCodes>
          <AttendanceCode>
            <AttendCode>string</AttendCode>
            <Description>string</Description>
            <StatisticalMeaning>string</StatisticalMeaning>
          </AttendanceCode>
          <AttendanceCode>
            <AttendCode>string</AttendCode>
            <Description>string</Description>
            <StatisticalMeaning>string</StatisticalMeaning>
          </AttendanceCode>
        </attendanceCodes>
        <customMessageTemplates>
          <CustomMessageTemplate>
            <MessageType>string</MessageType>
            <SavedAsName>string</SavedAsName>
            <SavedAsFolder>string</SavedAsFolder>
            <SMSHeader>string</SMSHeader>
            <SMSMessage>string</SMSMessage>
            <EmailSubject>string</EmailSubject>
            <EmailMessage>string</EmailMessage>
          </CustomMessageTemplate>
          <CustomMessageTemplate>
            <MessageType>string</MessageType>
            <SavedAsName>string</SavedAsName>
            <SavedAsFolder>string</SavedAsFolder>
            <SMSHeader>string</SMSHeader>
            <SMSMessage>string</SMSMessage>
            <EmailSubject>string</EmailSubject>
            <EmailMessage>string</EmailMessage>
          </CustomMessageTemplate>
        </customMessageTemplates>
        <postalAddresses>
          <PostalAddress>
            <AddressId>string</AddressId>
            <Addressblock>string</Addressblock>
            <PostCode>string</PostCode>
          </PostalAddress>
          <PostalAddress>
            <AddressId>string</AddressId>
            <Addressblock>string</Addressblock>
            <PostCode>string</PostCode>
          </PostalAddress>
        </postalAddresses>
        <postalAddressLinks>
          <PostalAddressLink>
            <AddressLinkId>string</AddressLinkId>
            <Id>string</Id>
            <AddressId>string</AddressId>
          </PostalAddressLink>
          <PostalAddressLink>
            <AddressLinkId>string</AddressLinkId>
            <Id>string</Id>
            <AddressId>string</AddressId>
          </PostalAddressLink>
        </postalAddressLinks>
      </crud>
    </dataChange>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <dataChangeResponse xmlns="http://alert.groupcall.com/">
      <dataChangeResult>string</dataChangeResult>
    </dataChangeResponse>
  </soap12:Body>
</soap12:Envelope>