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

Request Information

URI Parameters

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

Body Parameters

CommPilotExpressDTO

Name	Type	Additional information
Profile	integer	None.
ProfileEnabled	boolean	None.
AvailableInOffice	CommPilotExpressAvailableInOfficeDTO	None.
AvailableOutOfOffice	CommPilotExpressAvailableOutOfOfficeDTO	None.
Busy	CommPilotExpressBusyDTO	None.
Unavailable	CommPilotExpressUnavailableDTO	None.

Request Formats

application/json, text/json

Sample:

{
  "Profile": 1,
  "ProfileEnabled": true,
  "AvailableInOffice": {
    "AdditionalPhoneNumberToRing": "sample string 1",
    "BusySetting": {
      "Action": 1,
      "ForwardingPhoneNumber": "sample string 2"
    },
    "NoAnswerSetting": {
      "Action": 1,
      "ForwardingPhoneNumber": "sample string 2"
    }
  },
  "AvailableOutOfOffice": {
    "IncomingCalls": {
      "Action": 1,
      "ForwardingPhoneNumber": "sample string 2"
    },
    "IncomingCallNotify": {
      "SendEmail": true,
      "EmailAddress": "sample string 2"
    }
  },
  "Busy": {
    "IncomingCalls": {
      "SendCallsToVoiceMailExceptExcludedNumbers": true,
      "ForwardExcludedNumbersTo": "sample string 2",
      "ExcludedPhoneNumber01": "sample string 3",
      "ExcludedPhoneNumber02": "sample string 4",
      "ExcludedPhoneNumber03": "sample string 5"
    },
    "VoiceMailNotify": {
      "SendEmail": true,
      "EmailAddress": "sample string 2"
    }
  },
  "Unavailable": {
    "IncomingCalls": {
      "SendCallsToVoiceMailExceptExcludedNumbers": true,
      "ForwardExcludedNumbersTo": "sample string 2",
      "ExcludedPhoneNumber01": "sample string 3",
      "ExcludedPhoneNumber02": "sample string 4",
      "ExcludedPhoneNumber03": "sample string 5"
    },
    "VoiceMailGreeting": 1
  }
}

application/xml, text/xml

Sample:

<CommPilotExpressDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MSPApi.DTO.User">
  <AvailableInOffice>
    <AdditionalPhoneNumberToRing>sample string 1</AdditionalPhoneNumberToRing>
    <BusySetting>
      <Action>1</Action>
      <ForwardingPhoneNumber>sample string 2</ForwardingPhoneNumber>
    </BusySetting>
    <NoAnswerSetting>
      <Action>1</Action>
      <ForwardingPhoneNumber>sample string 2</ForwardingPhoneNumber>
    </NoAnswerSetting>
  </AvailableInOffice>
  <AvailableOutOfOffice>
    <IncomingCallNotify>
      <EmailAddress>sample string 2</EmailAddress>
      <SendEmail>true</SendEmail>
    </IncomingCallNotify>
    <IncomingCalls>
      <Action>1</Action>
      <ForwardingPhoneNumber>sample string 2</ForwardingPhoneNumber>
    </IncomingCalls>
  </AvailableOutOfOffice>
  <Busy>
    <IncomingCalls>
      <ExcludedPhoneNumber01>sample string 3</ExcludedPhoneNumber01>
      <ExcludedPhoneNumber02>sample string 4</ExcludedPhoneNumber02>
      <ExcludedPhoneNumber03>sample string 5</ExcludedPhoneNumber03>
      <ForwardExcludedNumbersTo>sample string 2</ForwardExcludedNumbersTo>
      <SendCallsToVoiceMailExceptExcludedNumbers>true</SendCallsToVoiceMailExceptExcludedNumbers>
    </IncomingCalls>
    <VoiceMailNotify>
      <EmailAddress>sample string 2</EmailAddress>
      <SendEmail>true</SendEmail>
    </VoiceMailNotify>
  </Busy>
  <Profile>1</Profile>
  <ProfileEnabled>true</ProfileEnabled>
  <Unavailable>
    <IncomingCalls>
      <ExcludedPhoneNumber01>sample string 3</ExcludedPhoneNumber01>
      <ExcludedPhoneNumber02>sample string 4</ExcludedPhoneNumber02>
      <ExcludedPhoneNumber03>sample string 5</ExcludedPhoneNumber03>
      <ForwardExcludedNumbersTo>sample string 2</ForwardExcludedNumbersTo>
      <SendCallsToVoiceMailExceptExcludedNumbers>true</SendCallsToVoiceMailExceptExcludedNumbers>
    </IncomingCalls>
    <VoiceMailGreeting>1</VoiceMailGreeting>
  </Unavailable>
</CommPilotExpressDTO>

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 'CommPilotExpressDTO'.

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.