Commitments API

Commitments API for the Digital Apprenticeship Service

For Commitments V2, see: https://github.com/SkillsFundingAgency/das-commitments/tree/master/src/CommitmentsV2

Getting started Api (covering v1 and v2)

Clone das-commitments repo
Open das-commitments solution - build fails. This is due to a Slow Cheetah issue. To workaround, change build configuration to Release and build, then back to Debug and build. Solution will then build ok.
Run the SFA.DAS.CommitmentsV2.Api project.
Publish the database project to local db server (use default db name "SFA.DAS.Commitments.Database")
Execute sql to seed data - see https://github.com/SkillsFundingAgency/das-commitments/tree/master/src/CommitmentsV2
Obtain cloud config
Run Storage Emulator (for v2)
Start

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}