Skip to content

Latest commit

 

History

History
130 lines (119 loc) · 5 KB

get-all-employers.bak.md

File metadata and controls

130 lines (119 loc) · 5 KB
Raw

Get all employers

Returns a list of valid links indexed by empref in HAL format

Departmental Access with a Time-based One-Time Password (TOTP) in cases where the application needs to track amendments for schemes where the OAuth access token has expired is NOT applicable to this endpoint.

Authorisation

OAuth 2.0 Bearer Token with the read:apprenticeship-levy scope.

API

GET https://api.service.hmrc.gov.uk/apprenticeship-levy/

Request

Headers

Name Value
Accept application/vnd.hmrc.1.0+json
Authorization Bearer [token here]

Response

Successful Response

{
    "_links": {
        "self": {
            "href": "/"
        },
        "123/AB12345": {
            "href": "/epaye/123%2FAB12345"
        }
    },
    "emprefs": [
        "123/AB12345"
    ]
}
Name Type Description Example
_links.self URL The url to this endpoint /
_links.{empref} URL The url to an endpoint that provides more information about the empref /epaye/123%2FAB12345
emprefs[] String[] A list of emprefs for which links are provided ["123/AB12345"]

Error Responses

Code & Name Value Description Example
401 Unauthorized INVALID_CREDENTIALS The request requires correct authentication headers with valid token. { "code": "INVALID_CREDENTIALS", "message": "Invalid Authentication information provided" }
401 Unauthorized AUTH_ERROR_UNAUTHORIZED The request requires user authentication. Please ensure Grant authority has been given and bearer token is supplied with the request headers. { "code": "AUTH_ERROR_UNAUTHORIZED", "message": "Auth unauthorised error: GET of 'http://localhost:8080/auth/authority' returned 401. Response body: ''" }
403 Forbidden AUTH_ERROR_FORBIDDEN The request requires user authentication. Please ensure Grant authority has been given and bearer token is supplied with the request headers. { "code": "AUTH_ERROR_FORBIDDEN", "message": "Auth forbidden error: GET of 'http://localhost:8080/auth/authority' returned 403. Response body: ''" }
404 Not Found AUTH_ERROR_NOT_FOUND Endpoint or internal system has become unavailable. { "code": "AUTH_ERROR_NOT_FOUND", "message": "Auth endpoint not found: GET of '....' returned 404 (Not Found). Response body: ''" }
408 Request Time-out AUTH_ERROR_REQUEST_TIMEOUT Endpoint or internal system has become unresponsive. { "code": "AUTH_ERROR_REQUEST_TIMEOUT", "message": "Auth not responding error: GET of '...' timed out with message 'Request timeout to localhost/127.0.0.1:8080 after 500 ms'" }
408 Gateway Request Time-out AUTH_ERROR_GATEWAY_TIMEOUT Endpoint or internal system has become unresponsive. { "code": "AUTH_ERROR_GATEWAY_TIMEOUT", "message": "Auth not responding error: GET of '...' timed out with message 'Request timeout to localhost/127.0.0.1:8080 after 500 ms'" }
409 Internal API error AUTH_ERROR_TOO_MANY_REQUESTS Endpoint API has experienced too many requests. { "code": "AUTH_ERROR_TOO_MANY_REQUESTS", "message": "Auth too many requests: ...." }
498 Wrong token supplied. AUTH_ERROR_WRONG_TOKEN Endpoint or internal system has experienced an internal error. { "code": "AUTH_ERROR_WRONG_TOKEN", "message": "Auth unauthorised error: OAUTH 2 User Token Required not TOTP" }
500 Internal API error AUTH_ERROR_INTERNAL_SERVER_ERROR Endpoint API has experienced an internal error. { "code": "AUTH_ERROR_INTERNAL_SERVER_ERROR", "message": "API or Auth internal server error: ...." }
503 Service Unavailable AUTH_ERROR_BACKEND_FAILURE Endpoint or internal system has experienced an internal error. { "code": "AUTH_ERROR_BACKEND_FAILURE", "message": "Auth 5xx error: GET of '....' returned 500. Response body: ''" }
503 Other backend system error with 4xx reponse. AUTH_ERROR_OTHER Endpoint or internal system has experienced an internal error. { "code": "AUTH_ERROR_OTHER", "message": "Auth 5xx error: GET of '....' returned 500. Response body: ''" }
503 Backend system IO failure AUTH_ERROR_IO Endpoint API has experienced IO failure { "code": "AUTH_ERROR_IO", "message": "Auth connection error: ...." }