Skip to content

Commit

Permalink
Updated application.raml to include explicit root
Browse files Browse the repository at this point in the history
  • Loading branch information
flashingpumpkin committed Jul 3, 2017
1 parent cce03f6 commit 26fa1a0
Showing 1 changed file with 25 additions and 23 deletions.
48 changes: 25 additions & 23 deletions resources/public/api/conf/1.0/application.raml
Original file line number Diff line number Diff line change
Expand Up @@ -32,29 +32,31 @@ types:
pattern: "[a-zA-Z0-9]{3}/[a-zA-Z0-9]{7}"

/epaye:
get:
is: [ headers.acceptHeader ]
displayName: Get access to ePAYE data
description: This resource is the entry point to the ePAYE API. It will return a set of URLs, allowing you to access ePAYE data for each account. This will include the employer's ePAYE balance, monthly totals of RTI charges, non-RTI charges and a breakdown of individual charges.
securedBy: [ sec.oauth_2_0: { scopes: [ "read:epaye" ] } ]
responses:
200:
body:
application/json:
type: !include schemas/Epaye.get.schema.array.json
example: !include examples/Epaye.get.array.json
401:
body:
application/json:
type: !include schemas/ErrorCodes.schema.json
examples:
notOpenStatus:
description: You don't currently have an ePAYE enrolment on this account.
value: |
{
"code" : "INSUFFICIENT_ENROLMENTS",
"message" : "You are not currently enrolled for ePAYE"
}
/:
get:
is: [ headers.acceptHeader ]
displayName: Get access to ePAYE data
description: This resource is the entry point to the ePAYE API. It will return a set of URLs, allowing you to access ePAYE data for each account. This will include the employer's ePAYE balance, monthly totals of RTI charges, non-RTI charges and a breakdown of individual charges.
(annotations.scope): "read:epaye"
securedBy: [ sec.oauth_2_0: { scopes: [ "read:epaye" ] } ]
responses:
200:
body:
application/json:
type: !include schemas/Epaye.get.schema.array.json
example: !include examples/Epaye.get.array.json
401:
body:
application/json:
type: !include schemas/ErrorCodes.schema.json
examples:
notOpenStatus:
description: You don't currently have an ePAYE enrolment on this account.
value: |
{
"code" : "INSUFFICIENT_ENROLMENTS",
"message" : "You are not currently enrolled for ePAYE"
}
/{empRef}/total:
uriParameters:
empRef:
Expand Down

0 comments on commit 26fa1a0

Please sign in to comment.