VismaBouwsoftAPICalls.v1_POST_AddressGroups Method
v1_POST_AddressGroups() as String

This API call is used to add a(n) AddressGroup

General Description

HTTP method API version
POST v1

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

API Path: /AddressGroups
or

Fields

The following fields are available:

Field Name Type Id Type Name Length Required Writeable Force Write Link
list 2 tpString 0 Yes Yes No
group 2 tpString 100 Yes Yes No
groupid 1 tpLong 0 No No No
adreslijstid 1 tpLong 0 No No No

/AddressGroups

API Path: /AddressGroups/

If everything succeeds the HTTP response status is 201
(201 CREATED)

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

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/AddressGroups

with the following parameters :

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

Query Parameters :
ParameterName: columns, ParameterValue: list=’Clients‘,group=’testgroepAPI’

Success gives statuscode 201 And the following result

{“RecordChanges”: [
  {
    "id": 107,
    "list": "Clients",
    "group": "testgroepAPI",
    "groupid": 107,
    "adreslijstid": 0
  }
]
}