POST api/Data/CRUD

Request Information

URI Parameters

None.

Body Parameters

CRUD

Name	Type	Additional information
username	string	None.
password	string	None.
APIKey	string	None.
metaData	string	None.
type	CRUDType	None.
contacts	Collection of Contact	None.
addresses	Collection of Address	None.
attributes	Collection of Attribute	None.
groups	Collection of Group	None.
groupMembership	Collection of Membership	None.
relationships	Collection of Relationship	None.
attendanceCodes	Collection of AttendanceCode	None.
customMessageTemplates	Collection of CustomMessageTemplate	None.
postalAddresses	Collection of PostalAddress	None.
postalAddressLinks	Collection of PostalAddressLink	None.

Request Formats

application/json, text/json

Sample:

{
  "username": "sample string 1",
  "password": "sample string 2",
  "APIKey": "sample string 3",
  "metaData": "sample string 4",
  "type": 0,
  "contacts": [
    {
      "ID": "sample string 1",
      "forename": "sample string 2",
      "surname": "sample string 3",
      "name": "sample string 4",
      "contacttype": "sample string 5"
    },
    {
      "ID": "sample string 1",
      "forename": "sample string 2",
      "surname": "sample string 3",
      "name": "sample string 4",
      "contacttype": "sample string 5"
    }
  ],
  "addresses": [
    {
      "ID": "sample string 1",
      "ContactId": "sample string 2",
      "type": "sample string 3",
      "location": "sample string 4",
      "value": "sample string 5",
      "priority": 6
    },
    {
      "ID": "sample string 1",
      "ContactId": "sample string 2",
      "type": "sample string 3",
      "location": "sample string 4",
      "value": "sample string 5",
      "priority": 6
    }
  ],
  "attributes": [
    {
      "ID": "sample string 1",
      "ContactId": "sample string 2",
      "name": "sample string 3",
      "value": "sample string 4"
    },
    {
      "ID": "sample string 1",
      "ContactId": "sample string 2",
      "name": "sample string 3",
      "value": "sample string 4"
    }
  ],
  "groups": [
    {
      "ID": "sample string 1",
      "type": "sample string 2",
      "name": "sample string 3"
    },
    {
      "ID": "sample string 1",
      "type": "sample string 2",
      "name": "sample string 3"
    }
  ],
  "groupMembership": [
    {
      "ID": "sample string 1",
      "ContactId": "sample string 2",
      "GroupId": "sample string 3"
    },
    {
      "ID": "sample string 1",
      "ContactId": "sample string 2",
      "GroupId": "sample string 3"
    }
  ],
  "relationships": [
    {
      "ID": "sample string 1",
      "ContactId1": "sample string 2",
      "ContactId2": "sample string 3",
      "Relation": "sample string 4",
      "Priority": 5,
      "ReceiveCorrespondence": true
    },
    {
      "ID": "sample string 1",
      "ContactId1": "sample string 2",
      "ContactId2": "sample string 3",
      "Relation": "sample string 4",
      "Priority": 5,
      "ReceiveCorrespondence": true
    }
  ],
  "attendanceCodes": [
    {
      "AttendCode": "sample string 1",
      "Description": "sample string 2",
      "StatisticalMeaning": "sample string 3"
    },
    {
      "AttendCode": "sample string 1",
      "Description": "sample string 2",
      "StatisticalMeaning": "sample string 3"
    }
  ],
  "customMessageTemplates": [
    {
      "MessageType": "sample string 1",
      "SavedAsName": "sample string 2",
      "SavedAsFolder": "sample string 3",
      "SMSHeader": "sample string 4",
      "SMSMessage": "sample string 5",
      "EmailSubject": "sample string 6",
      "EmailMessage": "sample string 7"
    },
    {
      "MessageType": "sample string 1",
      "SavedAsName": "sample string 2",
      "SavedAsFolder": "sample string 3",
      "SMSHeader": "sample string 4",
      "SMSMessage": "sample string 5",
      "EmailSubject": "sample string 6",
      "EmailMessage": "sample string 7"
    }
  ],
  "postalAddresses": [
    {
      "AddressId": "sample string 1",
      "Addressblock": "sample string 2",
      "PostCode": "sample string 3"
    },
    {
      "AddressId": "sample string 1",
      "Addressblock": "sample string 2",
      "PostCode": "sample string 3"
    }
  ],
  "postalAddressLinks": [
    {
      "AddressLinkId": "sample string 1",
      "Id": "sample string 2",
      "AddressId": "sample string 3"
    },
    {
      "AddressLinkId": "sample string 1",
      "Id": "sample string 2",
      "AddressId": "sample string 3"
    }
  ]
}

application/xml, text/xml

Sample:

