GET api/Village/{village}/Contacts
Get all contacts
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
village | string |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of 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
Sample:
[ { "ContactId": "9a2d0296-af04-4810-9921-2ed8a9efc6e2", "VillageId": "6d7287cf-d6de-4f40-a08e-4e7ddb2410f8", "Category": "sample string 3", "Emails": [ { "ContactEmailId": "6183a39c-732e-434f-9461-4f799933ea8f", "Type": "sample string 2", "Email": "sample string 3", "ContactInfoTypeId": "02da48e8-abc2-41eb-9b5a-24b1b5100136" }, { "ContactEmailId": "6183a39c-732e-434f-9461-4f799933ea8f", "Type": "sample string 2", "Email": "sample string 3", "ContactInfoTypeId": "02da48e8-abc2-41eb-9b5a-24b1b5100136" } ], "PhoneNumbers": [ { "ContactPhoneId": "615bc28f-2df3-4dbb-9c47-16127708ea60", "Type": "sample string 2", "PhoneNumber": "sample string 3", "ContactInfoTypeId": "9bdce88c-aead-408a-8e51-cc97045357fc" }, { "ContactPhoneId": "615bc28f-2df3-4dbb-9c47-16127708ea60", "Type": "sample string 2", "PhoneNumber": "sample string 3", "ContactInfoTypeId": "9bdce88c-aead-408a-8e51-cc97045357fc" } ], "Addresses": [ { "ContactAddressId": "9ea2c498-16a4-4a48-a333-ae34011ddd5c", "Type": "sample string 2", "ContactInfoTypeId": "ab8ce911-f132-44f3-8089-0bb1dfebbe31", "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": "9ea2c498-16a4-4a48-a333-ae34011ddd5c", "Type": "sample string 2", "ContactInfoTypeId": "ab8ce911-f132-44f3-8089-0bb1dfebbe31", "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": "afcd3ce6-e751-4d50-8978-263cdbd42e59", "Description": "sample string 5", "Emergency": true, "AdditionalInfo": "sample string 7" }, { "ContactId": "9a2d0296-af04-4810-9921-2ed8a9efc6e2", "VillageId": "6d7287cf-d6de-4f40-a08e-4e7ddb2410f8", "Category": "sample string 3", "Emails": [ { "ContactEmailId": "6183a39c-732e-434f-9461-4f799933ea8f", "Type": "sample string 2", "Email": "sample string 3", "ContactInfoTypeId": "02da48e8-abc2-41eb-9b5a-24b1b5100136" }, { "ContactEmailId": "6183a39c-732e-434f-9461-4f799933ea8f", "Type": "sample string 2", "Email": "sample string 3", "ContactInfoTypeId": "02da48e8-abc2-41eb-9b5a-24b1b5100136" } ], "PhoneNumbers": [ { "ContactPhoneId": "615bc28f-2df3-4dbb-9c47-16127708ea60", "Type": "sample string 2", "PhoneNumber": "sample string 3", "ContactInfoTypeId": "9bdce88c-aead-408a-8e51-cc97045357fc" }, { "ContactPhoneId": "615bc28f-2df3-4dbb-9c47-16127708ea60", "Type": "sample string 2", "PhoneNumber": "sample string 3", "ContactInfoTypeId": "9bdce88c-aead-408a-8e51-cc97045357fc" } ], "Addresses": [ { "ContactAddressId": "9ea2c498-16a4-4a48-a333-ae34011ddd5c", "Type": "sample string 2", "ContactInfoTypeId": "ab8ce911-f132-44f3-8089-0bb1dfebbe31", "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": "9ea2c498-16a4-4a48-a333-ae34011ddd5c", "Type": "sample string 2", "ContactInfoTypeId": "ab8ce911-f132-44f3-8089-0bb1dfebbe31", "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": "afcd3ce6-e751-4d50-8978-263cdbd42e59", "Description": "sample string 5", "Emergency": true, "AdditionalInfo": "sample string 7" } ]
application/xml, text/xml
Sample:
<ArrayOfContactViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Shared.Implementation.Models"> <ContactViewModel> <AdditionalInfo>sample string 7</AdditionalInfo> <CategoryId>afcd3ce6-e751-4d50-8978-263cdbd42e59</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>ab8ce911-f132-44f3-8089-0bb1dfebbe31</ContactInfoTypeId> <ContactAddressId>9ea2c498-16a4-4a48-a333-ae34011ddd5c</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>ab8ce911-f132-44f3-8089-0bb1dfebbe31</ContactInfoTypeId> <ContactAddressId>9ea2c498-16a4-4a48-a333-ae34011ddd5c</ContactAddressId> <Type>sample string 2</Type> </ContactAddressViewModel> </Addresses> <Category>sample string 3</Category> <ContactId>9a2d0296-af04-4810-9921-2ed8a9efc6e2</ContactId> <Emails> <ContactEmailViewModel> <ContactInfoTypeId>02da48e8-abc2-41eb-9b5a-24b1b5100136</ContactInfoTypeId> <Email>sample string 3</Email> <ContactEmailId>6183a39c-732e-434f-9461-4f799933ea8f</ContactEmailId> <Type>sample string 2</Type> </ContactEmailViewModel> <ContactEmailViewModel> <ContactInfoTypeId>02da48e8-abc2-41eb-9b5a-24b1b5100136</ContactInfoTypeId> <Email>sample string 3</Email> <ContactEmailId>6183a39c-732e-434f-9461-4f799933ea8f</ContactEmailId> <Type>sample string 2</Type> </ContactEmailViewModel> </Emails> <PhoneNumbers> <ContactPhoneViewModel> <ContactInfoTypeId>9bdce88c-aead-408a-8e51-cc97045357fc</ContactInfoTypeId> <PhoneNumber>sample string 3</PhoneNumber> <ContactPhoneId>615bc28f-2df3-4dbb-9c47-16127708ea60</ContactPhoneId> <Type>sample string 2</Type> </ContactPhoneViewModel> <ContactPhoneViewModel> <ContactInfoTypeId>9bdce88c-aead-408a-8e51-cc97045357fc</ContactInfoTypeId> <PhoneNumber>sample string 3</PhoneNumber> <ContactPhoneId>615bc28f-2df3-4dbb-9c47-16127708ea60</ContactPhoneId> <Type>sample string 2</Type> </ContactPhoneViewModel> </PhoneNumbers> <VillageId>6d7287cf-d6de-4f40-a08e-4e7ddb2410f8</VillageId> </ContactViewModel> <ContactViewModel> <AdditionalInfo>sample string 7</AdditionalInfo> <CategoryId>afcd3ce6-e751-4d50-8978-263cdbd42e59</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>ab8ce911-f132-44f3-8089-0bb1dfebbe31</ContactInfoTypeId> <ContactAddressId>9ea2c498-16a4-4a48-a333-ae34011ddd5c</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>ab8ce911-f132-44f3-8089-0bb1dfebbe31</ContactInfoTypeId> <ContactAddressId>9ea2c498-16a4-4a48-a333-ae34011ddd5c</ContactAddressId> <Type>sample string 2</Type> </ContactAddressViewModel> </Addresses> <Category>sample string 3</Category> <ContactId>9a2d0296-af04-4810-9921-2ed8a9efc6e2</ContactId> <Emails> <ContactEmailViewModel> <ContactInfoTypeId>02da48e8-abc2-41eb-9b5a-24b1b5100136</ContactInfoTypeId> <Email>sample string 3</Email> <ContactEmailId>6183a39c-732e-434f-9461-4f799933ea8f</ContactEmailId> <Type>sample string 2</Type> </ContactEmailViewModel> <ContactEmailViewModel> <ContactInfoTypeId>02da48e8-abc2-41eb-9b5a-24b1b5100136</ContactInfoTypeId> <Email>sample string 3</Email> <ContactEmailId>6183a39c-732e-434f-9461-4f799933ea8f</ContactEmailId> <Type>sample string 2</Type> </ContactEmailViewModel> </Emails> <PhoneNumbers> <ContactPhoneViewModel> <ContactInfoTypeId>9bdce88c-aead-408a-8e51-cc97045357fc</ContactInfoTypeId> <PhoneNumber>sample string 3</PhoneNumber> <ContactPhoneId>615bc28f-2df3-4dbb-9c47-16127708ea60</ContactPhoneId> <Type>sample string 2</Type> </ContactPhoneViewModel> <ContactPhoneViewModel> <ContactInfoTypeId>9bdce88c-aead-408a-8e51-cc97045357fc</ContactInfoTypeId> <PhoneNumber>sample string 3</PhoneNumber> <ContactPhoneId>615bc28f-2df3-4dbb-9c47-16127708ea60</ContactPhoneId> <Type>sample string 2</Type> </ContactPhoneViewModel> </PhoneNumbers> <VillageId>6d7287cf-d6de-4f40-a08e-4e7ddb2410f8</VillageId> </ContactViewModel> </ArrayOfContactViewModel>