POST api/Village/{village}/Contacts/Import
Import multiple contacts
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
village | string |
None. |
Body Parameters
Collection of 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
Sample:
[ { "PhoneNumbers": [ { "PhoneNumber": "sample string 1", "ContactInfoTypeId": "9346cf77-8860-4958-bb76-1046bb4b625a" }, { "PhoneNumber": "sample string 1", "ContactInfoTypeId": "9346cf77-8860-4958-bb76-1046bb4b625a" } ], "Emails": [ { "Email": "sample string 1", "ContactInfoTypeId": "a1d0f77c-962a-4364-bd60-aa85018b9307" }, { "Email": "sample string 1", "ContactInfoTypeId": "a1d0f77c-962a-4364-bd60-aa85018b9307" } ], "Addresses": [ { "ContactInfoTypeId": "18472829-1450-4882-ae32-04091c0fd99e", "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": "18472829-1450-4882-ae32-04091c0fd99e", "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": "572d01fd-02b9-4690-b603-2dc6104321c9", "Description": "sample string 2", "Emergency": true, "AdditionalInfo": "sample string 4" }, { "PhoneNumbers": [ { "PhoneNumber": "sample string 1", "ContactInfoTypeId": "9346cf77-8860-4958-bb76-1046bb4b625a" }, { "PhoneNumber": "sample string 1", "ContactInfoTypeId": "9346cf77-8860-4958-bb76-1046bb4b625a" } ], "Emails": [ { "Email": "sample string 1", "ContactInfoTypeId": "a1d0f77c-962a-4364-bd60-aa85018b9307" }, { "Email": "sample string 1", "ContactInfoTypeId": "a1d0f77c-962a-4364-bd60-aa85018b9307" } ], "Addresses": [ { "ContactInfoTypeId": "18472829-1450-4882-ae32-04091c0fd99e", "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": "18472829-1450-4882-ae32-04091c0fd99e", "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": "572d01fd-02b9-4690-b603-2dc6104321c9", "Description": "sample string 2", "Emergency": true, "AdditionalInfo": "sample string 4" } ]
application/xml, text/xml
Sample:
<ArrayOfContactCreateModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Shared.Implementation.Models"> <ContactCreateModel> <AdditionalInfo>sample string 4</AdditionalInfo> <CategoryId>572d01fd-02b9-4690-b603-2dc6104321c9</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>18472829-1450-4882-ae32-04091c0fd99e</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>18472829-1450-4882-ae32-04091c0fd99e</ContactInfoTypeId> </ContactAddressCreateModel> </Addresses> <Emails> <ContactEmailCreateModel> <ContactInfoTypeId>a1d0f77c-962a-4364-bd60-aa85018b9307</ContactInfoTypeId> <Email>sample string 1</Email> </ContactEmailCreateModel> <ContactEmailCreateModel> <ContactInfoTypeId>a1d0f77c-962a-4364-bd60-aa85018b9307</ContactInfoTypeId> <Email>sample string 1</Email> </ContactEmailCreateModel> </Emails> <PhoneNumbers> <ContactPhoneCreateModel> <ContactInfoTypeId>9346cf77-8860-4958-bb76-1046bb4b625a</ContactInfoTypeId> <PhoneNumber>sample string 1</PhoneNumber> </ContactPhoneCreateModel> <ContactPhoneCreateModel> <ContactInfoTypeId>9346cf77-8860-4958-bb76-1046bb4b625a</ContactInfoTypeId> <PhoneNumber>sample string 1</PhoneNumber> </ContactPhoneCreateModel> </PhoneNumbers> </ContactCreateModel> <ContactCreateModel> <AdditionalInfo>sample string 4</AdditionalInfo> <CategoryId>572d01fd-02b9-4690-b603-2dc6104321c9</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>18472829-1450-4882-ae32-04091c0fd99e</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>18472829-1450-4882-ae32-04091c0fd99e</ContactInfoTypeId> </ContactAddressCreateModel> </Addresses> <Emails> <ContactEmailCreateModel> <ContactInfoTypeId>a1d0f77c-962a-4364-bd60-aa85018b9307</ContactInfoTypeId> <Email>sample string 1</Email> </ContactEmailCreateModel> <ContactEmailCreateModel> <ContactInfoTypeId>a1d0f77c-962a-4364-bd60-aa85018b9307</ContactInfoTypeId> <Email>sample string 1</Email> </ContactEmailCreateModel> </Emails> <PhoneNumbers> <ContactPhoneCreateModel> <ContactInfoTypeId>9346cf77-8860-4958-bb76-1046bb4b625a</ContactInfoTypeId> <PhoneNumber>sample string 1</PhoneNumber> </ContactPhoneCreateModel> <ContactPhoneCreateModel> <ContactInfoTypeId>9346cf77-8860-4958-bb76-1046bb4b625a</ContactInfoTypeId> <PhoneNumber>sample string 1</PhoneNumber> </ContactPhoneCreateModel> </PhoneNumbers> </ContactCreateModel> </ArrayOfContactCreateModel>
multipart/form-data
Sample:
Response Information
Resource Description
ContactImportResultsModelName | Description | Type | Additional information |
---|---|---|---|
Errors |
Number of contacts which could not be imported |
integer |
None. |
Success |
Successfully created contacts |
Collection of ContactViewModel |
None. |
Response Formats
application/json, text/json
Sample:
{ "Errors": 1, "Success": [ { "ContactId": "e01f3097-5304-49b8-80b7-5c33a9b25ce0", "VillageId": "54c15cce-cffb-470e-b3c3-ac060766263d", "Category": "sample string 3", "Emails": [ { "ContactEmailId": "ad34c13c-dd09-4baa-b9dc-4ce05a88c890", "Type": "sample string 2", "Email": "sample string 3", "ContactInfoTypeId": "ae4fbe9a-570e-4798-b071-3e1b089439ce" }, { "ContactEmailId": "ad34c13c-dd09-4baa-b9dc-4ce05a88c890", "Type": "sample string 2", "Email": "sample string 3", "ContactInfoTypeId": "ae4fbe9a-570e-4798-b071-3e1b089439ce" } ], "PhoneNumbers": [ { "ContactPhoneId": "913d9e56-3e49-4246-b771-252e6f751402", "Type": "sample string 2", "PhoneNumber": "sample string 3", "ContactInfoTypeId": "d49e017c-f265-4d5b-aff7-9dbabb3328e9" }, { "ContactPhoneId": "913d9e56-3e49-4246-b771-252e6f751402", "Type": "sample string 2", "PhoneNumber": "sample string 3", "ContactInfoTypeId": "d49e017c-f265-4d5b-aff7-9dbabb3328e9" } ], "Addresses": [ { "ContactAddressId": "838ee23c-72e8-471a-91b4-c4383311e9d7", "Type": "sample string 2", "ContactInfoTypeId": "d7160622-e9ff-450e-94d3-ca02bd4ede51", "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": "838ee23c-72e8-471a-91b4-c4383311e9d7", "Type": "sample string 2", "ContactInfoTypeId": "d7160622-e9ff-450e-94d3-ca02bd4ede51", "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": "ddea72dc-ef4d-4b28-a0c9-65de4f277eb9", "Description": "sample string 5", "Emergency": true, "AdditionalInfo": "sample string 7" }, { "ContactId": "e01f3097-5304-49b8-80b7-5c33a9b25ce0", "VillageId": "54c15cce-cffb-470e-b3c3-ac060766263d", "Category": "sample string 3", "Emails": [ { "ContactEmailId": "ad34c13c-dd09-4baa-b9dc-4ce05a88c890", "Type": "sample string 2", "Email": "sample string 3", "ContactInfoTypeId": "ae4fbe9a-570e-4798-b071-3e1b089439ce" }, { "ContactEmailId": "ad34c13c-dd09-4baa-b9dc-4ce05a88c890", "Type": "sample string 2", "Email": "sample string 3", "ContactInfoTypeId": "ae4fbe9a-570e-4798-b071-3e1b089439ce" } ], "PhoneNumbers": [ { "ContactPhoneId": "913d9e56-3e49-4246-b771-252e6f751402", "Type": "sample string 2", "PhoneNumber": "sample string 3", "ContactInfoTypeId": "d49e017c-f265-4d5b-aff7-9dbabb3328e9" }, { "ContactPhoneId": "913d9e56-3e49-4246-b771-252e6f751402", "Type": "sample string 2", "PhoneNumber": "sample string 3", "ContactInfoTypeId": "d49e017c-f265-4d5b-aff7-9dbabb3328e9" } ], "Addresses": [ { "ContactAddressId": "838ee23c-72e8-471a-91b4-c4383311e9d7", "Type": "sample string 2", "ContactInfoTypeId": "d7160622-e9ff-450e-94d3-ca02bd4ede51", "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": "838ee23c-72e8-471a-91b4-c4383311e9d7", "Type": "sample string 2", "ContactInfoTypeId": "d7160622-e9ff-450e-94d3-ca02bd4ede51", "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": "ddea72dc-ef4d-4b28-a0c9-65de4f277eb9", "Description": "sample string 5", "Emergency": true, "AdditionalInfo": "sample string 7" } ] }
application/xml, text/xml
Sample:
<ContactImportResultsModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Shared.Implementation.Models"> <Errors>1</Errors> <Success> <ContactViewModel> <AdditionalInfo>sample string 7</AdditionalInfo> <CategoryId>ddea72dc-ef4d-4b28-a0c9-65de4f277eb9</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>d7160622-e9ff-450e-94d3-ca02bd4ede51</ContactInfoTypeId> <ContactAddressId>838ee23c-72e8-471a-91b4-c4383311e9d7</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>d7160622-e9ff-450e-94d3-ca02bd4ede51</ContactInfoTypeId> <ContactAddressId>838ee23c-72e8-471a-91b4-c4383311e9d7</ContactAddressId> <Type>sample string 2</Type> </ContactAddressViewModel> </Addresses> <Category>sample string 3</Category> <ContactId>e01f3097-5304-49b8-80b7-5c33a9b25ce0</ContactId> <Emails> <ContactEmailViewModel> <ContactInfoTypeId>ae4fbe9a-570e-4798-b071-3e1b089439ce</ContactInfoTypeId> <Email>sample string 3</Email> <ContactEmailId>ad34c13c-dd09-4baa-b9dc-4ce05a88c890</ContactEmailId> <Type>sample string 2</Type> </ContactEmailViewModel> <ContactEmailViewModel> <ContactInfoTypeId>ae4fbe9a-570e-4798-b071-3e1b089439ce</ContactInfoTypeId> <Email>sample string 3</Email> <ContactEmailId>ad34c13c-dd09-4baa-b9dc-4ce05a88c890</ContactEmailId> <Type>sample string 2</Type> </ContactEmailViewModel> </Emails> <PhoneNumbers> <ContactPhoneViewModel> <ContactInfoTypeId>d49e017c-f265-4d5b-aff7-9dbabb3328e9</ContactInfoTypeId> <PhoneNumber>sample string 3</PhoneNumber> <ContactPhoneId>913d9e56-3e49-4246-b771-252e6f751402</ContactPhoneId> <Type>sample string 2</Type> </ContactPhoneViewModel> <ContactPhoneViewModel> <ContactInfoTypeId>d49e017c-f265-4d5b-aff7-9dbabb3328e9</ContactInfoTypeId> <PhoneNumber>sample string 3</PhoneNumber> <ContactPhoneId>913d9e56-3e49-4246-b771-252e6f751402</ContactPhoneId> <Type>sample string 2</Type> </ContactPhoneViewModel> </PhoneNumbers> <VillageId>54c15cce-cffb-470e-b3c3-ac060766263d</VillageId> </ContactViewModel> <ContactViewModel> <AdditionalInfo>sample string 7</AdditionalInfo> <CategoryId>ddea72dc-ef4d-4b28-a0c9-65de4f277eb9</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>d7160622-e9ff-450e-94d3-ca02bd4ede51</ContactInfoTypeId> <ContactAddressId>838ee23c-72e8-471a-91b4-c4383311e9d7</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>d7160622-e9ff-450e-94d3-ca02bd4ede51</ContactInfoTypeId> <ContactAddressId>838ee23c-72e8-471a-91b4-c4383311e9d7</ContactAddressId> <Type>sample string 2</Type> </ContactAddressViewModel> </Addresses> <Category>sample string 3</Category> <ContactId>e01f3097-5304-49b8-80b7-5c33a9b25ce0</ContactId> <Emails> <ContactEmailViewModel> <ContactInfoTypeId>ae4fbe9a-570e-4798-b071-3e1b089439ce</ContactInfoTypeId> <Email>sample string 3</Email> <ContactEmailId>ad34c13c-dd09-4baa-b9dc-4ce05a88c890</ContactEmailId> <Type>sample string 2</Type> </ContactEmailViewModel> <ContactEmailViewModel> <ContactInfoTypeId>ae4fbe9a-570e-4798-b071-3e1b089439ce</ContactInfoTypeId> <Email>sample string 3</Email> <ContactEmailId>ad34c13c-dd09-4baa-b9dc-4ce05a88c890</ContactEmailId> <Type>sample string 2</Type> </ContactEmailViewModel> </Emails> <PhoneNumbers> <ContactPhoneViewModel> <ContactInfoTypeId>d49e017c-f265-4d5b-aff7-9dbabb3328e9</ContactInfoTypeId> <PhoneNumber>sample string 3</PhoneNumber> <ContactPhoneId>913d9e56-3e49-4246-b771-252e6f751402</ContactPhoneId> <Type>sample string 2</Type> </ContactPhoneViewModel> <ContactPhoneViewModel> <ContactInfoTypeId>d49e017c-f265-4d5b-aff7-9dbabb3328e9</ContactInfoTypeId> <PhoneNumber>sample string 3</PhoneNumber> <ContactPhoneId>913d9e56-3e49-4246-b771-252e6f751402</ContactPhoneId> <Type>sample string 2</Type> </ContactPhoneViewModel> </PhoneNumbers> <VillageId>54c15cce-cffb-470e-b3c3-ac060766263d</VillageId> </ContactViewModel> </Success> </ContactImportResultsModel>