Skip to content

Ryan-Fitchett/Test

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 

Repository files navigation

Commitments API

Commitments API for the Digital Apprenticeship Service

Build status

Build Status

Methods

api/provider/
    GET       {providerId}/commitments
    GET       {providerId}/commitments/{commitmentId}
    GET       {providerId}/apprenticeships
    GET       {providerId}/apprenticeships/{apprenticeshipId}
    PATCH     {providerId}/commitments/{commitmentId}
    DELETE    {providerId}/commitments/{commitmentId}
    POST      {providerId}/commitments/{commitmentId}/apprenticeships
    PUT       {providerId}/commitments/{commitmentId}/apprenticeships/{apprenticeshipId}
    POST      {providerId}/commitments/{commitmentId}/apprenticeships/bulk
    DELETE    {providerId}/apprenticeships/{apprenticeshipId}
    GET       {providerId}/relationships/{employerAccountId}/{legalEntityId}
    GET       {providerId}/relationships/{commitmentId}
    PATCH     {providerId}/relationships/{employerAccountId}/{legalEntityId}

api/employer/
    GET       {accountId}/commitments
    GET       {accountId}/commitments/{commitmentId}
    GET       {accountId}/apprenticeships
    GET       {accountId}/apprenticeships/{apprenticeshipId}
    POST      {accountId}/commitments/
    PATCH     {accountId}/commitments/{commitmentId}
    DELETE    {accountId}/commitments/{commitmentId}
    POST      {accountId}/commitments/{commitmentId}/apprenticeships
    PUT       {accountId}/commitments/{commitmentId}/apprenticeships/{apprenticeshipId}
    PATCH     {accountId}/commitments/{commitmentId}/apprenticeships/{apprenticeshipId}
    DELETE    {accountId}/apprenticeships/{apprenticeshipId}

Client

A .Net client for the Api can be found on NuGet.