BricksetAPIv2


Click here for a complete list of operations.

getCollectionDetail

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
apiKey:
userHash:
SetID:

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 /api/v2.asmx HTTP/1.1
Host: brickset.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://brickset.com/api/getCollectionDetail"

<?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>
    <getCollectionDetail xmlns="https://brickset.com/api/">
      <apiKey>string</apiKey>
      <userHash>string</userHash>
      <SetID>string</SetID>
    </getCollectionDetail>
  </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>
    <getCollectionDetailResponse xmlns="https://brickset.com/api/">
      <getCollectionDetailResult>
        <collectionDetails>
          <collectionID>int</collectionID>
          <dateAcquired>string</dateAcquired>
          <currency>string</currency>
          <pricePaid>decimal</pricePaid>
          <additionalPricePaid>decimal</additionalPricePaid>
          <currentEstimatedValue>decimal</currentEstimatedValue>
          <conditionWhenAcquired>string</conditionWhenAcquired>
          <acquiredFrom>string</acquiredFrom>
          <conditionNow>string</conditionNow>
          <location>string</location>
          <notes>string</notes>
          <parts>boolean</parts>
          <minifigs>boolean</minifigs>
          <instructions>boolean</instructions>
          <box>boolean</box>
          <willTrade>boolean</willTrade>
          <modified>boolean</modified>
          <deleted>boolean</deleted>
        </collectionDetails>
        <collectionDetails>
          <collectionID>int</collectionID>
          <dateAcquired>string</dateAcquired>
          <currency>string</currency>
          <pricePaid>decimal</pricePaid>
          <additionalPricePaid>decimal</additionalPricePaid>
          <currentEstimatedValue>decimal</currentEstimatedValue>
          <conditionWhenAcquired>string</conditionWhenAcquired>
          <acquiredFrom>string</acquiredFrom>
          <conditionNow>string</conditionNow>
          <location>string</location>
          <notes>string</notes>
          <parts>boolean</parts>
          <minifigs>boolean</minifigs>
          <instructions>boolean</instructions>
          <box>boolean</box>
          <willTrade>boolean</willTrade>
          <modified>boolean</modified>
          <deleted>boolean</deleted>
        </collectionDetails>
      </getCollectionDetailResult>
    </getCollectionDetailResponse>
  </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 /api/v2.asmx HTTP/1.1
Host: brickset.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>
    <getCollectionDetail xmlns="https://brickset.com/api/">
      <apiKey>string</apiKey>
      <userHash>string</userHash>
      <SetID>string</SetID>
    </getCollectionDetail>
  </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>
    <getCollectionDetailResponse xmlns="https://brickset.com/api/">
      <getCollectionDetailResult>
        <collectionDetails>
          <collectionID>int</collectionID>
          <dateAcquired>string</dateAcquired>
          <currency>string</currency>
          <pricePaid>decimal</pricePaid>
          <additionalPricePaid>decimal</additionalPricePaid>
          <currentEstimatedValue>decimal</currentEstimatedValue>
          <conditionWhenAcquired>string</conditionWhenAcquired>
          <acquiredFrom>string</acquiredFrom>
          <conditionNow>string</conditionNow>
          <location>string</location>
          <notes>string</notes>
          <parts>boolean</parts>
          <minifigs>boolean</minifigs>
          <instructions>boolean</instructions>
          <box>boolean</box>
          <willTrade>boolean</willTrade>
          <modified>boolean</modified>
          <deleted>boolean</deleted>
        </collectionDetails>
        <collectionDetails>
          <collectionID>int</collectionID>
          <dateAcquired>string</dateAcquired>
          <currency>string</currency>
          <pricePaid>decimal</pricePaid>
          <additionalPricePaid>decimal</additionalPricePaid>
          <currentEstimatedValue>decimal</currentEstimatedValue>
          <conditionWhenAcquired>string</conditionWhenAcquired>
          <acquiredFrom>string</acquiredFrom>
          <conditionNow>string</conditionNow>
          <location>string</location>
          <notes>string</notes>
          <parts>boolean</parts>
          <minifigs>boolean</minifigs>
          <instructions>boolean</instructions>
          <box>boolean</box>
          <willTrade>boolean</willTrade>
          <modified>boolean</modified>
          <deleted>boolean</deleted>
        </collectionDetails>
      </getCollectionDetailResult>
    </getCollectionDetailResponse>
  </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 /api/v2.asmx/getCollectionDetail?apiKey=string&userHash=string&SetID=string HTTP/1.1
