POST api/usr/PreAlertingAnnouncement/Criteria?serviceNumber={serviceNumber}&pbxUserId={pbxUserId}

Request Information

URI Parameters

Name	Description	Type	Additional information
serviceNumber		string	None.
pbxUserId		string	None.

Body Parameters

PreAlertingAnnouncementCriteriaEditDTO

Name	Type	Additional information
Name	string	None.
Blacklisted	boolean	None.
AudioSelection	integer	None.
AudioFile	AnnouncementFileKeyDTO	None.
AudioFileUrl	string	None.
CallWaitingAudioSelection	integer	None.
CallWaitingAudioFile	AnnouncementFileKeyDTO	None.
CallWaitingVideoSelection	integer	None.
CallWaitingVideoFile	AnnouncementFileKeyDTO	None.
VideoSelection	integer	None.
VideoFile	AnnouncementFileKeyDTO	None.
VideoFileUrl	string	None.
HolidaySchedule	ScheduleKeyDTO	None.
TimeSchedule	ScheduleKeyDTO	None.
Criteria	CriteriaCallTypeDTO	None.

Request Formats

application/json, text/json

Sample:

{
  "Name": "sample string 1",
  "Blacklisted": true,
  "AudioSelection": 3,
  "AudioFile": {
    "Name": "sample string 1",
    "MediaFileType": 2,
    "Level": 3
  },
  "AudioFileUrl": "sample string 4",
  "CallWaitingAudioSelection": 5,
  "CallWaitingAudioFile": {
    "Name": "sample string 1",
    "MediaFileType": 2,
    "Level": 3
  },
  "CallWaitingVideoSelection": 6,
  "CallWaitingVideoFile": {
    "Name": "sample string 1",
    "MediaFileType": 2,
    "Level": 3
  },
  "VideoSelection": 7,
  "VideoFile": {
    "Name": "sample string 1",
    "MediaFileType": 2,
    "Level": 3
  },
  "VideoFileUrl": "sample string 8",
  "HolidaySchedule": {
    "Name": "sample string 1",
    "Type": 0,
    "Level": 0
  },
  "TimeSchedule": {
    "Name": "sample string 1",
    "Type": 0,
    "Level": 0
  },
  "Criteria": {
    "PhoneNumbers": [
      "sample string 1",
      "sample string 2"
    ],
    "IncludeAnonymousCallers": true,
    "IncludeUnavailableCallers": true,
    "FromDnCriteriaSelection": 3
  }
}

application/xml, text/xml

Sample:

<PreAlertingAnnouncementCriteriaEditDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MSPApi.DTO.User">
  <AudioFile xmlns:d2p1="http://schemas.datacontract.org/2004/07/MSPApi.DTO">
    <d2p1:Level>3</d2p1:Level>
    <d2p1:MediaFileType>2</d2p1:MediaFileType>
    <d2p1:Name>sample string 1</d2p1:Name>
  </AudioFile>
  <AudioFileUrl>sample string 4</AudioFileUrl>
  <AudioSelection>3</AudioSelection>
  <Blacklisted>true</Blacklisted>
  <CallWaitingAudioFile xmlns:d2p1="http://schemas.datacontract.org/2004/07/MSPApi.DTO">
    <d2p1:Level>3</d2p1:Level>
    <d2p1:MediaFileType>2</d2p1:MediaFileType>
    <d2p1:Name>sample string 1</d2p1:Name>
  </CallWaitingAudioFile>
  <CallWaitingAudioSelection>5</CallWaitingAudioSelection>
  <CallWaitingVideoFile xmlns:d2p1="http://schemas.datacontract.org/2004/07/MSPApi.DTO">
    <d2p1:Level>3</d2p1:Level>
    <d2p1:MediaFileType>2</d2p1:MediaFileType>
    <d2p1:Name>sample string 1</d2p1:Name>
  </CallWaitingVideoFile>
  <CallWaitingVideoSelection>6</CallWaitingVideoSelection>
  <Criteria>
    <FromDnCriteriaSelection>3</FromDnCriteriaSelection>
    <IncludeAnonymousCallers>true</IncludeAnonymousCallers>
    <IncludeUnavailableCallers>true</IncludeUnavailableCallers>
    <PhoneNumbers xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </PhoneNumbers>
  </Criteria>
  <HolidaySchedule xmlns:d2p1="http://schemas.datacontract.org/2004/07/MSPApi.DTO.Enterprise">
    <d2p1:Level>ServiceProvider</d2p1:Level>
    <d2p1:Name>sample string 1</d2p1:Name>
    <d2p1:Type>Holiday</d2p1:Type>
  </HolidaySchedule>
  <Name>sample string 1</Name>
  <TimeSchedule xmlns:d2p1="http://schemas.datacontract.org/2004/07/MSPApi.DTO.Enterprise">
    <d2p1:Level>ServiceProvider</d2p1:Level>
    <d2p1:Name>sample string 1</d2p1:Name>
    <d2p1:Type>Holiday</d2p1:Type>
  </TimeSchedule>
  <VideoFile xmlns:d2p1="http://schemas.datacontract.org/2004/07/MSPApi.DTO">
    <d2p1:Level>3</d2p1:Level>
    <d2p1:MediaFileType>2</d2p1:MediaFileType>
    <d2p1:Name>sample string 1</d2p1:Name>
  </VideoFile>
  <VideoFileUrl>sample string 8</VideoFileUrl>
  <VideoSelection>7</VideoSelection>
</PreAlertingAnnouncementCriteriaEditDTO>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'PreAlertingAnnouncementCriteriaEditDTO'.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.