POST api/Village/{village}/Contacts
Create a new contact
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
village | string |
None. |
Body Parameters
ContactCreateModelName | Description | Type | Additional information |
---|---|---|---|
PhoneNumbers |
Contact Phone Numbers |
Collection of ContactPhoneCreateModel |
None. |
Emails |
Contact Email Addresses |
Collection of ContactEmailCreateModel |
None. |
Addresses |
Contact Addresses |
Collection of ContactAddressCreateModel |
None. |
Name |
Contact Name |
string |
Required String length: inclusive between 0 and 120 |
CategoryId |
Contact Category ID |
globally unique identifier |
None. |
Description |
Contact Category Description |
string |
String length: inclusive between 0 and 120 |
Emergency |
Whether or not this is an emergency contact |
boolean |
None. |
AdditionalInfo |
Additional Info |
string |
String length: inclusive between 0 and 1024 |
Request Formats
application/json, text/json
{ "PhoneNumbers": [ { "PhoneNumber": "sample string 1", "ContactInfoTypeId": "a43b045f-9ac2-4892-bae1-eefa0d9b3fa9" }, { "PhoneNumber": "sample string 1", "ContactInfoTypeId": "a43b045f-9ac2-4892-bae1-eefa0d9b3fa9" } ], "Emails": [ { "Email": "sample string 1", "ContactInfoTypeId": "e845e780-0863-434a-8eb0-da533e3e6473" }, { "Email": "sample string 1", "ContactInfoTypeId": "e845e780-0863-434a-8eb0-da533e3e6473" } ], "Addresses": [ { "ContactInfoTypeId": "f62dab52-15d8-47f3-82cc-717f91f3cc4e", "Address1": "sample string 1", "Address2": "sample string 2", "City": "sample string 3", "State": "sample string 4", "Zip": "sample string 5", "Country": "sample string 6" }, { "ContactInfoTypeId": "f62dab52-15d8-47f3-82cc-717f91f3cc4e", "Address1": "sample string 1", "Address2": "sample string 2", "City": "sample string 3", "State": "sample string 4", "Zip": "sample string 5", "Country": "sample string 6" } ], "Name": "sample string 1", "CategoryId": "e13ff57f-aaba-4d3b-9ce6-bef0df37c8f2", "Description": "sample string 2", "Emergency": true, "AdditionalInfo": "sample string 4" }
application/xml, text/xml
<ContactCreateModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Shared.Implementation.Models"> <AdditionalInfo>sample string 4</AdditionalInfo> <CategoryId>e13ff57f-aaba-4d3b-9ce6-bef0df37c8f2</CategoryId> <Description>sample string 2</Description> <Emergency>true</Emergency> <Name>sample string 1</Name> <Addresses> <ContactAddressCreateModel> <Address1 xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Utilities">sample string 1</Address1> <Address2 xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Utilities">sample string 2</Address2> <City xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Utilities">sample string 3</City> <Country xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Utilities">sample string 6</Country> <State xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Utilities">sample string 4</State> <Zip xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Utilities">sample string 5</Zip> <ContactInfoTypeId>f62dab52-15d8-47f3-82cc-717f91f3cc4e</ContactInfoTypeId> </ContactAddressCreateModel> <ContactAddressCreateModel> <Address1 xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Utilities">sample string 1</Address1> <Address2 xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Utilities">sample string 2</Address2> <City xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Utilities">sample string 3</City> <Country xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Utilities">sample string 6</Country> <State xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Utilities">sample string 4</State> <Zip xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Utilities">sample string 5</Zip> <ContactInfoTypeId>f62dab52-15d8-47f3-82cc-717f91f3cc4e</ContactInfoTypeId> </ContactAddressCreateModel> </Addresses> <Emails> <ContactEmailCreateModel> <ContactInfoTypeId>e845e780-0863-434a-8eb0-da533e3e6473</ContactInfoTypeId> <Email>sample string 1</Email> </ContactEmailCreateModel> <ContactEmailCreateModel> <ContactInfoTypeId>e845e780-0863-434a-8eb0-da533e3e6473</ContactInfoTypeId> <Email>sample string 1</Email> </ContactEmailCreateModel> </Emails> <PhoneNumbers> <ContactPhoneCreateModel> <ContactInfoTypeId>a43b045f-9ac2-4892-bae1-eefa0d9b3fa9</ContactInfoTypeId> <PhoneNumber>sample string 1</PhoneNumber> </ContactPhoneCreateModel> <ContactPhoneCreateModel> <ContactInfoTypeId>a43b045f-9ac2-4892-bae1-eefa0d9b3fa9</ContactInfoTypeId> <PhoneNumber>sample string 1</PhoneNumber> </ContactPhoneCreateModel> </PhoneNumbers> </ContactCreateModel>
multipart/form-data
Response Information
Resource Description
ContactViewModelName | Description | Type | Additional information |
---|---|---|---|
ContactId |
Contact's unique ID |
globally unique identifier |
None. |
VillageId |
Village's unique ID |
globally unique identifier |
None. |
Category |
Contact Category Name |
string |
None. |
Emails |
Collection of Email Addresses |
Collection of ContactEmailViewModel |
None. |
PhoneNumbers |
Collection of Phone Numbers |
Collection of ContactPhoneViewModel |
None. |
Addresses |
Collection of Addresses |
Collection of ContactAddressViewModel |
None. |
Name |
Contact Name |
string |
Required String length: inclusive between 0 and 120 |
CategoryId |
Contact Category ID |
globally unique identifier |
None. |
Description |
Contact Category Description |
string |
String length: inclusive between 0 and 120 |
Emergency |
Whether or not this is an emergency contact |
boolean |
None. |
AdditionalInfo |
Additional Info |
string |
String length: inclusive between 0 and 1024 |
Response Formats
application/json, text/json
{ "ContactId": "c71b8e92-7784-4e7a-9831-242a774b0156", "VillageId": "d7a8aa33-61bf-426a-b2a6-97d252bdd7a7", "Category": "sample string 3", "Emails": [ { "ContactEmailId": "1199210a-7dea-4f0b-aab2-27ab7b8a110f", "Type": "sample string 2", "Email": "sample string 3", "ContactInfoTypeId": "9208da3f-c6c2-466d-b436-5a04737a967a" }, { "ContactEmailId": "1199210a-7dea-4f0b-aab2-27ab7b8a110f", "Type": "sample string 2", "Email": "sample string 3", "ContactInfoTypeId": "9208da3f-c6c2-466d-b436-5a04737a967a" } ], "PhoneNumbers": [ { "ContactPhoneId": "6a2559aa-cc5a-4e0a-a593-b4807632cfb2", "Type": "sample string 2", "PhoneNumber": "sample string 3", "ContactInfoTypeId": "0698fe28-5237-44c6-ab1a-ffcc915cf99a" }, { "ContactPhoneId": "6a2559aa-cc5a-4e0a-a593-b4807632cfb2", "Type": "sample string 2", "PhoneNumber": "sample string 3", "ContactInfoTypeId": "0698fe28-5237-44c6-ab1a-ffcc915cf99a" } ], "Addresses": [ { "ContactAddressId": "f0a14794-ccb9-4e38-8c2b-73a797b75e4a", "Type": "sample string 2", "ContactInfoTypeId": "14aa9688-2e11-4491-aca6-94e9ee6da992", "Address1": "sample string 3", "Address2": "sample string 4", "City": "sample string 5", "State": "sample string 6", "Zip": "sample string 7", "Country": "sample string 8" }, { "ContactAddressId": "f0a14794-ccb9-4e38-8c2b-73a797b75e4a", "Type": "sample string 2", "ContactInfoTypeId": "14aa9688-2e11-4491-aca6-94e9ee6da992", "Address1": "sample string 3", "Address2": "sample string 4", "City": "sample string 5", "State": "sample string 6", "Zip": "sample string 7", "Country": "sample string 8" } ], "Name": "sample string 4", "CategoryId": "c03ef363-fc13-46ec-ade1-6ebb4dd7472b", "Description": "sample string 5", "Emergency": true, "AdditionalInfo": "sample string 7" }
application/xml, text/xml
<ContactViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Shared.Implementation.Models"> <AdditionalInfo>sample string 7</AdditionalInfo> <CategoryId>c03ef363-fc13-46ec-ade1-6ebb4dd7472b</CategoryId> <Description>sample string 5</Description> <Emergency>true</Emergency> <Name>sample string 4</Name> <Addresses> <ContactAddressViewModel> <Address1 xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Utilities">sample string 3</Address1> <Address2 xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Utilities">sample string 4</Address2> <City xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Utilities">sample string 5</City> <Country xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Utilities">sample string 8</Country> <State xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Utilities">sample string 6</State> <Zip xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Utilities">sample string 7</Zip> <ContactInfoTypeId>14aa9688-2e11-4491-aca6-94e9ee6da992</ContactInfoTypeId> <ContactAddressId>f0a14794-ccb9-4e38-8c2b-73a797b75e4a</ContactAddressId> <Type>sample string 2</Type> </ContactAddressViewModel> <ContactAddressViewModel> <Address1 xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Utilities">sample string 3</Address1> <Address2 xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Utilities">sample string 4</Address2> <City xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Utilities">sample string 5</City> <Country xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Utilities">sample string 8</Country> <State xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Utilities">sample string 6</State> <Zip xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Utilities">sample string 7</Zip> <ContactInfoTypeId>14aa9688-2e11-4491-aca6-94e9ee6da992</ContactInfoTypeId> <ContactAddressId>f0a14794-ccb9-4e38-8c2b-73a797b75e4a</ContactAddressId> <Type>sample string 2</Type> </ContactAddressViewModel> </Addresses> <Category>sample string 3</Category> <ContactId>c71b8e92-7784-4e7a-9831-242a774b0156</ContactId> <Emails> <ContactEmailViewModel> <ContactInfoTypeId>9208da3f-c6c2-466d-b436-5a04737a967a</ContactInfoTypeId> <Email>sample string 3</Email> <ContactEmailId>1199210a-7dea-4f0b-aab2-27ab7b8a110f</ContactEmailId> <Type>sample string 2</Type> </ContactEmailViewModel> <ContactEmailViewModel> <ContactInfoTypeId>9208da3f-c6c2-466d-b436-5a04737a967a</ContactInfoTypeId> <Email>sample string 3</Email> <ContactEmailId>1199210a-7dea-4f0b-aab2-27ab7b8a110f</ContactEmailId> <Type>sample string 2</Type> </ContactEmailViewModel> </Emails> <PhoneNumbers> <ContactPhoneViewModel> <ContactInfoTypeId>0698fe28-5237-44c6-ab1a-ffcc915cf99a</ContactInfoTypeId> <PhoneNumber>sample string 3</PhoneNumber> <ContactPhoneId>6a2559aa-cc5a-4e0a-a593-b4807632cfb2</ContactPhoneId> <Type>sample string 2</Type> </ContactPhoneViewModel> <ContactPhoneViewModel> <ContactInfoTypeId>0698fe28-5237-44c6-ab1a-ffcc915cf99a</ContactInfoTypeId> <PhoneNumber>sample string 3</PhoneNumber> <ContactPhoneId>6a2559aa-cc5a-4e0a-a593-b4807632cfb2</ContactPhoneId> <Type>sample string 2</Type> </ContactPhoneViewModel> </PhoneNumbers> <VillageId>d7a8aa33-61bf-426a-b2a6-97d252bdd7a7</VillageId> </ContactViewModel>