[[start#objects|<< zurück]]

==== address object ====

^ Method  ^ URL                      ^ Notes                                              ^
| GET     | /rest/{IF}/address       | returns a list of all addresses in database        |
| GET     | /rest/{IF}/address/{id}  | returns information about a single address object  |

== available parameters ==

^ Parameter  ^ Type    ^ Method            ^ Notes                                          ^
| id         | int     | GET, PUT, DELETE  | unique identifier of the object                |
| street     | string  | POST,PUT          | address information                            |
| number     | string  | POST, PUT         | address information                            |
| county     | string  | POST, PUT         | address information                            |
| city       | string  | POST, PUT         | address information                            |
| postcode   | string  | POST, PUT         | address information                            |
| type       | string  | POST, PUT         | address type like main, postal, delivery etc.  |
| notes      | text    | POST, PUT         | further notes or description                   |
| area_id    | int     | POST              | link to belonging geographical area            |

[[start#objects|<< zurück]]