Versions Compared

Key

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

...

Expand
titleGET /pickuppoint/GetPickUpPoints/{countryCode}/{postCode}/{carrier}

GET /pickuppoint/

GetPickUpPoints

GetAllPickUpPoints/{carrier}/{countryCode}/{postCode}/{street?}/{

carrier

streetNumber?}

This action returns a list of pick-up points close to the postcode that was sent to this action. Must contain country code, postcode and name of carrier.
Max 5 results.

  • The "countryCode" field:

  • The "postCode" field:

    • Must contain the value of a valid and existing post code.

    • Post code must exist in the country chosen in field countryCode.

  • The "carrier" field:

    • Must have the name of a carrier supported by Proteria.

    • As of Desember 2017, these are:

      • Bring

      • PostNord

  • The "street" field (optional):

    • Must be a valid street name.

    • Street name must exist in the post code chosen in field postCode.

  • The "streetNumber" field (optional):

    • Should be a valid street number.

The url must be constructed using this format, although street and streetNumber are optional fields:

URL Pattern
Code Block
languagejs
https://cloudconnect.Proteria.com/pickuppoint/GetPickUpPoints/{countryCodecarrier}/{postCodecountryCode}/{carrierpostCode}/{street?}/{streetNumber?}

Replace {countryCode} with a valid ISO2 country code, {postCode} with a valid and existing postcode, and {carrier} with the name of a carrier supported in the Proteria systems.  

Replace {street} with a valid street name in the currently selected {postCode}.

For example, is you call this action with country code NOpost code 9991 and carrier Bring

URL Example
Code Block
languagejs
https://cloudconnect.Proteria.com/pickuppoint/GetPickUpPoints/NO/9991/Bring

Result:

JSON response
Code Block
languagejs
{
    "pickUpPoints": [
        {
            "id": "127390",
            "name": "Extra Båtsfjord",
            "address": "HAVNEGATA 2",
            "postcode": "9990",
            "city": "BÅTSFJORD",
            "countryCode": "NO",
            "latitude": 70.637387041799,
            "longitude": 29.726844386049567
        },
        {
            "id": "127373",
            "name": "Matkroken Berlevåg",
            "address": "STORGATA 7",
            "postcode": "9980",
            "city": "BERLEVÅG",
            "countryCode": "NO",
            "latitude": 70.85703147746338,
            "longitude": 29.086313368005154
        },
		. . . 
    ]
}

Expand
titleGET /pickuppoint/GetParcelBoxPoints/{carrier}/{countryCode}/{postCode}

GET /pickuppoint/GetParcelBoxPoints/{carrier}/{countryCode}/{postCode}/{street?}/{streetNumber?}

This action returns a list of parcel boxes close to the postcode that was sent to this action. Must contain name of carrier, country code, and postcode.

  • The "carrier" field:

    • Must have the name of a carrier supported by Proteria.

    • As of Desember 2017, these are:

      • Bring

      • PostNord

  • The "countryCode" field:

  • The "postCode" field:

    • Must contain the value of a valid and existing post code.

    • Post code must exist in the country chosen in field countryCode.

  • The "street" field (optional):

    • Must be a valid street name.

    • Street name must exist in the post code chosen in field postCode.

  • The "streetNumber" field (optional):

    • Should be a valid street number.

The url must be constructed using this format, although street and streetNumber are optional fields:

URL Pattern
Code Block
languagejs
https://cloudconnect.Proteria.com/pickuppoint/GetParcelBoxPoints/{countryCode}/{postCode}/{street?}/{streetNumber}

Replace {countryCode} with a valid ISO2 country code, {postCode} with a valid and existing postcode, and {carrier} with the name of a carrier supported in the Proteria systems.  

Replace {street} with a valid street name in the currently selected {postCode}.

For example, is you call this action with carrier Bring, country code NOpost code 1712

URL Example
Code Block
languagejs
https://cloudconnect.Proteria.com/pickuppoint/GetParcelBoxPoints/BRING/NO/1712/

Result:

JSON response
Code Block
languagejs
{
    "pickUpPoints": [
        {
            "id": "113284",
            "name": "Pakkeboks Asvo Bruktmarked",
            "address": "GRÅLUMVEIEN 192",
            "postcode": "1712",
            "city": "GRÅLUM",
            "countryCode": "NO",
            "latitude": 59.285832499102114,
            "longitude": 11.058674538778082
        },
        {
            "id": "110428",
            "name": "Pakkeboks Esso Grålum",
            "address": "BJØRNSTADVEIEN 10",
            "postcode": "1712",
            "city": "GRÅLUM",
            "countryCode": "NO",
            "latitude": 59.295096557260848,
            "longitude": 11.065633980094994
        },
        ...
    ]
}

Expand
titleGET /pickuppoint/GetMannedPickupPoints/{carrier}/{countryCode}/{postCode}

GET /pickuppoint/GetMannedPickupPoints/{carrier}/{countryCode}/{postCode}/{street?}/{streetNumber?}

This action returns a list of manned pickup points close to the postcode that was sent to this action. Must contain name of carrier, country code, and postcode.

  • The "carrier" field:

    • Must have the name of a carrier supported by Proteria.

    • As of Desember 2017, these are:

      • Bring

      • PostNord

  • The "countryCode" field:

  • The "postCode" field:

    • Must contain the value of a valid and existing post code.

    • Post code must exist in the country chosen in field countryCode.

  • The "street" field (optional):

    • Must be a valid street name.

    • Street name must exist in the post code chosen in field postCode.

  • The "streetNumber" field (optional):

    • Should be a valid street number.

The url must be constructed using this format, although street and streetNumber are optional fields:

URL Pattern
Code Block
languagejs
https://cloudconnect.Proteria.com/pickuppoint/GetMannedPickupPoints/{carrier}/{countryCode}/{postCode}/{street?}/{streetNumber}

Replace {countryCode} with a valid ISO2 country code, {postCode} with a valid and existing postcode, and {carrier} with the name of a carrier supported in the Proteria systems.  

Replace {street} with a valid street name in the currently selected {postCode}.

For example, is you call this action with carrier Bring, country code NOpost code 1712

URL Example
Code Block
languagejs
https://cloudconnect.Proteria.com/pickuppoint/GetMannedPickupPoints/BRING/NO/1712/

Result:

JSON response
Code Block
languagejs
{
    "pickUpPoints": [
        {
            "id": "121518",
            "name": "Extra Grålum",
            "address": "VESTERHEIMVEIEN 2",
            "postcode": "1712",
            "city": "GRÅLUM",
            "countryCode": "NO",
            "latitude": 59.294283208743941,
            "longitude": 11.064603165110883
        },
        {
            "id": "121635",
            "name": "Extra Tune",
            "address": "LILLETUNEVEIEN 3",
            "postcode": "1711",
            "city": "SARPSBORG",
            "countryCode": "NO",
            "latitude": 59.287693555888843,
            "longitude": 11.082480232984947
        },
        ...
    ]
}

...