DELETE api/Contacts?contactId={contactId}
Deletes an contact.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| contactId |
id of the contact that will be deleted. |
globally unique identifier |
Required |
Body Parameters
None.
Remarks
None.
Example
None.
Response Information
Resource Description
ContactDeleteResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Success |
Returns true if contact is deleted |
boolean |
None. |
| Errors |
List of errors when deleting an contact |
Collection of DeleteContactError |
None. |
Response Formats
application/json, text/json
Sample:
{
"Success": true,
"Errors": [
{
"ErrorCode": 1,
"ErrorMessage": "sample string 1"
},
{
"ErrorCode": 1,
"ErrorMessage": "sample string 1"
}
]
}
application/xml, text/xml
Sample:
<ContactDeleteResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.Business">
<Errors>
<DeleteContactError>
<ErrorCode>InternalServerError</ErrorCode>
<ErrorMessage>sample string 1</ErrorMessage>
</DeleteContactError>
<DeleteContactError>
<ErrorCode>InternalServerError</ErrorCode>
<ErrorMessage>sample string 1</ErrorMessage>
</DeleteContactError>
</Errors>
<Success>true</Success>
</ContactDeleteResponse>