CustomerServices Web Service

CustomerServices

Click here for a complete list of operations.

GetCustomerUIMetadata

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CustomerServices.asmx HTTP/1.1
Host: onlinesubscription.adventureparkusa.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://semnox.com/GetCustomerUIMetadata"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetCustomerUIMetadata xmlns="http://semnox.com/">
      <siteId>int</siteId>
    </GetCustomerUIMetadata>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetCustomerUIMetadataResponse xmlns="http://semnox.com/">
      <GetCustomerUIMetadataResult>
        <CustomerFieldStruct>
          <CustomerFieldOrder>int</CustomerFieldOrder>
          <CustomAttributeFlag>int</CustomAttributeFlag>
          <CustomAttributeId>int</CustomAttributeId>
          <CustomerFieldName>string</CustomerFieldName>
          <EntityFieldCaption>string</EntityFieldCaption>
          <EntityFieldName>string</EntityFieldName>
          <CustomerFieldValue>string</CustomerFieldValue>
          <CustomerFieldValues>
            <string>string</string>
            <string>string</string>
          </CustomerFieldValues>
          <CustomerFieldType>string</CustomerFieldType>
          <ValidationType>string</ValidationType>
          <FieldLength>string</FieldLength>
          <CustomAttributesDTO>
            <CustomAttributeId>int</CustomAttributeId>
            <Name>string</Name>
            <Sequence>int</Sequence>
            <Type>string</Type>
            <Applicability>string</Applicability>
            <Access>string</Access>
            <CreatedBy>string</CreatedBy>
            <CreationDate>dateTime</CreationDate>
            <LastUpdatedBy>string</LastUpdatedBy>
            <LastUpdateDate>dateTime</LastUpdateDate>
            <SiteId>int</SiteId>
            <MasterEntityId>int</MasterEntityId>
            <SynchStatus>boolean</SynchStatus>
            <Guid>string</Guid>
            <CustomAttributeValueListDTOList xsi:nil="true" />
            <IsActive>boolean</IsActive>
            <IsChanged>boolean</IsChanged>
          </CustomAttributesDTO>
          <DisplayFormat>string</DisplayFormat>
        </CustomerFieldStruct>
        <CustomerFieldStruct>
          <CustomerFieldOrder>int</CustomerFieldOrder>
          <CustomAttributeFlag>int</CustomAttributeFlag>
          <CustomAttributeId>int</CustomAttributeId>
          <CustomerFieldName>string</CustomerFieldName>
          <EntityFieldCaption>string</EntityFieldCaption>
          <EntityFieldName>string</EntityFieldName>
          <CustomerFieldValue>string</CustomerFieldValue>
          <CustomerFieldValues>
            <string>string</string>
            <string>string</string>
          </CustomerFieldValues>
          <CustomerFieldType>string</CustomerFieldType>
          <ValidationType>string</ValidationType>
          <FieldLength>string</FieldLength>
          <CustomAttributesDTO>
            <CustomAttributeId>int</CustomAttributeId>
            <Name>string</Name>
            <Sequence>int</Sequence>
            <Type>string</Type>
            <Applicability>string</Applicability>
            <Access>string</Access>
            <CreatedBy>string</CreatedBy>
            <CreationDate>dateTime</CreationDate>
            <LastUpdatedBy>string</LastUpdatedBy>
            <LastUpdateDate>dateTime</LastUpdateDate>
            <SiteId>int</SiteId>
            <MasterEntityId>int</MasterEntityId>
            <SynchStatus>boolean</SynchStatus>
            <Guid>string</Guid>
            <CustomAttributeValueListDTOList xsi:nil="true" />
            <IsActive>boolean</IsActive>
            <IsChanged>boolean</IsChanged>
          </CustomAttributesDTO>
          <DisplayFormat>string</DisplayFormat>
        </CustomerFieldStruct>
      </GetCustomerUIMetadataResult>
    </GetCustomerUIMetadataResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /CustomerServices.asmx HTTP/1.1
