POST api/usr/SequentialRing?serviceNumber={serviceNumber}&pbxUserId={pbxUserId}

Request Information

URI Parameters

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

Body Parameters

SequentialRingDTO

Name	Type	Additional information
RingBaseLocationFirst	boolean	None.
BaseLocationNumberOfRings	integer	None.
ContinueIfBaseLocationIsBusy	boolean	None.
CallerMayStopSearch	boolean	None.
CriteriaList	Collection of SequentialRingCriteriaDTO	None.
RingList	Collection of SequentialRingEntryDTO	None.

Request Formats

application/json, text/json

Sample:

{
  "RingBaseLocationFirst": true,
  "BaseLocationNumberOfRings": 2,
  "ContinueIfBaseLocationIsBusy": true,
  "CallerMayStopSearch": true,
  "CriteriaList": [
    {
      "IsActive": true,
      "Name": "sample string 2"
    },
    {
      "IsActive": true,
      "Name": "sample string 2"
    }
  ],
  "RingList": [
    {
      "AnswerConfirmationRequired": true,
      "PhoneNumber": "sample string 2",
      "NumberOfRings": 3
    },
    {
      "AnswerConfirmationRequired": true,
      "PhoneNumber": "sample string 2",
      "NumberOfRings": 3
    }
  ]
}

application/xml, text/xml

Sample:

<SequentialRingDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MSPApi.DTO.User">
  <BaseLocationNumberOfRings>2</BaseLocationNumberOfRings>
  <CallerMayStopSearch>true</CallerMayStopSearch>
  <ContinueIfBaseLocationIsBusy>true</ContinueIfBaseLocationIsBusy>
  <CriteriaList>
    <SequentialRingCriteriaDTO>
      <IsActive>true</IsActive>
      <Name>sample string 2</Name>
    </SequentialRingCriteriaDTO>
    <SequentialRingCriteriaDTO>
      <IsActive>true</IsActive>
      <Name>sample string 2</Name>
    </SequentialRingCriteriaDTO>
  </CriteriaList>
  <RingBaseLocationFirst>true</RingBaseLocationFirst>
  <RingList>
    <SequentialRingEntryDTO>
      <AnswerConfirmationRequired>true</AnswerConfirmationRequired>
      <NumberOfRings>3</NumberOfRings>
      <PhoneNumber>sample string 2</PhoneNumber>
    </SequentialRingEntryDTO>
    <SequentialRingEntryDTO>
      <AnswerConfirmationRequired>true</AnswerConfirmationRequired>
      <NumberOfRings>3</NumberOfRings>
      <PhoneNumber>sample string 2</PhoneNumber>
    </SequentialRingEntryDTO>
  </RingList>
</SequentialRingDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

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.