API Reference
Start developing plugins for BizFusion.

 
Address (AddressDTO)

You can add zero or more addresses to a customer.
Registering an address is not required, but we do recommend it.


Properties
property data type reference
AddressId Int32 Primary Key
StreetName String
BuildingNumber String
Zipcode String
City String
Province String
CountryId Int32 CountryDTO
CustomerId Int32 CustomerDTO
AddressTypeId Int32 AddressTypeDTO
Timestamp String


Methods
method parameters URL
Get
/api/Address
Get
Int32 id
/api/Address?id={value}
Get
Int32 pageIndex, Int32 recordsPerPage
/api/Address?pageIndex={value}&recordsPerPage={value}
Post /api/Address
Put
Int32 id, AddressDTO record
/api/Address?id={value}
Delete
Int32 id, String timestamp
/api/Address?id={value}&timestamp={value}
GetRecordCount
/api/AddressSet/RecordCount
GetByCustomerId
Int32 id
/api/AddressSet/ByCustomerId?id={value}
GetByField
String field, String value
/api/AddressSet/ByField?field={value}&value={value}
GetAfterId
Int32 id
/api/AddressSet/AfterId?id={value}
GetBeforeId
Int32 id
/api/AddressSet/BeforeId?id={value}
GetMaxId
/api/AddressSet/MaxId


JSON sample
{
  "Timestamp": "AQIDDQ==",
  "AddressId": 1,
  "StreetName": "Wayne Manor",
  "BuildingNumber": "1",
  "Zipcode": "1122WM",
  "City": "Gotham City",
  "Province": "New York",
  "CountryId": 1,
  "CustomerId": 2,
  "AddressTypeId": 1
}


General Info

- Numbers should be in English format: 124.99
- Dates look like: 2014-12-31T00:00:00
- Time information is ignored.
- Concurrency is handled through timestamps

Create Record (POST)

- Primary keys are not required when doing a post.
- Timestamps are not required when doing a post.
- Provide the JSON record in the body of the post request.

Update Record (PUT)

- Timestamps are required.
- Provide the JSON record in the body of the put request.

Delete Record (DELETE)

- Primary key and Timestamp are required.