VismaBouwsoftAPICalls.v1_GET_ZipCodes

Method

v1_GET_ZipCodes() as String

This API call is used to get fields of a(n) ZipCode(s)

HTTP method	API version
GET	v1

Don’t forget to put the Authorization field in the header

API Path: /ZipCodes/
or
API Path: /ZipCodes/{id}

You can make this API call:
* without the key field id to get a list of ZipCodes
* with the key field id as the path parameter (the specific id of the ZipCode you want to get)

Fields

The following fields are available:

Field Name	Type
id	Number
countrycode	String
zipcode	String
city	String
state	String
country	String
telephoneprefix	Number

/ZipCodes/

API Path: /ZipCodes/

If everything succeeds the HTTP response status is 200
(200 OK)

If there is something wrong with the request, the response status and code is 400
(400 Bad Request)

If you forget to send the Authorization, the response status is 401
(401 Unauthorized)

If what you sent can’t be processed, the response status is 500
(500 Internal Server Error)

For an explanation of all possible errors, please consult our section on possible answers to API calls here

Examples:

https://ra.bouwsoft.be/api/v1/ZipCodes

with the following parameters :

Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: OtOfWxftVAzSfIGbrfzRqrOffPfbGfmbfDObzmOPmmtfttmVlj

Query Parameters :
ParameterName: limit, ParameterValue: 5
ParameterName: sort, ParameterValue: id

Success gives statuscode 200 And the following result

{ “Content-Range”:“0–4/21876”, “Records”: [
  {
    "id": 1,
    "countrycode": "BE",
    "zipcode": "8377",
    "city": "Meetkerke",
    "state": "West-vlaanderen",
    "country": "BELGIUM",
    "telephoneprefix": 32
  },
  {
    "id": 3,
    "countrycode": "FI",
    "zipcode": "00100",
    "city": "Helsinki 10",
    "state": "",
    "country": "FINLAND",
    "telephoneprefix": 358
  }
,
…
]
}

/ZipCodes/{id}