Host: brickset.com
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfCollectionDetails xmlns="https://brickset.com/api/">
  <collectionDetails>
    <collectionID>int</collectionID>
    <dateAcquired>string</dateAcquired>
    <currency>string</currency>
    <pricePaid>decimal</pricePaid>
    <additionalPricePaid>decimal</additionalPricePaid>
    <currentEstimatedValue>decimal</currentEstimatedValue>
    <conditionWhenAcquired>string</conditionWhenAcquired>
    <acquiredFrom>string</acquiredFrom>
    <conditionNow>string</conditionNow>
    <location>string</location>
    <notes>string</notes>
    <parts>boolean</parts>
    <minifigs>boolean</minifigs>
    <instructions>boolean</instructions>
    <box>boolean</box>
    <willTrade>boolean</willTrade>
    <modified>boolean</modified>
    <deleted>boolean</deleted>
  </collectionDetails>
  <collectionDetails>
    <collectionID>int</collectionID>
    <dateAcquired>string</dateAcquired>
    <currency>string</currency>
    <pricePaid>decimal</pricePaid>
    <additionalPricePaid>decimal</additionalPricePaid>
    <currentEstimatedValue>decimal</currentEstimatedValue>
    <conditionWhenAcquired>string</conditionWhenAcquired>
    <acquiredFrom>string</acquiredFrom>
    <conditionNow>string</conditionNow>
    <location>string</location>
    <notes>string</notes>
    <parts>boolean</parts>
    <minifigs>boolean</minifigs>
    <instructions>boolean</instructions>
    <box>boolean</box>
    <willTrade>boolean</willTrade>
    <modified>boolean</modified>
    <deleted>boolean</deleted>
  </collectionDetails>
</ArrayOfCollectionDetails>

HTTP POST

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

POST /api/v2.asmx/getCollectionDetail HTTP/1.1
Host: brickset.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

apiKey=string&userHash=string&SetID=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfCollectionDetails xmlns="https://brickset.com/api/">
  <collectionDetails>
    <collectionID>int</collectionID>
    <dateAcquired>string</dateAcquired>
    <currency>string</currency>
    <pricePaid>decimal</pricePaid>
    <additionalPricePaid>decimal</additionalPricePaid>
    <currentEstimatedValue>decimal</currentEstimatedValue>
    <conditionWhenAcquired>string</conditionWhenAcquired>
    <acquiredFrom>string</acquiredFrom>
    <conditionNow>string</conditionNow>
    <location>string</location>
    <notes>string</notes>
    <parts>boolean</parts>
    <minifigs>boolean</minifigs>
    <instructions>boolean</instructions>
    <box>boolean</box>
    <willTrade>boolean</willTrade>
    <modified>boolean</modified>
    <deleted>boolean</deleted>
  </collectionDetails>
  <collectionDetails>
    <collectionID>int</collectionID>
    <dateAcquired>string</dateAcquired>
    <currency>string</currency>
    <pricePaid>decimal</pricePaid>
    <additionalPricePaid>decimal</additionalPricePaid>
    <currentEstimatedValue>decimal</currentEstimatedValue>
    <conditionWhenAcquired>string</conditionWhenAcquired>
    <acquiredFrom>string</acquiredFrom>
    <conditionNow>string</conditionNow>
    <location>string</location>
    <notes>string</notes>
    <parts>boolean</parts>
    <minifigs>boolean</minifigs>
    <instructions>boolean</instructions>
    <box>boolean</box>
    <willTrade>boolean</willTrade>
    <modified>boolean</modified>
    <deleted>boolean</deleted>
  </collectionDetails>
</ArrayOfCollectionDetails>