Host: onlinesubscription.adventureparkusa.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetCustomerUIMetadata xmlns="http://semnox.com/">
      <siteId>int</siteId>
    </GetCustomerUIMetadata>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetCustomerUIMetadataResponse xmlns="http://semnox.com/">
      <GetCustomerUIMetadataResult>
        <CustomerFieldStruct>
          <CustomerFieldOrder>int</CustomerFieldOrder>
          <CustomAttributeFlag>int</CustomAttributeFlag>
          <CustomAttributeId>int</CustomAttributeId>
          <CustomerFieldName>string</CustomerFieldName>
          <EntityFieldCaption>string</EntityFieldCaption>
          <EntityFieldName>string</EntityFieldName>
          <CustomerFieldValue>string</CustomerFieldValue>
          <CustomerFieldValues>
            <string>string</string>
            <string>string</string>
          </CustomerFieldValues>
          <CustomerFieldType>string</CustomerFieldType>
          <ValidationType>string</ValidationType>
          <FieldLength>string</FieldLength>
          <CustomAttributesDTO>
            <CustomAttributeId>int</CustomAttributeId>
            <Name>string</Name>
            <Sequence>int</Sequence>
            <Type>string</Type>
            <Applicability>string</Applicability>
            <Access>string</Access>
            <CreatedBy>string</CreatedBy>
            <CreationDate>dateTime</CreationDate>
            <LastUpdatedBy>string</LastUpdatedBy>
            <LastUpdateDate>dateTime</LastUpdateDate>
            <SiteId>int</SiteId>
            <MasterEntityId>int</MasterEntityId>
            <SynchStatus>boolean</SynchStatus>
            <Guid>string</Guid>
            <CustomAttributeValueListDTOList xsi:nil="true" />
            <IsActive>boolean</IsActive>
            <IsChanged>boolean</IsChanged>
          </CustomAttributesDTO>
          <DisplayFormat>string</DisplayFormat>
        </CustomerFieldStruct>
        <CustomerFieldStruct>
          <CustomerFieldOrder>int</CustomerFieldOrder>
          <CustomAttributeFlag>int</CustomAttributeFlag>
          <CustomAttributeId>int</CustomAttributeId>
          <CustomerFieldName>string</CustomerFieldName>
          <EntityFieldCaption>string</EntityFieldCaption>
          <EntityFieldName>string</EntityFieldName>
          <CustomerFieldValue>string</CustomerFieldValue>
          <CustomerFieldValues>
            <string>string</string>
            <string>string</string>
          </CustomerFieldValues>
          <CustomerFieldType>string</CustomerFieldType>
          <ValidationType>string</ValidationType>
          <FieldLength>string</FieldLength>
          <CustomAttributesDTO>
            <CustomAttributeId>int</CustomAttributeId>
            <Name>string</Name>
            <Sequence>int</Sequence>
            <Type>string</Type>
            <Applicability>string</Applicability>
            <Access>string</Access>
            <CreatedBy>string</CreatedBy>
            <CreationDate>dateTime</CreationDate>
            <LastUpdatedBy>string</LastUpdatedBy>
            <LastUpdateDate>dateTime</LastUpdateDate>
            <SiteId>int</SiteId>
            <MasterEntityId>int</MasterEntityId>
            <SynchStatus>boolean</SynchStatus>
            <Guid>string</Guid>
            <CustomAttributeValueListDTOList xsi:nil="true" />
            <IsActive>boolean</IsActive>
            <IsChanged>boolean</IsChanged>
          </CustomAttributesDTO>
          <DisplayFormat>string</DisplayFormat>
        </CustomerFieldStruct>
      </GetCustomerUIMetadataResult>
    </GetCustomerUIMetadataResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /CustomerServices.asmx/GetCustomerUIMetadata?siteId=string HTTP/1.1
Host: onlinesubscription.adventureparkusa.com

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfCustomerFieldStruct xmlns="http://semnox.com/">
  <CustomerFieldStruct>
    <CustomerFieldOrder>int</CustomerFieldOrder>
    <CustomAttributeFlag>int</CustomAttributeFlag>
    <CustomAttributeId>int</CustomAttributeId>
    <CustomerFieldName>string</CustomerFieldName>
    <EntityFieldCaption>string</EntityFieldCaption>
    <EntityFieldName>string</EntityFieldName>
    <CustomerFieldValue>string</CustomerFieldValue>
    <CustomerFieldValues>
      <string>string</string>
      <string>string</string>
    </CustomerFieldValues>
    <CustomerFieldType>string</CustomerFieldType>
    <ValidationType>string</ValidationType>
    <FieldLength>string</FieldLength>
    <CustomAttributesDTO>
      <CustomAttributeId>int</CustomAttributeId>
      <Name>string</Name>
      <Sequence>int</Sequence>
      <Type>string</Type>
      <Applicability>string</Applicability>
      <Access>string</Access>
      <CreatedBy>string</CreatedBy>
      <CreationDate>dateTime</CreationDate>
      <LastUpdatedBy>string</LastUpdatedBy>
      <LastUpdateDate>dateTime</LastUpdateDate>
      <SiteId>int</SiteId>
      <MasterEntityId>int</MasterEntityId>
      <SynchStatus>boolean</SynchStatus>
      <Guid>string</Guid>
      <CustomAttributeValueListDTOList>
        <CustomAttributeValueListDTO d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CustomAttributeValueListDTO d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </CustomAttributeValueListDTOList>
      <IsActive>boolean</IsActive>
      <IsChanged>boolean</IsChanged>
    </CustomAttributesDTO>
    <DisplayFormat>string</DisplayFormat>
  </CustomerFieldStruct>
  <CustomerFieldStruct>
    <CustomerFieldOrder>int</CustomerFieldOrder>
    <CustomAttributeFlag>int</CustomAttributeFlag>
    <CustomAttributeId>int</CustomAttributeId>
    <CustomerFieldName>string</CustomerFieldName>
    <EntityFieldCaption>string</EntityFieldCaption>
    <EntityFieldName>string</EntityFieldName>
    <CustomerFieldValue>string</CustomerFieldValue>
    <CustomerFieldValues>
      <string>string</string>
      <string>string</string>
    </CustomerFieldValues>
    <CustomerFieldType>string</CustomerFieldType>
    <ValidationType>string</ValidationType>
    <FieldLength>string</FieldLength>
    <CustomAttributesDTO>
      <CustomAttributeId>int</CustomAttributeId>
      <Name>string</Name>
      <Sequence>int</Sequence>
      <Type>string</Type>
      <Applicability>string</Applicability>
      <Access>string</Access>
      <CreatedBy>string</CreatedBy>
      <CreationDate>dateTime</CreationDate>
      <LastUpdatedBy>string</LastUpdatedBy>
      <LastUpdateDate>dateTime</LastUpdateDate>
      <SiteId>int</SiteId>
      <MasterEntityId>int</MasterEntityId>
      <SynchStatus>boolean</SynchStatus>
      <Guid>string</Guid>
      <CustomAttributeValueListDTOList>
        <CustomAttributeValueListDTO d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CustomAttributeValueListDTO d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </CustomAttributeValueListDTOList>
      <IsActive>boolean</IsActive>
      <IsChanged>boolean</IsChanged>
    </CustomAttributesDTO>
    <DisplayFormat>string</DisplayFormat>
  </CustomerFieldStruct>
