Author: Yang Lei
This example supports various RESTFul end points which also includes JSONP support for cross domain requests.
By default the base URL for services is /jboss-contacts-angularjs/rest.
##CREATE
- Request type: POST
- Request type: JSON
- Return type: JSON
- Request example:
{email: "jane.doe@company.com", id: 14, firstName: "Jane", lastName: 'Doe', phoneNumber: "03322341231"}- Response example:
- Success: 200 OK
- Validation error: Collection of
<field name>:<error msg>for each error
{"email":"That email is already used, please use a unique email"}##READ
- Request type: GET
- Return type: JSON
- Response example:
[{email: "jane.doe@company.com", id: 14, firstName: "Jane", lastName: 'Doe', phoneNumber: "01222351231"},
{email: "john.doe@company.com", id: 15, firstName: "John", lastName: 'Doe', phoneNumber: "01355531212"}]- Request type: GET
- Return type: JSON
- Response example:
{email: "jane.doe@company.com", id: 14, firstName: "Jane", lastName: 'Doe', phoneNumber: "02232231231"}##UPDATE
- Request type: PUT
- Return type: JSON
- Response example:
{email: "jane.doe@company.com", id: 14, firstName: "Jane", lastName: 'Doe', phoneNumber: "02232231231"}
##DELETE
- Request type: DELETE
- Return type: JSON
- Response example:
{email: "jane.doe@company.com", id: 14, firstName: "Jane", lastName: 'Doe', phoneNumber: "08876764343"}##CREATE
- Request type: POST
- Request type: JSON
- Return type: JSON
- Request example:
{postcode: "DD3FF4", id: 14, name: "Wen", phoneNumber: "03322341231"}- Response example:
- Success: 200 OK
- Validation error: Collection of
<field name>:<error msg>for each error
{"phoneNumber":"That phoneNumber is already used, please use a unique phoneNumber"}##READ
- Request type: GET
- Return type: JSON
- Response example:
[{postcode: "DD3FF4", id: 14, name: "Wen", phoneNumber: "03322341231"},
{postcode: "DD3FF4", id: 15, name: "HUA", phoneNumber: "03362341231"}]- Request type: GET
- Return type: JSON
- Response example:
{postcode: "DD3FF4", id: 14, name: "J", phoneNumber: "03322341231"}##UPDATE
- Request type: PUT
- Return type: JSON
- Response example:
{postcode: "DG4FF4", id: 14, name: "xi", phoneNumber: "02256561231"}
##DELETE
- Request type: DELETE
- Return type: JSON
- Response example:
{postcode: "DD3FF4", id: 14, name: "Wen", phoneNumber: "03322341231"}##CREATE
- Request type: POST
- Request type: JSON
- Return type: JSON
- Request example:
{customId: 1, hotelId: 12, bookingDate:'2016-09-09'}- Response example:
- Success: 200 OK
- Validation error: Collection of
<field name>:<error msg>for each error
{"hotel&bookingDate":"That hotel is already booked on that day, please try another date"}##READ
- Request type: GET
- Return type: JSON
- Response example:
[{customId: 1, hotelId: 12, bookingDate:'2016-09-09'},
{customId: 2, hotelId: 13, bookingDate:'2016-09-10'}]- Request type: GET
- Return type: JSON
- Response example:
{customId: 1, hotelId: 12, bookingDate:'2016-09-09'}##UPDATE
- Request type: PUT
- Return type: JSON
- Response example:
{customId: 1, hotelId: 12, bookingDate:'2016-09-09'}
##DELETE
- Request type: DELETE
- Return type: JSON
- Response example:
{customId: 1, hotelId: 12, bookingDate:'2016-09-09'}