RemoveUserContactItem
Overview
Removes Contact Information from an existing User. Returns Success/Error code.
Request Information
Method
POST - api/Person/RemoveUserContactItem
URI Parameters
None.
Body Parameters
RemoveUserContactItemViewModel
Name | Description | Type | Additional information |
---|---|---|---|
UserId |
Required: The PK of the existing User that you want to remove the Contact Item from. |
globally unique identifier |
None. |
ContactInfoId |
Required: The PK of the existing Contact Item that you want to remove the User. Possible values are in /Person/GetUserById |
globally unique identifier |
None. |
JSON
{ "UserId": "ba6e0b98-6f89-4e66-b7cf-d038d0f73ce1", "ContactInfoId": "35bd74f9-9f87-42ca-9ff5-6b3491c35c6a" }
XML
<RemoveUserContactItemViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BluSKYWebAPI.Controllers"> <ContactInfoId>35bd74f9-9f87-42ca-9ff5-6b3491c35c6a</ContactInfoId> <UserId>ba6e0b98-6f89-4e66-b7cf-d038d0f73ce1</UserId> </RemoveUserContactItemViewModel>
Response Information
Resource Description
Result
Name | Description | Type | Additional information |
---|---|---|---|
ResultCode |
Represents the result code |
integer |
None. |
Description |
Represents a description of the result code |
string |
None. |
Response Formats
JSON
{ "ResultCode": 1, "Description": "sample string 2" }
XML
<Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BluSKYWebAPI.Controllers"> <Description>sample string 2</Description> <ResultCode>1</ResultCode> </Result>