</ArrayOfCustomerFieldStruct>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /CustomerServices.asmx/GetCustomerUIMetadata HTTP/1.1
Host: onlinesubscription.adventureparkusa.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

siteId=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfCustomerFieldStruct xmlns="http://semnox.com/">
  <CustomerFieldStruct>
    <CustomerFieldOrder>int</CustomerFieldOrder>
    <CustomAttributeFlag>int</CustomAttributeFlag>
    <CustomAttributeId>int</CustomAttributeId>
    <CustomerFieldName>string</CustomerFieldName>
    <EntityFieldCaption>string</EntityFieldCaption>
    <EntityFieldName>string</EntityFieldName>
    <CustomerFieldValue>string</CustomerFieldValue>
    <CustomerFieldValues>
      <string>string</string>
      <string>string</string>
    </CustomerFieldValues>
    <CustomerFieldType>string</CustomerFieldType>
    <ValidationType>string</ValidationType>
    <FieldLength>string</FieldLength>
    <CustomAttributesDTO>
      <CustomAttributeId>int</CustomAttributeId>
      <Name>string</Name>
      <Sequence>int</Sequence>
      <Type>string</Type>
      <Applicability>string</Applicability>
      <Access>string</Access>
      <CreatedBy>string</CreatedBy>
      <CreationDate>dateTime</CreationDate>
      <LastUpdatedBy>string</LastUpdatedBy>
      <LastUpdateDate>dateTime</LastUpdateDate>
      <SiteId>int</SiteId>
      <MasterEntityId>int</MasterEntityId>
      <SynchStatus>boolean</SynchStatus>
      <Guid>string</Guid>
      <CustomAttributeValueListDTOList>
        <CustomAttributeValueListDTO d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CustomAttributeValueListDTO d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </CustomAttributeValueListDTOList>
      <IsActive>boolean</IsActive>
      <IsChanged>boolean</IsChanged>
    </CustomAttributesDTO>
    <DisplayFormat>string</DisplayFormat>
  </CustomerFieldStruct>
  <CustomerFieldStruct>
    <CustomerFieldOrder>int</CustomerFieldOrder>
    <CustomAttributeFlag>int</CustomAttributeFlag>
    <CustomAttributeId>int</CustomAttributeId>
    <CustomerFieldName>string</CustomerFieldName>
    <EntityFieldCaption>string</EntityFieldCaption>
    <EntityFieldName>string</EntityFieldName>
    <CustomerFieldValue>string</CustomerFieldValue>
    <CustomerFieldValues>
      <string>string</string>
      <string>string</string>
    </CustomerFieldValues>
    <CustomerFieldType>string</CustomerFieldType>
    <ValidationType>string</ValidationType>
    <FieldLength>string</FieldLength>
    <CustomAttributesDTO>
      <CustomAttributeId>int</CustomAttributeId>
      <Name>string</Name>
      <Sequence>int</Sequence>
      <Type>string</Type>
      <Applicability>string</Applicability>
      <Access>string</Access>
      <CreatedBy>string</CreatedBy>
      <CreationDate>dateTime</CreationDate>
      <LastUpdatedBy>string</LastUpdatedBy>
      <LastUpdateDate>dateTime</LastUpdateDate>
      <SiteId>int</SiteId>
      <MasterEntityId>int</MasterEntityId>
      <SynchStatus>boolean</SynchStatus>
      <Guid>string</Guid>
      <CustomAttributeValueListDTOList>
        <CustomAttributeValueListDTO d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CustomAttributeValueListDTO d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </CustomAttributeValueListDTOList>
      <IsActive>boolean</IsActive>
      <IsChanged>boolean</IsChanged>
    </CustomAttributesDTO>
    <DisplayFormat>string</DisplayFormat>
  </CustomerFieldStruct>
</ArrayOfCustomerFieldStruct>

Parameter	Value
siteId: