Porta Plus 2 Web Services

<back to all web services

CallForwarder

The following routes are available for this service:
GET/GetAccountFollowmeNos/{License}/{ICustomer}/{IAccount}
POST/GetAccountFollowmeNosByMultiAccounts
GET/GetAccountFollowmeNos/{License}/{ICustomer}/{IAccount}/{ExtendedInfo}
GET/GetAccountDRFollowmeNos/{License}/{ICustomer}/{IAccount}/{isForDisasterRecovery}
GET/GetDRFollowMeNumbersForCustBySearchTerm/{License}/{ICustomer}/{searchTerm}/{i_customer_site}/{isForDisasterRecovery}/{isForCustomer}
GET/GetDRFollowMeNumbersForCustByIProduct/{License}/{ICustomer}/{productID}/{i_customer_site}/{isForDisasterRecovery}/{isForCustomer}

To override the Content-type in your clients HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/CallForwarder HTTP/1.1 
Host: api-uk.activesoftswitch.com 
Content-Type: application/xml
Content-Length: length

<CallForwarder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PortaPlus2.API.Web.Dto">
  <ContentId>0</ContentId>
  <FeatureName>String</FeatureName>
  <License>String</License>
  <ExtendedInfo>false</ExtendedInfo>
  <IAccount>0</IAccount>
  <ICustomer>0</ICustomer>
  <accounts>String</accounts>
  <i_customer_site>0</i_customer_site>
  <isForCustomer>false</isForCustomer>
  <isForDisasterRecovery>false</isForDisasterRecovery>
  <productID>String</productID>
  <searchTerm>String</searchTerm>
</CallForwarder>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CallForwarderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PortaPlus2.API.Web.Dto">
  <ContentId>0</ContentId>
  <FeatureName>String</FeatureName>
  <License>String</License>
  <AccountCallForwarders xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringArrayOfPortaCallForwarderRes9zofi5ip>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value xmlns:d4p1="http://schemas.datacontract.org/2004/07/PortaPlus2.API.Data.Models.Porta">
        <d4p1:PortaCallForwarderRes>
          <d4p1:AccountID>String</d4p1:AccountID>
          <d4p1:Active>String</d4p1:Active>
          <d4p1:DefaultTimeout>0</d4p1:DefaultTimeout>
          <d4p1:Domain>String</d4p1:Domain>
          <d4p1:ExtensionNumber>0</d4p1:ExtensionNumber>
          <d4p1:FollowMeOrder>0</d4p1:FollowMeOrder>
          <d4p1:HasFollowMenumbers>false</d4p1:HasFollowMenumbers>
          <d4p1:IAccount>0</d4p1:IAccount>
          <d4p1:IFollowMe>0</d4p1:IFollowMe>
          <d4p1:IFollowMeNumber>0</d4p1:IFollowMeNumber>
          <d4p1:KeepOriginalCLD>String</d4p1:KeepOriginalCLD>
          <d4p1:KeepOriginalCLI>String</d4p1:KeepOriginalCLI>
          <d4p1:Name>String</d4p1:Name>
          <d4p1:Note>String</d4p1:Note>
          <d4p1:RedirectNumber>String</d4p1:RedirectNumber>
          <d4p1:Sequence>String</d4p1:Sequence>
          <d4p1:Timeout>0</d4p1:Timeout>
          <d4p1:fnLabel>String</d4p1:fnLabel>
          <d4p1:period>String</d4p1:period>
          <d4p1:period_description>String</d4p1:period_description>
        </d4p1:PortaCallForwarderRes>
      </d2p1:Value>
    </d2p1:KeyValueOfstringArrayOfPortaCallForwarderRes9zofi5ip>
  </AccountCallForwarders>
</CallForwarderResponse>