Porta Plus 2 Web Services

<back to all web services

CustomerSite

The following routes are available for this service:
GET/GetCustomerSites/{License}/{i_customer}/{get_service_features}
GET/GetCustomerSiteInfo/{License}/{i_customer}/{i_customer_site}
POST/AddCustomerSite
POST/UpdateCustomerSite
GET/DeleteCustomerSite/{License}/{i_customer_site}
GET/AssignAccountToSite/{License}/{i_account}/{i_customer_site}

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

<CustomerSite 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>
  <get_service_features>0</get_service_features>
  <i_account>0</i_account>
  <i_customer>0</i_customer>
  <i_customer_site>0</i_customer_site>
  <site_info xmlns:d2p1="http://schemas.datacontract.org/2004/07/PortaPlus2.Common.Models">
    <d2p1:i_customer>0</d2p1:i_customer>
    <d2p1:i_customer_site>0</d2p1:i_customer_site>
    <d2p1:name>String</d2p1:name>
    <d2p1:service_features>
      <d2p1:PortaServiceFeature>
        <d2p1:FlagValue>String</d2p1:FlagValue>
        <d2p1:Name>String</d2p1:Name>
        <d2p1:ServiceAttributes xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringArrayOfstringty7Ep6D1>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>
              <d5p1:string>String</d5p1:string>
            </d5p1:Value>
          </d5p1:KeyValueOfstringArrayOfstringty7Ep6D1>
        </d2p1:ServiceAttributes>
      </d2p1:PortaServiceFeature>
    </d2p1:service_features>
    <d2p1:used>0</d2p1:used>
  </site_info>
</CustomerSite>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CustomerSiteResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PortaPlus2.API.Web.Dto">
  <added_i_customer_site>0</added_i_customer_site>
  <isAccountAssignedToSite>false</isAccountAssignedToSite>
  <isCustomerSiteDeleted>false</isCustomerSiteDeleted>
  <siteInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/Porta.SoapTest.Admin">
    <d2p1:i_customerField>0</d2p1:i_customerField>
    <d2p1:i_customer_siteField>0</d2p1:i_customer_siteField>
    <d2p1:nameField>String</d2p1:nameField>
    <d2p1:service_featuresField>
      <d2p1:ServiceFeatureInfo>
        <d2p1:attributesField>
          <d2p1:ServiceAttributeInfo>
            <d2p1:effective_valuesField xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>String</d7p1:string>
            </d2p1:effective_valuesField>
            <d2p1:nameField>String</d2p1:nameField>
            <d2p1:valuesField xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>String</d7p1:string>
            </d2p1:valuesField>
          </d2p1:ServiceAttributeInfo>
        </d2p1:attributesField>
        <d2p1:definedField>0</d2p1:definedField>
        <d2p1:definedFieldSpecified>false</d2p1:definedFieldSpecified>
        <d2p1:effective_flag_valueField>String</d2p1:effective_flag_valueField>
        <d2p1:flag_valueField>String</d2p1:flag_valueField>
        <d2p1:lockedField>0</d2p1:lockedField>
        <d2p1:lockedFieldSpecified>false</d2p1:lockedFieldSpecified>
        <d2p1:locksField xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>String</d5p1:string>
        </d2p1:locksField>
        <d2p1:nameField>String</d2p1:nameField>
      </d2p1:ServiceFeatureInfo>
    </d2p1:service_featuresField>
    <d2p1:usedField>0</d2p1:usedField>
    <d2p1:usedFieldSpecified>false</d2p1:usedFieldSpecified>
  </siteInfo>
  <sites xmlns:d2p1="http://schemas.datacontract.org/2004/07/Porta.SoapTest.Admin">
    <d2p1:CustomerSiteInfo>
      <d2p1:i_customerField>0</d2p1:i_customerField>
      <d2p1:i_customer_siteField>0</d2p1:i_customer_siteField>
      <d2p1:nameField>String</d2p1:nameField>
      <d2p1:service_featuresField>
        <d2p1:ServiceFeatureInfo>
          <d2p1:attributesField>
            <d2p1:ServiceAttributeInfo>
              <d2p1:effective_valuesField xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <d8p1:string>String</d8p1:string>
              </d2p1:effective_valuesField>
              <d2p1:nameField>String</d2p1:nameField>
              <d2p1:valuesField xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <d8p1:string>String</d8p1:string>
              </d2p1:valuesField>
            </d2p1:ServiceAttributeInfo>
          </d2p1:attributesField>
          <d2p1:definedField>0</d2p1:definedField>
          <d2p1:definedFieldSpecified>false</d2p1:definedFieldSpecified>
          <d2p1:effective_flag_valueField>String</d2p1:effective_flag_valueField>
          <d2p1:flag_valueField>String</d2p1:flag_valueField>
          <d2p1:lockedField>0</d2p1:lockedField>
          <d2p1:lockedFieldSpecified>false</d2p1:lockedFieldSpecified>
          <d2p1:locksField xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </d2p1:locksField>
          <d2p1:nameField>String</d2p1:nameField>
        </d2p1:ServiceFeatureInfo>
      </d2p1:service_featuresField>
      <d2p1:usedField>0</d2p1:usedField>
      <d2p1:usedFieldSpecified>false</d2p1:usedFieldSpecified>
    </d2p1:CustomerSiteInfo>
  </sites>
  <updated_i_customer_site>0</updated_i_customer_site>
</CustomerSiteResponse>