Skip to content

Latest commit

 

History

History
113 lines (76 loc) · 1.72 KB

API_ADD_SUBURB.md

File metadata and controls

113 lines (76 loc) · 1.72 KB

Add Suburb API

Adds a suburb.

  • URL

    /suburbs

  • Method:

    POST

  • URL Params

    None

  • Data Params

   {
     "name": "Warranwood",
     "state": "VIC",
     "postCode": "/postcodes/1"
   }

Required:

name=[string]

state=[string]

postCode=[reference to post code HATEOAS resource]

  • Security

    • Authorization Server Endpoint for retrieving authorization code and exchanging for {JWT_ACCESS_TOKEN}: /oauth/authorize
    • Authorization header: "Authorization", "Bearer {JWT_ACCESS_TOKEN}"
  • Success Response:

    • Code: 200

      Content:

  {
    "name": "Warranwood",
    "state": "VIC",
    "_links": {
        "self": {
            "href": "http://localhost:8080/suburbs/38"
        },
        "suburb": {
            "href": "http://localhost:8080/suburbs/38"
        },
        "postCode": {
            "href": "http://localhost:8080/suburbs/38/postCode"
        }
    }
}
  • Error Response 400:

    • Code: 400 BAD REQUEST

      Content

{
    "httpStatus": "409 - CONFLICT",
    "errorCode": "2e482454-5148-4bf4-9ab7-84c7f65b318f",
    "errorMessage": "Data integrity violation error. Please contact an administrator and quote '2e482454-5148-4bf4-9ab7-84c7f65b318f'"
}
  • Error Response 401:

    • Code: 401 UNAUTHORIZED

      Content

{
    "timestamp": 1498176214518,
    "status": 401,
    "error": "Unauthorized",
    "message": "Full authentication is required to access this resource",
    "path": "/suburbs"
}   
  • Sample Call:

    POST /suburbs
    
    {
 		"name": "Warranwood",
  		"state": "VIC",
  		"postCode": "/postcodes/1"
    }