<CRUD xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/com.groupcall.alert.azure.CRUDData">
  <APIKey>sample string 3</APIKey>
  <addresses>
    <Address>
      <ContactId>sample string 2</ContactId>
      <ID>sample string 1</ID>
      <location>sample string 4</location>
      <priority>6</priority>
      <type>sample string 3</type>
      <value>sample string 5</value>
    </Address>
    <Address>
      <ContactId>sample string 2</ContactId>
      <ID>sample string 1</ID>
      <location>sample string 4</location>
      <priority>6</priority>
      <type>sample string 3</type>
      <value>sample string 5</value>
    </Address>
  </addresses>
  <attendanceCodes>
    <AttendanceCode>
      <AttendCode>sample string 1</AttendCode>
      <Description>sample string 2</Description>
      <StatisticalMeaning>sample string 3</StatisticalMeaning>
    </AttendanceCode>
    <AttendanceCode>
      <AttendCode>sample string 1</AttendCode>
      <Description>sample string 2</Description>
      <StatisticalMeaning>sample string 3</StatisticalMeaning>
    </AttendanceCode>
  </attendanceCodes>
  <attributes>
    <Attribute>
      <ContactId>sample string 2</ContactId>
      <ID>sample string 1</ID>
      <name>sample string 3</name>
      <value>sample string 4</value>
    </Attribute>
    <Attribute>
      <ContactId>sample string 2</ContactId>
      <ID>sample string 1</ID>
      <name>sample string 3</name>
      <value>sample string 4</value>
    </Attribute>
  </attributes>
  <contacts>
    <Contact>
      <ID>sample string 1</ID>
      <contacttype>sample string 5</contacttype>
      <forename>sample string 2</forename>
      <name>sample string 4</name>
      <surname>sample string 3</surname>
    </Contact>
    <Contact>
      <ID>sample string 1</ID>
      <contacttype>sample string 5</contacttype>
      <forename>sample string 2</forename>
      <name>sample string 4</name>
      <surname>sample string 3</surname>
    </Contact>
  </contacts>
  <customMessageTemplates>
    <CustomMessageTemplate>
      <EmailMessage>sample string 7</EmailMessage>
      <EmailSubject>sample string 6</EmailSubject>
      <MessageType>sample string 1</MessageType>
      <SMSHeader>sample string 4</SMSHeader>
      <SMSMessage>sample string 5</SMSMessage>
      <SavedAsFolder>sample string 3</SavedAsFolder>
      <SavedAsName>sample string 2</SavedAsName>
    </CustomMessageTemplate>
    <CustomMessageTemplate>
      <EmailMessage>sample string 7</EmailMessage>
      <EmailSubject>sample string 6</EmailSubject>
      <MessageType>sample string 1</MessageType>
      <SMSHeader>sample string 4</SMSHeader>
      <SMSMessage>sample string 5</SMSMessage>
      <SavedAsFolder>sample string 3</SavedAsFolder>
      <SavedAsName>sample string 2</SavedAsName>
    </CustomMessageTemplate>
  </customMessageTemplates>
  <groupMembership>
    <Membership>
      <ContactId>sample string 2</ContactId>
      <GroupId>sample string 3</GroupId>
      <ID>sample string 1</ID>
    </Membership>
    <Membership>
      <ContactId>sample string 2</ContactId>
      <GroupId>sample string 3</GroupId>
      <ID>sample string 1</ID>
    </Membership>
  </groupMembership>
  <groups>
    <Group>
      <ID>sample string 1</ID>
      <name>sample string 3</name>
      <type>sample string 2</type>
    </Group>
    <Group>
      <ID>sample string 1</ID>
      <name>sample string 3</name>
      <type>sample string 2</type>
    </Group>
  </groups>
  <metaData>sample string 4</metaData>
  <password>sample string 2</password>
  <postalAddressLinks>
    <PostalAddressLink>
      <AddressId>sample string 3</AddressId>
      <AddressLinkId>sample string 1</AddressLinkId>
      <Id>sample string 2</Id>
    </PostalAddressLink>
    <PostalAddressLink>
      <AddressId>sample string 3</AddressId>
      <AddressLinkId>sample string 1</AddressLinkId>
      <Id>sample string 2</Id>
    </PostalAddressLink>
  </postalAddressLinks>
  <postalAddresses>
    <PostalAddress>
      <AddressId>sample string 1</AddressId>
      <Addressblock>sample string 2</Addressblock>
      <PostCode>sample string 3</PostCode>
    </PostalAddress>
    <PostalAddress>
      <AddressId>sample string 1</AddressId>
      <Addressblock>sample string 2</Addressblock>
      <PostCode>sample string 3</PostCode>
    </PostalAddress>
  </postalAddresses>
  <relationships>
    <Relationship>
      <ContactId1>sample string 2</ContactId1>
      <ContactId2>sample string 3</ContactId2>
      <ID>sample string 1</ID>
      <Priority>5</Priority>
      <ReceiveCorrespondence>true</ReceiveCorrespondence>
      <Relation>sample string 4</Relation>
    </Relationship>
    <Relationship>
      <ContactId1>sample string 2</ContactId1>
      <ContactId2>sample string 3</ContactId2>
      <ID>sample string 1</ID>
      <Priority>5</Priority>
      <ReceiveCorrespondence>true</ReceiveCorrespondence>
      <Relation>sample string 4</Relation>
    </Relationship>
  </relationships>
  <type>Add</type>
  <username>sample string 1</username>
</CRUD>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

string

Response Formats

application/json, text/json

Sample:

"sample string 1"

application/xml, text/xml

Sample:

<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>