Porta Plus 2 Web Services

<back to all web services

UAConfigRequest

The following routes are available for this service:
GET/GetUATypeConfig/{License}/{i_ua_type}
GET/GetSideCarConfig/{License}/{i_ua_type}/{getSideCarDetails}
GET/GetUAMac/{License}/{i_customer}
POST/AddFunctionKeySetting
GET/RemoveFunctionKey/{License}/{i_ua}/{functionKey}/{deleteFunctionKey}
POST/GetTemplate/{License}/
GET/GetUAFunctionKeys/{License}/{i_ua}
GET/CheckUAFromASDB/{License}/{i_ua}/{getDBValue}
GET/CheckASUA/{License}/{i_ua}/{getTemplate}
GET/AutoProvCGI/{mac}
GET/AutoProvCGI/{i_env}/{mac}
GET/GetUAKeyTypes/{License}/{i_ua}/{getsupportedKeyTypes}
POST/ReleaseUAFromASDB

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/oneway/UAConfigRequest HTTP/1.1 
Host: 7el.co 
Content-Type: application/xml
Content-Length: length

<UAConfigRequest 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>
  <AssignUA>false</AssignUA>
  <ButtonsPerPage>0</ButtonsPerPage>
  <Format>String</Format>
  <Id>0</Id>
  <Pagination>0</Pagination>
  <ReleaseUA>false</ReleaseUA>
  <deleteFunctionKey>false</deleteFunctionKey>
  <fnSettings xmlns:d2p1="http://schemas.datacontract.org/2004/07/PortaPlus2.API.Data.Models.API">
    <CreatedOn xmlns="http://schemas.datacontract.org/2004/07/PortaPlus2.API.Data.Models">0001-01-01T00:00:00</CreatedOn>
    <Id xmlns="http://schemas.datacontract.org/2004/07/PortaPlus2.API.Data.Models">0</Id>
    <RowVersion xmlns="http://schemas.datacontract.org/2004/07/PortaPlus2.API.Data.Models">0</RowVersion>
    <UpdatedOn xmlns="http://schemas.datacontract.org/2004/07/PortaPlus2.API.Data.Models">0001-01-01T00:00:00</UpdatedOn>
    <d2p1:config>String</d2p1:config>
    <d2p1:function_key>0</d2p1:function_key>
    <d2p1:i_ua>0</d2p1:i_ua>
    <d2p1:i_ua_link_blf>0</d2p1:i_ua_link_blf>
    <d2p1:label>String</d2p1:label>
    <d2p1:type>String</d2p1:type>
  </fnSettings>
  <functionKey>0</functionKey>
  <getDBValue>false</getDBValue>
  <getSideCarDetails>false</getSideCarDetails>
  <getTemplate>false</getTemplate>
  <getsupportedKeyTypes>false</getsupportedKeyTypes>
  <hidden>String</hidden>
  <i_account>0</i_account>
  <i_customer>0</i_customer>
  <i_env>String</i_env>
  <i_ua>0</i_ua>
  <i_ua_type>0</i_ua_type>
  <ip>String</ip>
  <mac>String</mac>
  <manufacturer>String</manufacturer>
  <ports>0</ports>
  <product>String</product>
  <uaLinksData xmlns:d2p1="http://schemas.datacontract.org/2004/07/PortaPlus2.API.Data.Models.API">
    <CreatedOn xmlns="http://schemas.datacontract.org/2004/07/PortaPlus2.API.Data.Models">0001-01-01T00:00:00</CreatedOn>
    <Id xmlns="http://schemas.datacontract.org/2004/07/PortaPlus2.API.Data.Models">0</Id>
    <RowVersion xmlns="http://schemas.datacontract.org/2004/07/PortaPlus2.API.Data.Models">0</RowVersion>
    <UpdatedOn xmlns="http://schemas.datacontract.org/2004/07/PortaPlus2.API.Data.Models">0001-01-01T00:00:00</UpdatedOn>
    <d2p1:config>String</d2p1:config>
    <d2p1:i_account>0</d2p1:i_account>
    <d2p1:i_ua>0</d2p1:i_ua>
    <d2p1:i_ua_link>0</d2p1:i_ua_link>
    <d2p1:ports>0</d2p1:ports>
  </uaLinksData>
  <ua_FunctionKey xmlns:d2p1="http://schemas.datacontract.org/2004/07/PortaPlus2.API.Data.Models.API">
    <d2p1:UA_FunctionKeys>
      <CreatedOn xmlns="http://schemas.datacontract.org/2004/07/PortaPlus2.API.Data.Models">0001-01-01T00:00:00</CreatedOn>
      <Id xmlns="http://schemas.datacontract.org/2004/07/PortaPlus2.API.Data.Models">0</Id>
      <RowVersion xmlns="http://schemas.datacontract.org/2004/07/PortaPlus2.API.Data.Models">0</RowVersion>
      <UpdatedOn xmlns="http://schemas.datacontract.org/2004/07/PortaPlus2.API.Data.Models">0001-01-01T00:00:00</UpdatedOn>
      <d2p1:config>String</d2p1:config>
      <d2p1:function_key>0</d2p1:function_key>
      <d2p1:i_ua>0</d2p1:i_ua>
      <d2p1:i_ua_link_blf>0</d2p1:i_ua_link_blf>
      <d2p1:label>String</d2p1:label>
      <d2p1:type>String</d2p1:type>
    </d2p1:UA_FunctionKeys>
  </ua_FunctionKey>
  <version>String</version>
</UAConfigRequest>