POST order

Places an order. An orderid is returned upon successfull validation of the order configuration. The order is then processed async.

Request Information

URI Parameters

None.

Body Parameters

The order configuration

OrderParameters
NameDescriptionTypeAdditional information
configurationitems

a collection of order item configurations; each order should contain at least one

Collection of OrderItemConfiguration

None.

Request Formats

application/json, text/json

Sample:
{
  "configurationitems": [
    {
      "productid": 0,
      "format": "Shapefile",
      "filetype": "Diff",
      "geographicalCrop": {
        "clip": false,
        "selectionentitycode": "spltrefgem",
        "predefinedvalue": "Aartselaar"
      },
      "temporalCrop": {
        "from": "2012-01-01T15:00:00",
        "to": "2020-10-27T11:08:17.5180282+01:00"
      }
    },
    {
      "productid": 0,
      "format": "GML",
      "filetype": "Full",
      "geographicalCrop": {
        "clip": true,
        "selectionentitycode": "Custom",
        "polygon": {
          "coordinates": [
            [
              [
                0.0,
                0.0
              ],
              [
                0.0,
                0.0
              ],
              [
                0.0,
                0.0
              ],
              [
                0.0,
                0.0
              ]
            ]
          ],
          "type": "Polygon"
        }
      }
    }
  ]
}

application/xml, text/xml

Sample:
<OrderParameters xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <OrderItemConfigurations>
    <OrderItemConfiguration>
      <ProductId>0</ProductId>
      <Format>Shapefile</Format>
      <FileType>Diff</FileType>
      <GeographicalCrop>
        <Clip>false</Clip>
        <SelectionEntityCode>spltrefgem</SelectionEntityCode>
        <PredefinedValue>Aartselaar</PredefinedValue>
      </GeographicalCrop>
      <TemporalCrop>
        <From>2012-01-01T15:00:00</From>
        <To>2020-10-27T11:08:17.5180282+01:00</To>
      </TemporalCrop>
      <PointInTime xsi:nil="true" />
    </OrderItemConfiguration>
    <OrderItemConfiguration>
      <ProductId>0</ProductId>
      <Format>GML</Format>
      <FileType>Full</FileType>
      <GeographicalCrop>
        <Clip>true</Clip>
        <SelectionEntityCode>Custom</SelectionEntityCode>
        <polygon xmlns="http://www.opengis.net/gml">
          <exterior>
            <LinearRing>
              <posList>0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0</posList>
            </LinearRing>
          </exterior>
        </polygon>
      </GeographicalCrop>
      <PointInTime xsi:nil="true" />
    </OrderItemConfiguration>
  </OrderItemConfigurations>
</OrderParameters>

Response Information

Resource Description

OrderConfirmation
NameDescriptionTypeAdditional information
orderid

a unique id for the order

string

None.

Response Formats

application/json, text/json

Sample:
{
  "orderid": "360-A0BF"
}

application/xml, text/xml

Sample:
<OrderConfirmation xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <OrderId>360-A0BF</OrderId>
</OrderConfirmation>