PUT api/Village/{village}/Contacts/{id}
Edit an existing contact
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
ID of the contact to edit |
globally unique identifier |
Required |
village | string |
None. |
Body Parameters
ContactEditModelName | Description | Type | Additional information |
---|---|---|---|
ContactId |
Contact's unique ID |
globally unique identifier |
None. |
PhoneNumbers |
Phone Numbers |
Collection of ContactEditPhoneModel |
None. |
Emails |
Email Addresses |
Collection of ContactEditEmailModel |
None. |
Addresses |
Addresses |
Collection of ContactEditAddressModel |
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
{ "ContactId": "c003a8bf-a459-49dd-9371-13fbd28df395", "PhoneNumbers": [ { "ContactPhoneId": "83933365-69b4-40a3-b172-cbcf6662eac2", "PhoneNumber": "sample string 1", "ContactInfoTypeId": "40fdb2d9-3e4a-499a-bcdb-ec26ec33c55d" }, { "ContactPhoneId": "83933365-69b4-40a3-b172-cbcf6662eac2", "PhoneNumber": "sample string 1", "ContactInfoTypeId": "40fdb2d9-3e4a-499a-bcdb-ec26ec33c55d" } ], "Emails": [ { "ContactEmailId": "cd7670bc-4346-487f-a69f-7305136ecebc", "Email": "sample string 1", "ContactInfoTypeId": "c9aa8d15-7ae1-4991-aa9e-1ecf3f4dd095" }, { "ContactEmailId": "cd7670bc-4346-487f-a69f-7305136ecebc", "Email": "sample string 1", "ContactInfoTypeId": "c9aa8d15-7ae1-4991-aa9e-1ecf3f4dd095" } ], "Addresses": [ { "ContactAddressId": "4b648a2a-563a-45e0-8d5c-9668b4e16ca0", "ContactInfoTypeId": "d48f5459-0b19-4a8f-81aa-80e9b9f93464", "Address1": "sample string 1", "Address2": "sample string 2", "City": "sample string 3", "State": "sample string 4", "Zip": "sample string 5", "Country": "sample string 6" }, { "ContactAddressId": "4b648a2a-563a-45e0-8d5c-9668b4e16ca0", "ContactInfoTypeId": "d48f5459-0b19-4a8f-81aa-80e9b9f93464", "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 2", "CategoryId": "9c9ab6e7-6f50-420c-8510-ece1dfae46bb", "Description": "sample string 3", "Emergency": true, "AdditionalInfo": "sample string 5" }
application/xml, text/xml
<ContactEditModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Shared.Implementation.Models"> <AdditionalInfo>sample string 5</AdditionalInfo> <CategoryId>9c9ab6e7-6f50-420c-8510-ece1dfae46bb</CategoryId> <Description>sample string 3</Description> <Emergency>true</Emergency> <Name>sample string 2</Name> <Addresses> <ContactEditAddressModel> <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>d48f5459-0b19-4a8f-81aa-80e9b9f93464</ContactInfoTypeId> <ContactAddressId>4b648a2a-563a-45e0-8d5c-9668b4e16ca0</ContactAddressId> </ContactEditAddressModel> <ContactEditAddressModel> <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>d48f5459-0b19-4a8f-81aa-80e9b9f93464</ContactInfoTypeId> <ContactAddressId>4b648a2a-563a-45e0-8d5c-9668b4e16ca0</ContactAddressId> </ContactEditAddressModel> </Addresses> <ContactId>c003a8bf-a459-49dd-9371-13fbd28df395</ContactId> <Emails> <ContactEditEmailModel> <ContactInfoTypeId>c9aa8d15-7ae1-4991-aa9e-1ecf3f4dd095</ContactInfoTypeId> <Email>sample string 1</Email> <ContactEmailId>cd7670bc-4346-487f-a69f-7305136ecebc</ContactEmailId> </ContactEditEmailModel> <ContactEditEmailModel> <ContactInfoTypeId>c9aa8d15-7ae1-4991-aa9e-1ecf3f4dd095</ContactInfoTypeId> <Email>sample string 1</Email> <ContactEmailId>cd7670bc-4346-487f-a69f-7305136ecebc</ContactEmailId> </ContactEditEmailModel> </Emails> <PhoneNumbers> <ContactEditPhoneModel> <ContactInfoTypeId>40fdb2d9-3e4a-499a-bcdb-ec26ec33c55d</ContactInfoTypeId> <PhoneNumber>sample string 1</PhoneNumber> <ContactPhoneId>83933365-69b4-40a3-b172-cbcf6662eac2</ContactPhoneId> </ContactEditPhoneModel> <ContactEditPhoneModel> <ContactInfoTypeId>40fdb2d9-3e4a-499a-bcdb-ec26ec33c55d</ContactInfoTypeId> <PhoneNumber>sample string 1</PhoneNumber> <ContactPhoneId>83933365-69b4-40a3-b172-cbcf6662eac2</ContactPhoneId> </ContactEditPhoneModel> </PhoneNumbers> </ContactEditModel>
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": "8222f682-6caa-42b0-91d3-ef58f8796417", "VillageId": "083eece2-2f8b-4579-a2db-1bc95f189c90", "Category": "sample string 3", "Emails": [ { "ContactEmailId": "b34b03bf-35b5-4a58-ad5d-39f7d8c1c615", "Type": "sample string 2", "Email": "sample string 3", "ContactInfoTypeId": "b1136da5-c055-459b-b2be-b0f1668bdc9f" }, { "ContactEmailId": "b34b03bf-35b5-4a58-ad5d-39f7d8c1c615", "Type": "sample string 2", "Email": "sample string 3", "ContactInfoTypeId": "b1136da5-c055-459b-b2be-b0f1668bdc9f" } ], "PhoneNumbers": [ { "ContactPhoneId": "48b099a1-dda0-41ed-a7c5-69c40b6caa65", "Type": "sample string 2", "PhoneNumber": "sample string 3", "ContactInfoTypeId": "02bda5e7-cdae-4a2d-8a71-2059dd7a7fe6" }, { "ContactPhoneId": "48b099a1-dda0-41ed-a7c5-69c40b6caa65", "Type": "sample string 2", "PhoneNumber": "sample string 3", "ContactInfoTypeId": "02bda5e7-cdae-4a2d-8a71-2059dd7a7fe6" } ], "Addresses": [ { "ContactAddressId": "7e7ac825-7195-43be-8316-64e4f019aeec", "Type": "sample string 2", "ContactInfoTypeId": "afdd274d-4f3e-4b7f-b700-646dcc946812", "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": "7e7ac825-7195-43be-8316-64e4f019aeec", "Type": "sample string 2", "ContactInfoTypeId": "afdd274d-4f3e-4b7f-b700-646dcc946812", "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": "99edbbf7-6b0c-4ed0-a716-e359df683790", "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>99edbbf7-6b0c-4ed0-a716-e359df683790</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>afdd274d-4f3e-4b7f-b700-646dcc946812</ContactInfoTypeId> <ContactAddressId>7e7ac825-7195-43be-8316-64e4f019aeec</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>afdd274d-4f3e-4b7f-b700-646dcc946812</ContactInfoTypeId> <ContactAddressId>7e7ac825-7195-43be-8316-64e4f019aeec</ContactAddressId> <Type>sample string 2</Type> </ContactAddressViewModel> </Addresses> <Category>sample string 3</Category> <ContactId>8222f682-6caa-42b0-91d3-ef58f8796417</ContactId> <Emails> <ContactEmailViewModel> <ContactInfoTypeId>b1136da5-c055-459b-b2be-b0f1668bdc9f</ContactInfoTypeId> <Email>sample string 3</Email> <ContactEmailId>b34b03bf-35b5-4a58-ad5d-39f7d8c1c615</ContactEmailId> <Type>sample string 2</Type> </ContactEmailViewModel> <ContactEmailViewModel> <ContactInfoTypeId>b1136da5-c055-459b-b2be-b0f1668bdc9f</ContactInfoTypeId> <Email>sample string 3</Email> <ContactEmailId>b34b03bf-35b5-4a58-ad5d-39f7d8c1c615</ContactEmailId> <Type>sample string 2</Type> </ContactEmailViewModel> </Emails> <PhoneNumbers> <ContactPhoneViewModel> <ContactInfoTypeId>02bda5e7-cdae-4a2d-8a71-2059dd7a7fe6</ContactInfoTypeId> <PhoneNumber>sample string 3</PhoneNumber> <ContactPhoneId>48b099a1-dda0-41ed-a7c5-69c40b6caa65</ContactPhoneId> <Type>sample string 2</Type> </ContactPhoneViewModel> <ContactPhoneViewModel> <ContactInfoTypeId>02bda5e7-cdae-4a2d-8a71-2059dd7a7fe6</ContactInfoTypeId> <PhoneNumber>sample string 3</PhoneNumber> <ContactPhoneId>48b099a1-dda0-41ed-a7c5-69c40b6caa65</ContactPhoneId> <Type>sample string 2</Type> </ContactPhoneViewModel> </PhoneNumbers> <VillageId>083eece2-2f8b-4579-a2db-1bc95f189c90</VillageId> </ContactViewModel>