Porta Plus 2 Web Services

<back to all web services

GetAccount

The following routes are available for this service:
GET/GetAccountByIAccount/{License}/{IAccount}
POST/GetAccountsByAccountIDs
GET/GetAccountByICustomer/{License}/{ICustomer}
GET/GetAccountByICustomerIProduct/{License}/{ICustomer}/{IProduct}/{getbyIprod}
GET/GetAccountByICustomerProductSS/{License}/{ICustomer}/{ProductSearchterm}/{getbySearchTerm}
GET/GetAccountByAccountLogin/{License}/{Login}/{Password}
POST/GetAccount
GET/GetAccountByAccountID/{License}/{AccountID}
GET/GetAccountByICustomer/{License}/{ICustomer}/{forHuntgroups}

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/GetAccount HTTP/1.1 
Host: api-uk.activesoftswitch.com 
Content-Type: application/xml
Content-Length: length

<GetAccount 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>
  <AccountID>String</AccountID>
  <IAccount>0</IAccount>
  <ICustomer>0</ICustomer>
  <IProduct>String</IProduct>
  <Login>String</Login>
  <Password>String</Password>
  <ProductSearchterm>String</ProductSearchterm>
  <accounts>
    <AccountDetails>
      <AccountID>String</AccountID>
      <IAccount>0</IAccount>
      <ICustomer>0</ICustomer>
      <Login>String</Login>
      <Password>String</Password>
    </AccountDetails>
  </accounts>
  <forHuntgroups>false</forHuntgroups>
  <getbyIprod>false</getbyIprod>
  <getbySearchTerm>false</getbySearchTerm>
</GetAccount>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetAccountResponse 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>
  <Accounts xmlns:d2p1="http://schemas.datacontract.org/2004/07/PortaPlus2.API.Data.Models.Porta">
    <d2p1:dbAccountDal>
      <d2p1:AccountId>String</d2p1:AccountId>
      <d2p1:ActivationDate>0001-01-01T00:00:00</d2p1:ActivationDate>
      <d2p1:Address>String</d2p1:Address>
      <d2p1:Address1>String</d2p1:Address1>
      <d2p1:Address2>String</d2p1:Address2>
      <d2p1:Address3>String</d2p1:Address3>
      <d2p1:Address4>String</d2p1:Address4>
      <d2p1:BCC>String</d2p1:BCC>
      <d2p1:Balance>0</d2p1:Balance>
      <d2p1:BatchNamePrefix>String</d2p1:BatchNamePrefix>
      <d2p1:BillStatus>String</d2p1:BillStatus>
      <d2p1:BillingModel>ReChargeVoucher</d2p1:BillingModel>
      <d2p1:Blocked>false</d2p1:Blocked>
      <d2p1:Blockedfield>String</d2p1:Blockedfield>
      <d2p1:City>String</d2p1:City>
      <d2p1:Company>String</d2p1:Company>
      <d2p1:CompanyName>String</d2p1:CompanyName>
      <d2p1:Contact1>String</d2p1:Contact1>
      <d2p1:Contact2>String</d2p1:Contact2>
      <d2p1:Country>String</d2p1:Country>
      <d2p1:CreditLimit>0</d2p1:CreditLimit>
      <d2p1:DeactiveDestinations>String</d2p1:DeactiveDestinations>
      <d2p1:DefaultValidIdentity>String</d2p1:DefaultValidIdentity>
      <d2p1:DestinationName>String</d2p1:DestinationName>
      <d2p1:Email>String</d2p1:Email>
      <d2p1:ExtensionNumber>String</d2p1:ExtensionNumber>
      <d2p1:Fax>String</d2p1:Fax>
      <d2p1:FirstName>String</d2p1:FirstName>
      <d2p1:FollowMeEnabled>String</d2p1:FollowMeEnabled>
      <d2p1:IAccount>0</d2p1:IAccount>
      <d2p1:IBatch>0</d2p1:IBatch>
      <d2p1:ICustomer>0</d2p1:ICustomer>
      <d2p1:ICustomerSite>0</d2p1:ICustomerSite>
      <d2p1:IEnv>0</d2p1:IEnv>
      <d2p1:IParent>0</d2p1:IParent>
      <d2p1:IProduct>0</d2p1:IProduct>
      <d2p1:IRoutingPlan>0</d2p1:IRoutingPlan>
      <d2p1:ISO4217>String</d2p1:ISO4217>
      <d2p1:IVDPlan>0</d2p1:IVDPlan>
      <d2p1:Id>String</d2p1:Id>
      <d2p1:LastName>String</d2p1:LastName>
      <d2p1:MiddleInitials>String</d2p1:MiddleInitials>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:Note>String</d2p1:Note>
      <d2p1:Phone1>String</d2p1:Phone1>
      <d2p1:Phone2>String</d2p1:Phone2>
      <d2p1:PhoneNo>String</d2p1:PhoneNo>
      <d2p1:Postcode>String</d2p1:Postcode>
      <d2p1:Region>String</d2p1:Region>
      <d2p1:Salutation>String</d2p1:Salutation>
      <d2p1:ServiceFlags>String</d2p1:ServiceFlags>
      <d2p1:State>String</d2p1:State>
      <d2p1:SubscriberFName>String</d2p1:SubscriberFName>
      <d2p1:SubscriberLName>String</d2p1:SubscriberLName>
      <d2p1:Town>String</d2p1:Town>
      <d2p1:TranslateIncomingCLI>false</d2p1:TranslateIncomingCLI>
      <d2p1:UILogin>String</d2p1:UILogin>
      <d2p1:UIPassword>String</d2p1:UIPassword>
      <d2p1:UMEnabled>false</d2p1:UMEnabled>
      <d2p1:UMEnabledfield>String</d2p1:UMEnabledfield>
      <d2p1:VoiceDialing>false</d2p1:VoiceDialing>
      <d2p1:VoipPassword>String</d2p1:VoipPassword>
      <d2p1:account_dr_active>String</d2p1:account_dr_active>
      <d2p1:activationDate>String</d2p1:activationDate>
      <d2p1:activationDateDateTime>0001-01-01T00:00:00</d2p1:activationDateDateTime>
      <d2p1:active>String</d2p1:active>
      <d2p1:currentProfileImage>String</d2p1:currentProfileImage>
      <d2p1:customUrl>String</d2p1:customUrl>
      <d2p1:firstUsageTime>0001-01-01T00:00:00</d2p1:firstUsageTime>
      <d2p1:inactivityExpireTime>0</d2p1:inactivityExpireTime>
      <d2p1:issueDate>0001-01-01T00:00:00</d2p1:issueDate>
      <d2p1:lastUsage>0001-01-01T00:00:00</d2p1:lastUsage>
      <d2p1:redirect_number>String</d2p1:redirect_number>
    </d2p1:dbAccountDal>
  </Accounts>
</GetAccountResponse>