POST api/v1/Users/{id}/UserContactItems
Adds a Contact Information to an existing User. Returns Success/Error code plus primary key of ContactInfo entry made.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | string |
None. |
Body Parameters
AddUserContactItemViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| UserId |
Required: The PK of the existing User that you want to add the Contact Item to. |
globally unique identifier |
None. |
| ContactSubType |
Required: The type of contact information being added - Retrieve possible values from /ContactItem/GetAllTypes |
globally unique identifier |
None. |
| Value |
Required: Represents the Contact Item value - an email address, a phone number |
string |
None. |
| IsDefault |
Required: Specifies if the Contact Item is the default method of contact for that Contact Type (default email, default phone, etc.) |
boolean |
None. |
Request Formats
application/json, text/json
{
"UserId": "a916f66d-ca59-48b9-a7bc-9391b48cf2cb",
"ContactSubType": "f570894a-d045-4a39-85a9-8a5b8b865b20",
"Value": "sample string 3",
"IsDefault": true
}
application/xml, text/xml
<AddUserContactItemViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers"> <ContactSubType>f570894a-d045-4a39-85a9-8a5b8b865b20</ContactSubType> <IsDefault>true</IsDefault> <UserId>a916f66d-ca59-48b9-a7bc-9391b48cf2cb</UserId> <Value>sample string 3</Value> </AddUserContactItemViewModel>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
ResultWithGuid| Name | Description | Type | Additional information |
|---|---|---|---|
| Value |
Represents the PK value that was created as a result of an add |
globally unique identifier |
None. |
| ResultCode |
Represents the result code |
integer |
None. |
| Description |
Represents a description of the result code |
string |
None. |
Response Formats
application/json, text/json
{
"Value": "d1e47c93-0745-426e-a42c-17e95b7a2427",
"ResultCode": 2,
"Description": "sample string 3"
}
application/xml, text/xml
<ResultWithGuid xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers"> <Description>sample string 3</Description> <HttpStatusCode>Continue</HttpStatusCode> <ResultCode>2</ResultCode> <Value>d1e47c93-0745-426e-a42c-17e95b7a2427</Value> </ResultWithGuid>