Goals

Supported Formats

json
>>>

GET /api/goals
Lists Goals

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

Params

Param name Description
year
optional

Default is current year

Validations:

  • Must be a Integer
>>>

POST /api/goals
Creates goal

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
422 Unprocessable Entity

Params

Param name Description
goal
required

Parameter Container

Validations:

  • Must be a Hash
goal[date]
required

Validations:

  • Must be a Date
goal[cents]
required

Validations:

  • Must be a Integer
>>>

PUT /api/goals/:id
Updates goal

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

Params

Param name Description
id
required

Validations:

  • Must be a String
goal
required

Parameter Container

Validations:

  • Must be a Hash
goal[date]
required

Validations:

  • Must be a Date
goal[cents]
required

Validations:

  • Must be a Integer