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

NameDescriptionTypeAdditional information
id

string

None.

Body Parameters

AddUserContactItemViewModel
NameDescriptionTypeAdditional 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

Sample:
{
  "UserId": "1bacf10b-5bcc-47d2-b893-9e9fa8ca702b",
  "ContactSubType": "a47bb013-594b-4de8-b535-f23b99778029",
  "Value": "sample string 3",
  "IsDefault": true
}

application/xml, text/xml

Sample:
<AddUserContactItemViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers">
  <ContactSubType>a47bb013-594b-4de8-b535-f23b99778029</ContactSubType>
  <IsDefault>true</IsDefault>
  <UserId>1bacf10b-5bcc-47d2-b893-9e9fa8ca702b</UserId>
  <Value>sample string 3</Value>
</AddUserContactItemViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResultWithGuid
NameDescriptionTypeAdditional 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

Sample:
{
  "Value": "22d1a502-44be-4698-8570-3e8fe3cde592",
  "ResultCode": 2,
  "Description": "sample string 3"
}

application/xml, text/xml

Sample:
<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>22d1a502-44be-4698-8570-3e8fe3cde592</Value>
</ResultWithGuid>