Tradera Developer Program

PublicService

Documentation Version 3 > PublicService > GetAttributeDefinitions

GetAttributeDefinitions |WebMethod|

Returns definitions of the attributes that may be used on items in the specified category.

Returns

A list of AttributeDefinition objects.

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 /v3/publicservice.asmx HTTP/1.1
Host: api.tradera.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.tradera.com/GetAttributeDefinitions"

<?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:Header>
    <AuthenticationHeader xmlns="http://api.tradera.com">
      <AppId>int</AppId>
      <AppKey>string</AppKey>
    </AuthenticationHeader>
    <ConfigurationHeader xmlns="http://api.tradera.com">
      <Sandbox>int</Sandbox>
      <MaxResultAge>int</MaxResultAge>
    </ConfigurationHeader>
  </soap:Header>
  <soap:Body>
    <GetAttributeDefinitions xmlns="http://api.tradera.com">
      <categoryId>int</categoryId>
    </GetAttributeDefinitions>
  </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>
    <GetAttributeDefinitionsResponse xmlns="http://api.tradera.com">
      <GetAttributeDefinitionsResult>
        <AttributeDefinition>
          <Id>long</Id>
          <Name>string</Name>
          <Description>string</Description>
          <MaxNumberOfValues>int</MaxNumberOfValues>
          <MinNumberOfValues>int</MinNumberOfValues>
          <PossibleTermValues>
            <string>string</string>
            <string>string</string>
          </PossibleTermValues>
          <Key>string</Key>
        </AttributeDefinition>
        <AttributeDefinition>
          <Id>long</Id>
          <Name>string</Name>
          <Description>string</Description>
          <MaxNumberOfValues>int</MaxNumberOfValues>
          <MinNumberOfValues>int</MinNumberOfValues>
          <PossibleTermValues>
            <string>string</string>
            <string>string</string>
          </PossibleTermValues>
          <Key>string</Key>
        </AttributeDefinition>
      </GetAttributeDefinitionsResult>
    </GetAttributeDefinitionsResponse>
  </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 /v3/publicservice.asmx HTTP/1.1
Host: api.tradera.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:Header>
    <AuthenticationHeader xmlns="http://api.tradera.com">
      <AppId>int</AppId>
      <AppKey>string</AppKey>
    </AuthenticationHeader>
    <ConfigurationHeader xmlns="http://api.tradera.com">
      <Sandbox>int</Sandbox>
      <MaxResultAge>int</MaxResultAge>
    </ConfigurationHeader>
  </soap12:Header>
  <soap12:Body>
    <GetAttributeDefinitions xmlns="http://api.tradera.com">
      <categoryId>int</categoryId>
    </GetAttributeDefinitions>
  </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>
    <GetAttributeDefinitionsResponse xmlns="http://api.tradera.com">
      <GetAttributeDefinitionsResult>
        <AttributeDefinition>
          <Id>long</Id>
          <Name>string</Name>
          <Description>string</Description>
          <MaxNumberOfValues>int</MaxNumberOfValues>
          <MinNumberOfValues>int</MinNumberOfValues>
          <PossibleTermValues>
            <string>string</string>
            <string>string</string>
          </PossibleTermValues>
          <Key>string</Key>
        </AttributeDefinition>
        <AttributeDefinition>
          <Id>long</Id>
          <Name>string</Name>
          <Description>string</Description>
          <MaxNumberOfValues>int</MaxNumberOfValues>
          <MinNumberOfValues>int</MinNumberOfValues>
          <PossibleTermValues>
            <string>string</string>
            <string>string</string>
          </PossibleTermValues>
          <Key>string</Key>
        </AttributeDefinition>
      </GetAttributeDefinitionsResult>
    </GetAttributeDefinitionsResponse>
  </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 /v3/publicservice.asmx/GetAttributeDefinitions?categoryId=string HTTP/1.1
Host: api.tradera.com

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

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfAttributeDefinition xmlns="http://api.tradera.com">
  <AttributeDefinition>
    <Id>long</Id>
    <Name>string</Name>
    <Description>string</Description>
    <MaxNumberOfValues>int</MaxNumberOfValues>
    <MinNumberOfValues>int</MinNumberOfValues>
    <PossibleTermValues>
      <string>string</string>
      <string>string</string>
    </PossibleTermValues>
    <Key>string</Key>
  </AttributeDefinition>
  <AttributeDefinition>
    <Id>long</Id>
    <Name>string</Name>
    <Description>string</Description>
    <MaxNumberOfValues>int</MaxNumberOfValues>
    <MinNumberOfValues>int</MinNumberOfValues>
    <PossibleTermValues>
      <string>string</string>
      <string>string</string>
    </PossibleTermValues>
    <Key>string</Key>
  </AttributeDefinition>
</ArrayOfAttributeDefinition>

HTTP POST

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

POST /v3/publicservice.asmx/GetAttributeDefinitions HTTP/1.1
Host: api.tradera.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

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

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfAttributeDefinition xmlns="http://api.tradera.com">
  <AttributeDefinition>
    <Id>long</Id>
    <Name>string</Name>
    <Description>string</Description>
    <MaxNumberOfValues>int</MaxNumberOfValues>
    <MinNumberOfValues>int</MinNumberOfValues>
    <PossibleTermValues>
      <string>string</string>
      <string>string</string>
    </PossibleTermValues>
    <Key>string</Key>
  </AttributeDefinition>
  <AttributeDefinition>
    <Id>long</Id>
    <Name>string</Name>
    <Description>string</Description>
    <MaxNumberOfValues>int</MaxNumberOfValues>
    <MinNumberOfValues>int</MinNumberOfValues>
    <PossibleTermValues>
      <string>string</string>
      <string>string</string>
    </PossibleTermValues>
    <Key>string</Key>
  </AttributeDefinition>
</ArrayOfAttributeDefinition>

XHTML CSS