DELETE v2/ResponseCodes/{responsecodeId}

User roles allowed to make this request: DomainAdministrator PowerUser LocalDomainManager GlobalDomainManager

Permissions required to make this request: DomainResponseCode.Delete DomainResponseCode.Read

Delete the domain's response code by id.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
responsecodeId

The id of the response code to delete

integer

Required

Body Parameters

None.

Response Information

Resource Description

Response Message

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "Description": "sample string 2",
  "Url": "sample string 3",
  "IsDefinite": true,
  "IsSelectable": true,
  "AllowAppointment": true,
  "ChannelCapi": true,
  "ChannelCati": true,
  "ChannelOnline": true
}

application/xml, text/xml

Sample:
<DomainResponseCodeResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <AllowAppointment>true</AllowAppointment>
  <ChannelCapi>true</ChannelCapi>
  <ChannelCati>true</ChannelCati>
  <ChannelOnline>true</ChannelOnline>
  <Description>sample string 2</Description>
  <IsDefinite>true</IsDefinite>
  <IsSelectable>true</IsSelectable>
  <Url>sample string 3</Url>
  <Id>1</Id>
</DomainResponseCodeResponseModel>