Versions Compared

Version Old Version 1 New Version 2
Changes made by

Jo Dybdal (Deactivated)

Jo Dybdal (Deactivated)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Create an order

To create an order, you need to use the access_token that you previously obtained.

Take a look at our Swagger documentation for the API here: Swagger

Send a POST request to https://beta-api.ambita.com/kode/v1/orders/cadastre

Example request

Code Block
curl -s \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer ej577asf-a5k6-42yq-a3a2-fh03hb8cb58c" \
      https://beta-api.ambita.com/kode/v1/orders/cadastre -d "
        {
                \"deliveryInformation\": {
                  // delivery information object
                },
                \"orderData\": {
                  \"address\": \"Infoveien 1, 9999 Infoland\",
                  \"cadastre\": \"9999-1-1-0-0\"
                },
                \"products\": [
                  {
                    \"code\": \"WI99990033\"
                  }
                ],
                \"reference\": \"some-reference\",
                \"technicalReference\": \"some-technical-reference\"
        }"

JSON body structure

Property

Description

deliveryInformation*

Object that includes information related to delivery of the products, see section below

orderData

Order data required to order the products specified which will differ based on the type of product being ordered between cadastre, share, map products, see section below

reference

This reference is used to connect multiple orders to one reference, usually an assignment key and commonly used for billing reference

technicalReference*

This reference is used to reference an order in our system, to a unique id in your system, good for debugging and lookups

products

Array of objects, see section below

* indicates optional fields

deliveryInformation object

Property

Description

address*

Address line

address2*

Address line 2

address3*

Address line 3

alias*

Alias

companyName*

Company name

email*

Email

name*

Name

phone*

Phone

postalCode*

Postal code

* indicates optional fields

orderData object

Property

Description

For ordering cadastre products, see example below

 

address

Important to use this format {Street address}, {Postal code} {Postal office}, for example, Infoveien 1, 9999 Infoland

cadastre

Cadastre should always include all required parts {Kommunenummer}-{Gårdsnummer}-{Bruksnummer}-{Festenummer}-{Seksjonsnummer}, for example, 0301-100-10-0-0

For ordering share products, see example below

 

organizationNumber

Organization number

shareNumber

Share number

For ordering map product, see example below

 

geometry

A closed GeoJSON polygon specified in ETRS89 / UTM zone 33N or ETRS89 / UTM zone 32N

spatialReference

Spatial reference the geometry is specified in either 25833 or 25832

Example cadastre products orderData

Code Block
"orderData": {
  "address": "Infoveien 1, 9999 Infoland",
  "cadastre": "9999-1-1-0-0"
}

Example share products orderData

Code Block
"orderData": {
  "organizationNumber": 988424587,
  "shareNumber": 136
}

Example map products orderData

Code Block
"orderData": {
  "geometry": {
    "type": "Polygon",
    "coordinates": [[
      [679906.435383017,7741056.419552005],
      [679906.4572162632,7742527.458934937],
      [681832.6049002217,7742527.507026337],
      [681832.6139410603,7741056.365899973],
      [679906.435383017,7741056.419552005]
    ]]
  },
  "spatialReference": "25833"
}

products array of objects

Property

Description

code

Use product API to find correct product codes in given municipality

data*

Additional data required to order specific products that varies based on a product, see example below

* indicates optional fields

Example map products array with additional data

Code Block
"products": [
  {
    "code": "WI54016101",
    "data": {
      "format": "UTM"
    }
  }
]

Example response

Code Block
{
  "id": 1664984,
  "status": "NEW",
  "priceNet": 0,
  "priceVat": 0,
  "dateOrdered": "2021-01-28T09:10:15+0100",
  "dateStatus": "2021-01-28T09:10:15+0100",
  "orders": [
    {
      "id": 2640649,
      "supplierName": "Tromsø kommune",
      "user": "Test User",
      "technicalReference": null,
      "orderLines": [
        {
          "id": 11603164,
          "status": {
            "code": "NEW",
            "name": "New order. Has not been processed yet."
          },
          "product": "WI54016101",
          "productName": "Basiskart som vektordata",
          "productType": {
            "code": "0",
            "name": "NORMAL"
          },
          "mediaType": "Datafil",
          "delivery": "Elektronisk",
          "priceNet": 0,
          "priceVat": 0
        }
      ]
    }
  ]
}