POST api/order

Creates new order for data to download

Request Information

URI Parameters

None.

Body Parameters

OrderType model

Geonorge.NedlastingApi.V3.OrderType
NameDescriptionTypeAdditional information
downloadAsBundle

boolean

None.

email

string

None.

downloadBundleUrl

string

None.

orderLines

Collection of Geonorge.NedlastingApi.V3.OrderLineType

None.

usageGroup

string

None.

softwareClient

string

None.

softwareClientVersion

string

None.

_links

Collection of Geonorge.NedlastingApi.V3.LinkType

None.

Request Formats

application/json, text/json

Sample:
{
  "downloadAsBundle": false,
  "email": "bruker@epost.no",
  "orderLines": [
    {
      "areas": [
        {
          "code": "02",
          "name": "Akershus",
          "type": "fylke"
        }
      ],
      "formats": [
        {
          "name": "SOSI 4.5"
        },
        {
          "name": "GML 3.2.1"
        }
      ],
      "metadataUuid": "041f1e6e-bdbc-4091-b48f-8a5990f3cc5b",
      "projections": [
        {
          "code": "25832",
          "name": "EUREF89 UTM sone 32, 2d",
          "codespace": "http://www.opengis.net/def/crs/EPSG/0/25832"
        },
        {
          "code": "25833",
          "name": "EUREF89 UTM sone 33, 2d",
          "codespace": "http://www.opengis.net/def/crs/EPSG/0/25833"
        },
        {
          "code": "25835",
          "name": "EUREF89 UTM sone 35, 2d",
          "codespace": "http://www.opengis.net/def/crs/EPSG/0/25835"
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:
<Order xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://skjema.geonorge.no/SOSI/tjenestespesifikasjon/nedlastingapi/3.0">
  <downloadAsBundle>false</downloadAsBundle>
  <email>bruker@epost.no</email>
  <downloadBundleUrl xsi:nil="true" />
  <orderLines>
    <orderline>
      <areas>
        <orderarea>
          <code>02</code>
          <name>Akershus</name>
          <type>fylke</type>
          <_links xsi:nil="true" />
        </orderarea>
      </areas>
      <formats>
        <format>
          <name>SOSI 4.5</name>
          <projections xsi:nil="true" />
          <_links xsi:nil="true" />
        </format>
        <format>
          <name>GML 3.2.1</name>
          <projections xsi:nil="true" />
          <_links xsi:nil="true" />
        </format>
      </formats>
      <metadataUuid>041f1e6e-bdbc-4091-b48f-8a5990f3cc5b</metadataUuid>
      <projections>
        <projection>
          <code>25832</code>
          <name>EUREF89 UTM sone 32, 2d</name>
          <codespace>http://www.opengis.net/def/crs/EPSG/0/25832</codespace>
          <formats xsi:nil="true" />
          <_links xsi:nil="true" />
        </projection>
        <projection>
          <code>25833</code>
          <name>EUREF89 UTM sone 33, 2d</name>
          <codespace>http://www.opengis.net/def/crs/EPSG/0/25833</codespace>
          <formats xsi:nil="true" />
          <_links xsi:nil="true" />
        </projection>
        <projection>
          <code>25835</code>
          <name>EUREF89 UTM sone 35, 2d</name>
          <codespace>http://www.opengis.net/def/crs/EPSG/0/25835</codespace>
          <formats xsi:nil="true" />
          <_links xsi:nil="true" />
        </projection>
      </projections>
      <_links xsi:nil="true" />
    </orderline>
  </orderLines>
  <usageGroup xsi:nil="true" />
  <softwareClient xsi:nil="true" />
  <softwareClientVersion xsi:nil="true" />
  <_links xsi:nil="true" />
</Order>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'System.Web.Http.ModelBinding.JQueryMvcFormUrlEncodedFormatter' to write type 'OrderType'.

Response Information

Resource Description

OrderReceiptType model with orderreference and a list of files to download if they are prepopulated, otherwise the files are delivered via email

Geonorge.NedlastingApi.V3.OrderReceiptType
NameDescriptionTypeAdditional information
referenceNumber

string

None.

files

Collection of Geonorge.NedlastingApi.V3.FileType

None.

email

string

None.

orderDate

date

None.

downloadAsBundle

boolean

None.

downloadBundleUrl

string

None.

_links

Collection of Geonorge.NedlastingApi.V3.LinkType

None.

Response Formats

application/json, text/json

Sample:
{
  "referenceNumber": "O-123456789",
  "files": [
    {
      "downloadUrl": "nedlastbarURI",
      "fileSize": "12345",
      "name": "AdministrativeEnheter_02_32.gml",
      "status": "ReadyForDownload"
    },
    {
      "downloadUrl": "nedlastbarURI",
      "fileSize": "12345",
      "name": "AdministrativeEnheter_02_32.sos",
      "status": "ReadyForDownload"
    },
    {
      "downloadUrl": "nedlastbarURI",
      "fileSize": "12345",
      "name": "AdministrativeEnheter_02_33.gml",
      "status": "ReadyForDownload"
    },
    {
      "downloadUrl": "nedlastbarURI",
      "fileSize": "12345",
      "name": "AdministrativeEnheter_02_33.sos",
      "status": "ReadyForDownload"
    },
    {
      "downloadUrl": "nedlastbarURI",
      "fileSize": "12345",
      "name": "AdministrativeEnheter_02_35.gml",
      "status": "ReadyForDownload"
    },
    {
      "downloadUrl": "nedlastbarURI",
      "fileSize": "12345",
      "name": "AdministrativeEnheter_02_35.sos",
      "status": "ReadyForDownload"
    }
  ],
  "orderDate": "0001-01-01T00:00:00",
  "downloadAsBundle": false
}

application/xml, text/xml

Sample:
<OrderReceipt xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://skjema.geonorge.no/SOSI/tjenestespesifikasjon/nedlastingapi/3.0">
  <referenceNumber>O-123456789</referenceNumber>
  <files>
    <file>
      <downloadUrl>nedlastbarURI</downloadUrl>
      <fileSize>12345</fileSize>
      <name>AdministrativeEnheter_02_32.gml</name>
      <fileId xsi:nil="true" />
      <metadataUuid xsi:nil="true" />
      <area xsi:nil="true" />
      <coordinates xsi:nil="true" />
      <projection xsi:nil="true" />
      <format xsi:nil="true" />
      <status>ReadyForDownload</status>
      <metadataName xsi:nil="true" />
      <areaName xsi:nil="true" />
      <projectionName xsi:nil="true" />
      <_links xsi:nil="true" />
    </file>
    <file>
      <downloadUrl>nedlastbarURI</downloadUrl>
      <fileSize>12345</fileSize>
      <name>AdministrativeEnheter_02_32.sos</name>
      <fileId xsi:nil="true" />
      <metadataUuid xsi:nil="true" />
      <area xsi:nil="true" />
      <coordinates xsi:nil="true" />
      <projection xsi:nil="true" />
      <format xsi:nil="true" />
      <status>ReadyForDownload</status>
      <metadataName xsi:nil="true" />
      <areaName xsi:nil="true" />
      <projectionName xsi:nil="true" />
      <_links xsi:nil="true" />
    </file>
    <file>
      <downloadUrl>nedlastbarURI</downloadUrl>
      <fileSize>12345</fileSize>
      <name>AdministrativeEnheter_02_33.gml</name>
      <fileId xsi:nil="true" />
      <metadataUuid xsi:nil="true" />
      <area xsi:nil="true" />
      <coordinates xsi:nil="true" />
      <projection xsi:nil="true" />
      <format xsi:nil="true" />
      <status>ReadyForDownload</status>
      <metadataName xsi:nil="true" />
      <areaName xsi:nil="true" />
      <projectionName xsi:nil="true" />
      <_links xsi:nil="true" />
    </file>
    <file>
      <downloadUrl>nedlastbarURI</downloadUrl>
      <fileSize>12345</fileSize>
      <name>AdministrativeEnheter_02_33.sos</name>
      <fileId xsi:nil="true" />
      <metadataUuid xsi:nil="true" />
      <area xsi:nil="true" />
      <coordinates xsi:nil="true" />
      <projection xsi:nil="true" />
      <format xsi:nil="true" />
      <status>ReadyForDownload</status>
      <metadataName xsi:nil="true" />
      <areaName xsi:nil="true" />
      <projectionName xsi:nil="true" />
      <_links xsi:nil="true" />
    </file>
    <file>
      <downloadUrl>nedlastbarURI</downloadUrl>
      <fileSize>12345</fileSize>
      <name>AdministrativeEnheter_02_35.gml</name>
      <fileId xsi:nil="true" />
      <metadataUuid xsi:nil="true" />
      <area xsi:nil="true" />
      <coordinates xsi:nil="true" />
      <projection xsi:nil="true" />
      <format xsi:nil="true" />
      <status>ReadyForDownload</status>
      <metadataName xsi:nil="true" />
      <areaName xsi:nil="true" />
      <projectionName xsi:nil="true" />
      <_links xsi:nil="true" />
    </file>
    <file>
      <downloadUrl>nedlastbarURI</downloadUrl>
      <fileSize>12345</fileSize>
      <name>AdministrativeEnheter_02_35.sos</name>
      <fileId xsi:nil="true" />
      <metadataUuid xsi:nil="true" />
      <area xsi:nil="true" />
      <coordinates xsi:nil="true" />
      <projection xsi:nil="true" />
      <format xsi:nil="true" />
      <status>ReadyForDownload</status>
      <metadataName xsi:nil="true" />
      <areaName xsi:nil="true" />
      <projectionName xsi:nil="true" />
      <_links xsi:nil="true" />
    </file>
  </files>
  <orderDate>0001-01-01T00:00:00</orderDate>
  <downloadAsBundle>false</downloadAsBundle>
  <downloadBundleUrl xsi:nil="true" />
  <_links xsi:nil="true" />
</OrderReceipt>