Skip to content

Instantly share code, notes, and snippets.

@dexit

dexit/pics-swagger.openapi.json

Created August 29, 2025 13:24
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save dexit/1d9689a9b1e8e4fca60816a37883a0ac to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save dexit/1d9689a9b1e8e4fca60816a37883a0ac to your computer and use it in GitHub Desktop.
Download ZIP
pics swagger
Raw
pics-swagger.openapi.json
{
"openapi": "3.0.1",
"info": {
"title": "PICS API",
"description": "This is the documentation endpoint for the PICS REST Service. Further documentation available at <a href=\"https://pellcomp.atlassian.net/wiki/spaces/POH/pages/3384082435\" target=\"_blank\">PICS Online Help</a>",
"version": "1.0"
},
"paths": {
"/api/v1/applicants": {
"get": {
"tags": [
"Applicants"
],
"summary": "Search Applicants",
"description": "Sample request:\r\n\r\n GET /Applicants?Surname=Wilson",
"parameters": [
{
"name": "surname",
"in": "query",
"description": "Search for Applicants by Surname",
"schema": {
"title": "String",
"type": "string"
}
},
{
"name": "firstNames",
"in": "query",
"description": "Search for Applicants by first name",
"schema": {
"title": "String",
"type": "string"
}
},
{
"name": "sex",
"in": "query",
"description": "Search for Applicants by sex",
"schema": {
"title": "String",
"type": "string"
}
},
{
"name": "status",
"in": "query",
"description": "Search for Applicants by Status",
"schema": {
"title": "String",
"type": "string"
}
},
{
"name": "workflowCode",
"in": "query",
"description": "Search for Applicants by Workflow Code",
"schema": {
"title": "String",
"type": "string"
}
},
{
"name": "workflowStatus",
"in": "query",
"description": "Search for Applicants by Workflow Status",
"schema": {
"title": "String",
"type": "string"
}
},
{
"name": "workflowSubStatus",
"in": "query",
"description": "Search for Applicants by Workflow Sub Status",
"schema": {
"title": "String",
"type": "string"
}
},
{
"name": "qualificationPlan",
"in": "query",
"description": "Search for Applicants by Qualification Plan",
"schema": {
"title": "String",
"type": "string"
}
},
{
"name": "site",
"in": "query",
"description": "Search for Applicants by Site",
"schema": {
"title": "String",
"type": "string"
}
},
{
"name": "nINumber",
"in": "query",
"description": "Search for Applicants by NI Number",
"schema": {
"title": "String",
"type": "string"
}
},
{
"name": "learnerReferenceNumber",
"in": "query",
"description": "Search for Applicants by Learner Reference Number",
"schema": {
"title": "String",
"type": "string"
}
},
{
"name": "postcode",
"in": "query",
"description": "Search for Applicants by Postcode",
"schema": {
"title": "String",
"type": "string"
}
},
{
"name": "uLN",
"in": "query",
"description": "Search for Applicants by ULN",
"schema": {
"title": "String",
"type": "string"
}
},
{
"name": "mainOfficer",
"in": "query",
"description": "Search for Applicants by Main Officer Code",
"schema": {
"title": "String",
"type": "string"
}
},
{
"name": "recruitmentOfficer",
"in": "query",
"description": "Search for Applicants by Recruitment Officer Code",
"schema": {
"title": "String",
"type": "string"
}
},
{
"name": "dateOfBirth",
"in": "query",
"description": "Search for Applicants by Date Of Birth",
"schema": {
"title": "Nullable`1",
"type": "string",
"format": "date-time"
}
},
{
"name": "employerCode",
"in": "query",
"description": "Search for Applicants by Employer Code",
"schema": {
"title": "String",
"type": "string"
}
},
{
"name": "modifiedSince",
"in": "query",
"description": "Search for Applicants by Modified Since",
"schema": {
"title": "Nullable`1",
"type": "string",
"format": "date-time"
}
},
{
"name": "createdSince",
"in": "query",
"description": "Search for Applicants by Created Since",
"schema": {
"title": "Nullable`1",
"type": "string",
"format": "date-time"
}
},
{
"name": "plannedStartAfter",
"in": "query",
"description": "Search for Applicants by Planned Start After",
"schema": {
"title": "Nullable`1",
"type": "string",
"format": "date-time"
}
},
{
"name": "plannedStartBefore",
"in": "query",
"description": "Search for Applicants by Planned Start Before",
"schema": {
"title": "Nullable`1",
"type": "string",
"format": "date-time"
}
},
{
"name": "expectedEndAfter",
"in": "query",
"description": "Search for Applicants by Expected End After",
"schema": {
"title": "Nullable`1",
"type": "string",
"format": "date-time"
}
},
{
"name": "expectedEndBefore",
"in": "query",
"description": "Search for Applicants by Expected End Before",
"schema": {
"title": "Nullable`1",
"type": "string",
"format": "date-time"
}
},
{
"name": "sortBy",
"in": "query",
"description": "Select how the results should be sorted",
"schema": {
"title": "SortBy",
"enum": [
"Surname",
"FirstNames",
"Created",
"StatusChange",
"InternalIdentifier"
],
"type": "string",
"default": "Surname"
}
},
{
"name": "sortDirection",
"in": "query",
"description": "Sort Direction",
"schema": {
"title": "SortDirection",
"enum": [
"Assending",
"Descending"
],
"type": "string",
"default": "Descending"
}
},
{
"name": "pageNumber",
"in": "query",
"description": "Page Number",
"schema": {
"title": "Nullable`1",
"type": "integer",
"format": "int32"
}
},
{
"name": "pageSize",
"in": "query",
"description": "Page Size",
"schema": {
"title": "Int32",
"maximum": 1000,
"minimum": 5,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.SearchResultsViewModel`1[[Business.Core.Api.ViewModels.Applicants.SearchResultItemViewModel, Business, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.SearchResultsViewModel`1[[Business.Core.Api.ViewModels.Applicants.SearchResultItemViewModel, Business, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Applicants"
],
"summary": "Insert Applicant",
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Applicants.CreateViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Applicants.CreateViewModel"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"title": "String",
"type": "string"
}
},
"application/xml": {
"schema": {
"title": "String",
"type": "string"
}
}
}
}
}
}
},
"/api/v1/applicants/{id}": {
"get": {
"tags": [
"Applicants"
],
"summary": "Get an Applicant by ID",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Applicant's ID",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "OABC1"
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Applicants.DetailsViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Applicants.DetailsViewModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
},
"put": {
"tags": [
"Applicants"
],
"summary": "Edit Applicant",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Applicant's ID",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "OABC1"
}
],
"requestBody": {
"description": "Fields to be edited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Applicants.EditViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Applicants.EditViewModel"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/applicants/{id}/udfanswers": {
"get": {
"tags": [
"Applicants"
],
"summary": "Get Applicant User Defined Form answers",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Applicant's ID",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "OABC1"
},
{
"name": "udfApiCodes",
"in": "query",
"description": "The unique codes for the User Defined questions",
"schema": {
"title": "List`1",
"type": "array",
"items": {
"title": "String",
"type": "string"
}
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.UdfAnswersViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.UdfAnswersViewModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
},
"post": {
"tags": [
"Applicants"
],
"summary": "Insert Applicant User Defined Form answers",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Applicant's ID",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "OABC1"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.UdfAnswersViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.UdfAnswersViewModel"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/applicants/udfs": {
"get": {
"tags": [
"Applicants"
],
"summary": "Get a list of all Applicant User Defined Questions",
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.UdfQuestionsViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.UdfQuestionsViewModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/applicants/tags": {
"get": {
"tags": [
"Applicants"
],
"summary": "Get list of all applicant tags",
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.TagsViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.TagsViewModel"
}
}
}
}
}
}
},
"/api/v1/applicants/{id}/tags": {
"get": {
"tags": [
"Applicants"
],
"summary": "Get Applicant Tags",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Applicant's ID",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "OABC1"
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.TagsViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.TagsViewModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
},
"post": {
"tags": [
"Applicants"
],
"summary": "Insert Applicant Tags",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Applicant's ID",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "OABC1"
}
],
"requestBody": {
"description": "The tags to be inserted into the applicant's record",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.TagsViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.TagsViewModel"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
},
"delete": {
"tags": [
"Applicants"
],
"summary": "Delete Applicant Tags",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Id of the Applicant to delete Tags from",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "OABC1"
}
],
"requestBody": {
"description": "Tags to be deleted from Applicant",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.TagsViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.TagsViewModel"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/applicants/{id}/functionalskills": {
"get": {
"tags": [
"Applicants"
],
"summary": "Get Applicant Functional Skills Assessments",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Applicant's ID",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "OABC1"
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.FunctionalSkillsViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.FunctionalSkillsViewModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
},
"post": {
"tags": [
"Applicants"
],
"summary": "Insert an Applicant Functional Skills Assessment",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Applicant's ID",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "OABC1"
}
],
"requestBody": {
"description": "The functional skills assessment to be added to the Applicant's record",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.AddFunctionalSkillAssessmentViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.AddFunctionalSkillAssessmentViewModel"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"title": "String",
"type": "string"
}
},
"application/xml": {
"schema": {
"title": "String",
"type": "string"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/applicants/{id}/functionalskills/{assessmentid}": {
"put": {
"tags": [
"Applicants"
],
"summary": "Edit an Applicant Functional Skills Assessment",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Applicant's ID",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "OABC1"
},
{
"name": "assessmentId",
"in": "path",
"description": "The ID of the assessment to be edited",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "1234567890abcdef1234567890abcdef"
}
],
"requestBody": {
"description": "The functional skills assessment to be edited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.EditFunctionalSkillAssessmentViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.EditFunctionalSkillAssessmentViewModel"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
},
"delete": {
"tags": [
"Applicants"
],
"summary": "Delete an Applicant Functional Skills Assessment",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Applicant's ID",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "OABC1"
},
{
"name": "assessmentId",
"in": "path",
"description": "The ID of the assessment to be deleted",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "1234567890abcdef1234567890abcdef"
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/applicants/officers": {
"get": {
"tags": [
"Applicants"
],
"summary": "Get a list of Officer relationship types for Applicants",
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
},
"application/xml": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
}
}
}
}
}
},
"/api/v1/applicants/{id}/officers": {
"get": {
"tags": [
"Applicants"
],
"summary": "Get Applicant Officers",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Applicant's ID",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "OABC1"
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.OfficersViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.OfficersViewModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
},
"post": {
"tags": [
"Applicants"
],
"summary": "Insert Applicant Officers",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Applicant's ID",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "OABC1"
}
],
"requestBody": {
"description": "The Officers to be linked to the applicant's record",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.OfficersViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.OfficersViewModel"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
},
"delete": {
"tags": [
"Applicants"
],
"summary": "Delete Applicant Officers",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Applicant's ID",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "OABC1"
}
],
"requestBody": {
"description": "The Officers to be removed to the applicant's record",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.OfficersViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.OfficersViewModel"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/applicants/{id}/photo": {
"get": {
"tags": [
"Applicants"
],
"summary": "Get an Applicant's Photo",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Applicant's ID",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "OABC1"
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.PhotoViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.PhotoViewModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/appointments": {
"get": {
"tags": [
"Appointments"
],
"summary": "Search Appointments",
"description": "Sample request:\r\n\r\n GET /Appointments?ModifiedSince=2023-10-05T00:00:00Z",
"parameters": [
{
"name": "text",
"in": "query",
"description": "Search by Title",
"schema": {
"title": "String",
"type": "string"
}
},
{
"name": "type",
"in": "query",
"description": "Search by Appointment Type",
"schema": {
"title": "String",
"type": "string"
}
},
{
"name": "class",
"in": "query",
"description": "Search by Appointment Class",
"schema": {
"title": "String",
"type": "string"
}
},
{
"name": "status",
"in": "query",
"description": "Search by Appointment Status",
"schema": {
"title": "String",
"type": "string"
}
},
{
"name": "subStatus",
"in": "query",
"description": "Search by Appointment SubStatus",
"schema": {
"title": "String",
"type": "string"
}
},
{
"name": "workflow",
"in": "query",
"description": "Search by Appointment Workflow",
"schema": {
"title": "String",
"type": "string"
}
},
{
"name": "modifiedSince",
"in": "query",
"description": "Search for Appointments Modified Since",
"schema": {
"title": "Nullable`1",
"type": "string",
"format": "date-time"
}
},
{
"name": "createdSince",
"in": "query",
"description": "Search for Appointments Created Since",
"schema": {
"title": "Nullable`1",
"type": "string",
"format": "date-time"
}
},
{
"name": "sortDirection",
"in": "query",
"description": "Sort Direction",
"schema": {
"title": "SortDirection",
"enum": [
"Assending",
"Descending"
],
"type": "string",
"default": "Descending"
}
},
{
"name": "pageNumber",
"in": "query",
"description": "Page Number",
"schema": {
"title": "Nullable`1",
"type": "integer",
"format": "int32"
}
},
{
"name": "pageSize",
"in": "query",
"description": "Page Size",
"schema": {
"title": "Int32",
"maximum": 1000,
"minimum": 5,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.SearchResultsViewModel`1[[Business.Core.Api.ViewModels.Appointments.SearchResultItemViewModel, Business, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.SearchResultsViewModel`1[[Business.Core.Api.ViewModels.Appointments.SearchResultItemViewModel, Business, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Appointments"
],
"summary": "Insert Appointment",
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Appointments.CreateViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Appointments.CreateViewModel"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"title": "String",
"type": "string"
}
},
"application/xml": {
"schema": {
"title": "String",
"type": "string"
}
}
}
}
}
}
},
"/api/v1/appointments/{id}": {
"get": {
"tags": [
"Appointments"
],
"summary": "Get an Appointment by ID",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Appointment's ID",
"required": true,
"schema": {
"title": "Int32",
"type": "integer",
"format": "int32"
},
"example": 1
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Appointments.DetailsViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Appointments.DetailsViewModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
},
"put": {
"tags": [
"Appointments"
],
"summary": "Edit Appointment",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Appointment's ID",
"required": true,
"schema": {
"title": "Int32",
"type": "integer",
"format": "int32"
},
"example": 1
}
],
"requestBody": {
"description": "Fields to be edited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Appointments.EditViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Appointments.EditViewModel"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/appointments/template/{templateid}/for/{forid}": {
"get": {
"tags": [
"Appointments"
],
"summary": "Get a create appointment object for a given template and entity",
"parameters": [
{
"name": "templateID",
"in": "path",
"description": "The ID of the template to be used",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "MYTEMPLATE"
},
{
"name": "forID",
"in": "path",
"description": "The ID of the entity the appointment is being create for",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "OABC1"
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Appointments.CreateViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Appointments.CreateViewModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/appointments/{id}/udfanswers": {
"get": {
"tags": [
"Appointments"
],
"summary": "Get Appointment User Defined Form answers",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Appointment's ID",
"required": true,
"schema": {
"title": "Int32",
"type": "integer",
"format": "int32"
},
"example": 1
},
{
"name": "udfApiCodes",
"in": "query",
"description": "The unique codes for the User Defined questions",
"schema": {
"title": "List`1",
"type": "array",
"items": {
"title": "String",
"type": "string"
}
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.UdfAnswersViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.UdfAnswersViewModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
},
"post": {
"tags": [
"Appointments"
],
"summary": "Insert Appointment User Defined Form answers",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Appointment's ID",
"required": true,
"schema": {
"title": "Int32",
"type": "integer",
"format": "int32"
},
"example": 1
}
],
"requestBody": {
"description": "The UDF answers to be inserted into the Appointment's record",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.UdfAnswersViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.UdfAnswersViewModel"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/appointments/udfs": {
"get": {
"tags": [
"Appointments"
],
"summary": "Get a list of all Appointment User Defined Questions",
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.UdfQuestionsViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.UdfQuestionsViewModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/appointments/tags": {
"get": {
"tags": [
"Appointments"
],
"summary": "Get list of all Appointment tags",
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.TagsViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.TagsViewModel"
}
}
}
}
}
}
},
"/api/v1/appointments/{id}/tags": {
"get": {
"tags": [
"Appointments"
],
"summary": "Get Appointment Tags",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Appointment's id",
"required": true,
"schema": {
"title": "Int32",
"type": "integer",
"format": "int32"
},
"example": 1
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.TagsViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.TagsViewModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
},
"post": {
"tags": [
"Appointments"
],
"summary": "Insert Appointment Tags",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Appointment's ID",
"required": true,
"schema": {
"title": "Int32",
"type": "integer",
"format": "int32"
},
"example": 1
}
],
"requestBody": {
"description": "The tags to be inserted into the Appointment's record",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.TagsViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.TagsViewModel"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
},
"delete": {
"tags": [
"Appointments"
],
"summary": "Delete Appointment Tags",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Id of the Appointment to delete Tags from",
"required": true,
"schema": {
"title": "Int32",
"type": "integer",
"format": "int32"
},
"example": 1
}
],
"requestBody": {
"description": "Tags to be deleted from Appointment",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.TagsViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.TagsViewModel"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/appointments/{id}/attachments": {
"get": {
"tags": [
"Appointments"
],
"summary": "Get a list of all Appointment attachments",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Appointment's ID",
"required": true,
"schema": {
"title": "Int32",
"type": "integer",
"format": "int32"
},
"example": 1
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Appointments.AttachmentsViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Appointments.AttachmentsViewModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
},
"post": {
"tags": [
"Appointments"
],
"summary": "Add an Attachment to an Appointment",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Id of the Appointment to attach a file to",
"required": true,
"schema": {
"title": "Int32",
"type": "integer",
"format": "int32"
},
"example": 1
}
],
"requestBody": {
"description": "Appointment ID",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"description",
"file",
"iD"
],
"type": "object",
"properties": {
"iD": {
"title": "Int32",
"type": "integer",
"description": "Appointment ID",
"format": "int32"
},
"description": {
"title": "String",
"type": "string",
"description": "Description of the attachment"
},
"fileType": {
"title": "String",
"type": "string",
"description": "File type of the attachment"
},
"expires": {
"title": "Nullable`1",
"type": "string",
"description": "Expiry date of the attachment",
"format": "date-time"
},
"file": {
"title": "IFormFile",
"type": "string",
"description": "Required. The file to be attached",
"format": "binary"
}
}
},
"encoding": {
"iD": {
"style": "form"
},
"description": {
"style": "form"
},
"fileType": {
"style": "form"
},
"expires": {
"style": "form"
},
"file": {
"style": "form"
}
}
},
"application/json": {
"schema": {
"required": [
"description",
"file",
"iD"
],
"type": "object",
"properties": {
"iD": {
"title": "Int32",
"type": "integer",
"description": "Appointment ID",
"format": "int32"
},
"description": {
"title": "String",
"type": "string",
"description": "Description of the attachment"
},
"fileType": {
"title": "String",
"type": "string",
"description": "File type of the attachment"
},
"expires": {
"title": "Nullable`1",
"type": "string",
"description": "Expiry date of the attachment",
"format": "date-time"
},
"file": {
"title": "IFormFile",
"type": "string",
"description": "Required. The file to be attached",
"format": "binary"
}
}
},
"encoding": {
"iD": {
"style": "form"
},
"description": {
"style": "form"
},
"fileType": {
"style": "form"
},
"expires": {
"style": "form"
},
"file": {
"style": "form"
}
}
},
"application/xml": {
"schema": {
"required": [
"description",
"file",
"iD"
],
"type": "object",
"properties": {
"iD": {
"title": "Int32",
"type": "integer",
"description": "Appointment ID",
"format": "int32"
},
"description": {
"title": "String",
"type": "string",
"description": "Description of the attachment"
},
"fileType": {
"title": "String",
"type": "string",
"description": "File type of the attachment"
},
"expires": {
"title": "Nullable`1",
"type": "string",
"description": "Expiry date of the attachment",
"format": "date-time"
},
"file": {
"title": "IFormFile",
"type": "string",
"description": "Required. The file to be attached",
"format": "binary"
}
}
},
"encoding": {
"iD": {
"style": "form"
},
"description": {
"style": "form"
},
"fileType": {
"style": "form"
},
"expires": {
"style": "form"
},
"file": {
"style": "form"
}
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"title": "String",
"type": "string"
}
},
"application/xml": {
"schema": {
"title": "String",
"type": "string"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/appointments/{id}/attachments/{attachmentid}/download": {
"get": {
"tags": [
"Appointments"
],
"summary": "Download an appointment file attachment",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Appointment's ID",
"required": true,
"schema": {
"title": "Int32",
"type": "integer",
"format": "int32"
},
"example": 1
},
{
"name": "attachmentId",
"in": "path",
"description": "The appointment attachment's 32-character ID",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "123456789012345678901234567890ab"
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/appointments/templates": {
"get": {
"tags": [
"Appointments"
],
"summary": "Get a list of all Appointment Templates",
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
},
"application/xml": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/appointments/workflows": {
"get": {
"tags": [
"Appointments"
],
"summary": "Get a list of all Appointment Workflows",
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
},
"application/xml": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/appointments/participantroles": {
"get": {
"tags": [
"Appointments"
],
"summary": "Get a list of all Appointment participant Roles",
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
},
"application/xml": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/appointments/participanttypes": {
"get": {
"tags": [
"Appointments"
],
"summary": "Get a list of all Appointment participant Types",
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
},
"application/xml": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/appointments/statuses": {
"get": {
"tags": [
"Appointments"
],
"summary": "Get a list of all Appointment Statuses",
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.StatusesViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.StatusesViewModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/authentication": {
"post": {
"tags": [
"Authentication"
],
"summary": "Authenticate to get a bearer token",
"requestBody": {
"description": "Username and password",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Authentication.AuthenticationViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Authentication.AuthenticationViewModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"title": "String",
"type": "string"
}
},
"application/json": {
"schema": {
"title": "String",
"type": "string"
}
},
"text/json": {
"schema": {
"title": "String",
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/imports": {
"post": {
"tags": [
"Imports"
],
"summary": "Add Import Data",
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Imports.AddImportViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Imports.AddImportViewModel"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"title": "String",
"type": "string"
}
},
"application/xml": {
"schema": {
"title": "String",
"type": "string"
}
}
}
}
}
}
},
"/api/v1/learners": {
"get": {
"tags": [
"Learners"
],
"summary": "Search Learners",
"description": "Sample request:\r\n\r\n GET /Learners?Surname=Wilson",
"parameters": [
{
"name": "surname",
"in": "query",
"description": "Search for Learners by surname",
"schema": {
"title": "String",
"type": "string"
}
},
{
"name": "firstNames",
"in": "query",
"description": "Search for Learners by first names",
"schema": {
"title": "String",
"type": "string"
}
},
{
"name": "sex",
"in": "query",
"description": "Search for Learners by sex",
"schema": {
"title": "String",
"type": "string"
}
},
{
"name": "learningStatus",
"in": "query",
"description": "Search for Learners by learning status",
"schema": {
"title": "LearningStatus",
"enum": [
"All",
"InLearningToday",
"InLearningAndLastYearLeavers",
"InLearningAndRecentLeavers",
"InLearningAndYetToStart",
"YetToStart",
"RecentLeavers",
"RecentAdded",
"AllLeavers",
"PastExpectedEnd"
],
"type": "string"
}
},
{
"name": "status",
"in": "query",
"description": "Search for Learners by status",
"schema": {
"title": "String",
"type": "string"
}
},
{
"name": "workflow",
"in": "query",
"description": "Search for Learners by workflow",
"schema": {
"title": "String",
"type": "string"
}
},
{
"name": "workflowStatus",
"in": "query",
"description": "Search for Learners by workflow status",
"schema": {
"title": "String",
"type": "string"
}
},
{
"name": "workflowSubStatus",
"in": "query",
"description": "Search for Learners by workflow sub status",
"schema": {
"title": "String",
"type": "string"
}
},
{
"name": "qualificationPlan",
"in": "query",
"description": "Search for Learners by qualification plan",
"schema": {
"title": "String",
"type": "string"
}
},
{
"name": "site",
"in": "query",
"description": "Search for Learners by site",
"schema": {
"title": "String",
"type": "string"
}
},
{
"name": "subcontractorCode",
"in": "query",
"description": "Search for Learners by subcontractor code",
"schema": {
"title": "String",
"type": "string"
}
},
{
"name": "nINumber",
"in": "query",
"description": "Search for Learners by national insurance number",
"schema": {
"title": "String",
"type": "string"
}
},
{
"name": "postcode",
"in": "query",
"description": "Search for Learners by postcode",
"schema": {
"title": "String",
"type": "string"
}
},
{
"name": "uLN",
"in": "query",
"description": "Search for Learners by ULN",
"schema": {
"title": "String",
"type": "string"
}
},
{
"name": "mainOfficer",
"in": "query",
"description": "Search for Learners by main officer",
"schema": {
"title": "String",
"type": "string"
}
},
{
"name": "dateOfBirth",
"in": "query",
"description": "Search for Learners by date of birth",
"schema": {
"title": "Nullable`1",
"type": "string",
"format": "date-time"
}
},
{
"name": "employer",
"in": "query",
"description": "Search for Learners by Employer",
"schema": {
"title": "String",
"type": "string"
}
},
{
"name": "pONumber",
"in": "query",
"description": "Search for Learners by PO number",
"schema": {
"title": "String",
"type": "string"
}
},
{
"name": "providerIdent",
"in": "query",
"description": "Search for Learners by their Provider Assigned ID",
"schema": {
"title": "String",
"type": "string"
}
},
{
"name": "learnerReferenceNumber",
"in": "query",
"description": "Search for Learners by their LRN (Learner Reference Number)",
"schema": {
"title": "String",
"type": "string"
}
},
{
"name": "createdSince",
"in": "query",
"description": "Search for Learners created since a given date",
"schema": {
"title": "Nullable`1",
"type": "string",
"format": "date-time"
}
},
{
"name": "modifiedSince",
"in": "query",
"description": "Search for Learners modified by another system since a given date",
"schema": {
"title": "Nullable`1",
"type": "string",
"format": "date-time"
}
},
{
"name": "plannedStartAfter",
"in": "query",
"description": "Search for Learners in learning on or before a given date",
"schema": {
"title": "Nullable`1",
"type": "string",
"format": "date-time"
}
},
{
"name": "plannedStartBefore",
"in": "query",
"description": "Search for Learners starting on or after a given date",
"schema": {
"title": "Nullable`1",
"type": "string",
"format": "date-time"
}
},
{
"name": "expectedEndAfter",
"in": "query",
"description": "Search for Learners expected to be ending on or after a given date",
"schema": {
"title": "Nullable`1",
"type": "string",
"format": "date-time"
}
},
{
"name": "expectedEndBefore",
"in": "query",
"description": "Search for Learners expected to be ending on or before a given date",
"schema": {
"title": "Nullable`1",
"type": "string",
"format": "date-time"
}
},
{
"name": "sortBy",
"in": "query",
"description": "Sort results by",
"schema": {
"title": "SortBy",
"enum": [
"Surname",
"FirstNames",
"StartDate",
"ExpectedEnd",
"ActualEnd",
"Created",
"InternalID"
],
"type": "string"
}
},
{
"name": "sortDirection",
"in": "query",
"description": "Sort Direction",
"schema": {
"title": "SortDirection",
"enum": [
"Assending",
"Descending"
],
"type": "string",
"default": "Descending"
}
},
{
"name": "pageNumber",
"in": "query",
"description": "Page Number",
"schema": {
"title": "Nullable`1",
"type": "integer",
"format": "int32"
}
},
{
"name": "pageSize",
"in": "query",
"description": "Page Size",
"schema": {
"title": "Int32",
"maximum": 1000,
"minimum": 5,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.SearchResultsViewModel`1[[Business.Core.Api.ViewModels.Learners.SearchResultsItemViewModel, Business, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.SearchResultsViewModel`1[[Business.Core.Api.ViewModels.Learners.SearchResultsItemViewModel, Business, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/api/v1/learners/{id}": {
"get": {
"tags": [
"Learners"
],
"summary": "Get an Learner by ID",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Learner's ID",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "OABC1"
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Learners.DetailsViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Learners.DetailsViewModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
},
"put": {
"tags": [
"Learners"
],
"summary": "Edit Learner",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Learners ident",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "OABC1"
}
],
"requestBody": {
"description": "Fields to be edited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Learners.EditViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Learners.EditViewModel"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/learners/{id}/udfanswers": {
"get": {
"tags": [
"Learners"
],
"summary": "Get Learner User Defined Form answers",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Learner's ID",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "OABC1"
},
{
"name": "udfApiCodes",
"in": "query",
"description": "The unique codes for the User Defined questions",
"schema": {
"title": "List`1",
"type": "array",
"items": {
"title": "String",
"type": "string"
}
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.UdfAnswersViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.UdfAnswersViewModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
},
"post": {
"tags": [
"Learners"
],
"summary": "Insert Learner User Defined Form answers",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Learner's ID",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "OABC1"
}
],
"requestBody": {
"description": "The udf answers to be inserted into the Learner's record",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.UdfAnswersViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.UdfAnswersViewModel"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/learners/udfs": {
"get": {
"tags": [
"Learners"
],
"summary": "Get a list of all Learner User Defined Questions",
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.UdfQuestionsViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.UdfQuestionsViewModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/learners/tags": {
"get": {
"tags": [
"Learners"
],
"summary": "Get list of all Learner tags",
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.TagsViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.TagsViewModel"
}
}
}
}
}
}
},
"/api/v1/learners/{id}/tags": {
"get": {
"tags": [
"Learners"
],
"summary": "Get Learner Tags",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Learner's ID",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "OABC1"
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.TagsViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.TagsViewModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
},
"post": {
"tags": [
"Learners"
],
"summary": "Insert Learner Tags",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Learner's ID",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "OABC1"
}
],
"requestBody": {
"description": "The tags to be inserted into the Learner's record",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.TagsViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.TagsViewModel"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
},
"delete": {
"tags": [
"Learners"
],
"summary": "Delete Learner Tags",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Id of the Learner to delete Tags from",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "OABC1"
}
],
"requestBody": {
"description": "Tags to be deleted from Learner",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.TagsViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.TagsViewModel"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/learners/{id}/functionalskills": {
"get": {
"tags": [
"Learners"
],
"summary": "Get Functional Skills",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Learner's ID",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "OABC1"
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.FunctionalSkillsViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.FunctionalSkillsViewModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
},
"post": {
"tags": [
"Learners"
],
"summary": "Insert a Learner Functional Skills Assessment",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Learner's ID",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "OABC1"
}
],
"requestBody": {
"description": "The functional skills assessment to be added to the Learner's record",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.AddFunctionalSkillAssessmentViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.AddFunctionalSkillAssessmentViewModel"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"title": "String",
"type": "string"
}
},
"application/xml": {
"schema": {
"title": "String",
"type": "string"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/learners/{id}/functionalskills/{assessmentid}": {
"put": {
"tags": [
"Learners"
],
"summary": "Edit an Learner Functional Skills Assessment",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Learner's ID",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "OABC1"
},
{
"name": "assessmentId",
"in": "path",
"description": "The ID of the assessment to be edited",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "1234567890abcdef1234567890abcdef"
}
],
"requestBody": {
"description": "The functional skills assessment to be edited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.EditFunctionalSkillAssessmentViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.EditFunctionalSkillAssessmentViewModel"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
},
"delete": {
"tags": [
"Learners"
],
"summary": "Delete an Learner Functional Skills Assessment",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Learner's ID",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "OABC1"
},
{
"name": "assessmentId",
"in": "path",
"description": "The ID of the assessment to be deleted",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "1234567890abcdef1234567890abcdef"
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/learners/officers": {
"get": {
"tags": [
"Learners"
],
"summary": "Get a list of Officer relationship types for Learners",
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
},
"application/xml": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
}
}
}
}
}
},
"/api/v1/learners/{id}/officers": {
"get": {
"tags": [
"Learners"
],
"summary": "Get Learner Officers",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Learner's id",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "OABC1"
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.OfficersViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.OfficersViewModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
},
"post": {
"tags": [
"Learners"
],
"summary": "Insert Learner Officers",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Learner's ID",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "OABC1"
}
],
"requestBody": {
"description": "The Officers to be linked to the Learner's record",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.OfficersViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.OfficersViewModel"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
},
"delete": {
"tags": [
"Learners"
],
"summary": "Delete Learner Officers",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Learner's ID",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "OABC1"
}
],
"requestBody": {
"description": "The Officers to be removed from the Learner's record",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.OfficersViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.OfficersViewModel"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/learners/{id}/qualifications": {
"get": {
"tags": [
"Learners"
],
"summary": "Get Learner Qualifications",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Learner's id",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "OABC1"
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Learners.QualificationsViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Learners.QualificationsViewModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/learners/{id}/qualifications/{aimreference}": {
"get": {
"tags": [
"Learners"
],
"summary": "Get a single Learner Qualification by Aim Reference",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Learner's id",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "OABC1"
},
{
"name": "aimReference",
"in": "path",
"description": "The Qualification's Aim Reference",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "aimRef1"
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Learners.QualificationsViewModelItem"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Learners.QualificationsViewModelItem"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/learners/{id}/photo": {
"get": {
"tags": [
"Learners"
],
"summary": "Get a Learner's Photo",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Learner's ID",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "OABC1"
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.PhotoViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.PhotoViewModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/learners/{id}/components": {
"get": {
"tags": [
"Learners"
],
"summary": "Get a Learner's components",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Learner's ID",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "OABC1"
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Learners.ComponentsViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Learners.ComponentsViewModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
},
"post": {
"tags": [
"Learners"
],
"summary": "Add a component to a Learner",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Learner's ID",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "OABC1"
}
],
"requestBody": {
"description": "The component to be added to the learner",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Learners.AddComponentViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Learners.AddComponentViewModel"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"title": "String",
"type": "string"
}
},
"application/xml": {
"schema": {
"title": "String",
"type": "string"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/learners/{id}/components/{componentid}": {
"put": {
"tags": [
"Learners"
],
"summary": "Edit a Learner Component",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Learner's ID",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "OABC1"
},
{
"name": "componentId",
"in": "path",
"description": "The learner component ID to be edited",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "1234567890abcdef1234567890abcdef"
}
],
"requestBody": {
"description": "The learner component to be edited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Learners.EditComponentViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Learners.EditComponentViewModel"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
},
"delete": {
"tags": [
"Learners"
],
"summary": "Remove a non mandatory component from a Learner",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Learner's ID",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "OABC1"
},
{
"name": "componentId",
"in": "path",
"description": "The ID of the component to be removed from the Learner",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "d4616617fa78413392d8490cb987c26f"
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/learners/{id}/availablecomponents": {
"get": {
"tags": [
"Learners"
],
"summary": "Get a list of components available to the Learner",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Learner's ID",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "OABC1"
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Learners.AvailableComponentsViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Learners.AvailableComponentsViewModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/learners/{id}/contactandlearninghours": {
"get": {
"tags": [
"Learners"
],
"summary": "Get a Learner's contact and learning hours",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Learner's ID",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "OABC1"
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Learners.ContactAndLearningHoursViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Learners.ContactAndLearningHoursViewModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/learners/{id}/contactandlearninghourtotals": {
"get": {
"tags": [
"Learners"
],
"summary": "Get a Learner's contact and learning hour totals",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Learner's ID",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "OABC1"
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Learners.ContactAndLearningHourTotalsViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Learners.ContactAndLearningHourTotalsViewModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/learners/{id}/placements": {
"get": {
"tags": [
"Learners"
],
"summary": "Get Learner Placements",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Learner's ID",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "OABC1"
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Learners.PlacementsViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Learners.PlacementsViewModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/listsandtypes/actstatus": {
"get": {
"tags": [
"Lists and Types"
],
"summary": "Get list of ACT Status codes and descriptions",
"description": "Sample request:\r\n\r\n GET /ListsAndTypes/ACTStatus",
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
},
"application/xml": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
}
}
}
}
}
},
"/api/v1/listsandtypes/asstatus": {
"get": {
"tags": [
"Lists and Types"
],
"summary": "Get list of Apprenticeships.Service Status codes and descriptions",
"description": "Sample request:\r\n\r\n GET /ListsAndTypes/ASStatus",
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
},
"application/xml": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
}
}
}
}
}
},
"/api/v1/listsandtypes/functionalskillsliteracyassessmentlevel": {
"get": {
"tags": [
"Lists and Types"
],
"summary": "Get list of Functional Skills Literacy assessment level codes and descriptions",
"description": "Sample request:\r\n\r\n GET /ListsAndTypes/FunctionalSkillsLiteracyAssessmentLevel",
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
},
"application/xml": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
}
}
}
}
}
},
"/api/v1/listsandtypes/functionalskillsnumeracyassessmentlevel": {
"get": {
"tags": [
"Lists and Types"
],
"summary": "Get list of Functional Skills Numeracy assessment level codes and descriptions",
"description": "Sample request:\r\n\r\n GET /ListsAndTypes/FunctionalSkillsNumeracyAssessmentLevel",
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
},
"application/xml": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
}
}
}
}
}
},
"/api/v1/listsandtypes/functionalskillsassessmenttype": {
"get": {
"tags": [
"Lists and Types"
],
"summary": "Get list of Functional Skills Assessment type codes and descriptions",
"description": "Sample request:\r\n\r\n GET /ListsAndTypes/FunctionalSkillsAssessmentType",
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
},
"application/xml": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
}
}
}
}
}
},
"/api/v1/listsandtypes/functionalskillsassessmentsubject": {
"get": {
"tags": [
"Lists and Types"
],
"summary": "Get list of Functional Skills Assessment subject codes and descriptions",
"description": "Sample request:\r\n\r\n GET /ListsAndTypes/FunctionalSkillsAssessmentSubject",
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
},
"application/xml": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
}
}
}
}
}
},
"/api/v1/listsandtypes/countryofdomicile": {
"get": {
"tags": [
"Lists and Types"
],
"summary": "Get list of Country Of Domicile codes and descriptions",
"description": "Sample request:\r\n\r\n GET /ListsAndTypes/CountryOfDomicile",
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
},
"application/xml": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
}
}
}
}
}
},
"/api/v1/listsandtypes/customprovisions": {
"get": {
"tags": [
"Lists and Types"
],
"summary": "Get list of Custom Provisions codes and descriptions",
"description": "Sample request:\r\n\r\n GET /ListsAndTypes/CustomProvisions",
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.ListsAndTypes.CustomProvisionsViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.ListsAndTypes.CustomProvisionsViewModel"
}
}
}
}
}
}
},
"/api/v1/listsandtypes/ilrdisability": {
"get": {
"tags": [
"Lists and Types"
],
"summary": "Get list of ILR Disability codes and descriptions",
"description": "Sample request:\r\n\r\n GET /ListsAndTypes/IlrDisability",
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
},
"application/xml": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
}
}
}
}
}
},
"/api/v1/listsandtypes/ethnicity": {
"get": {
"tags": [
"Lists and Types"
],
"summary": "Get list of Ethnicity codes and descriptions",
"description": "Sample request:\r\n\r\n GET /ListsAndTypes/Ethnicity",
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
},
"application/xml": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
}
}
}
}
}
},
"/api/v1/listsandtypes/lldd": {
"get": {
"tags": [
"Lists and Types"
],
"summary": "Get list of LLDD codes and descriptions",
"description": "Sample request:\r\n\r\n GET /ListsAndTypes/LLDD",
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
},
"application/xml": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
}
}
}
}
}
},
"/api/v1/listsandtypes/priorqualificationgrade": {
"get": {
"tags": [
"Lists and Types"
],
"summary": "Get list of Prior Qualification Grade codes and descriptions",
"description": "Sample request:\r\n\r\n GET /ListsAndTypes/PriorQualificationGrade",
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
},
"application/xml": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
}
}
}
}
}
},
"/api/v1/listsandtypes/priorqualificationlevel": {
"get": {
"tags": [
"Lists and Types"
],
"summary": "Get list of Prior Qualification Level codes and descriptions",
"description": "Sample request:\r\n\r\n GET /ListsAndTypes/PriorQualificationLevel",
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
},
"application/xml": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
}
}
}
}
}
},
"/api/v1/listsandtypes/getpriorqualificationtitle": {
"get": {
"tags": [
"Lists and Types"
],
"summary": "Get list of PriorQualification Title codes and descriptions",
"description": "Sample request:\r\n\r\n GET /ListsAndTypes/GetPriorQualificationTitle",
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
},
"application/xml": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
}
}
}
}
}
},
"/api/v1/listsandtypes/priorqualificationverified": {
"get": {
"tags": [
"Lists and Types"
],
"summary": "Get list of Prior Qualification Verified codes and descriptions",
"description": "Sample request:\r\n\r\n GET /ListsAndTypes/PriorQualificationVerified",
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
},
"application/xml": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
}
}
}
}
}
},
"/api/v1/listsandtypes/qualificationplans": {
"get": {
"tags": [
"Lists and Types"
],
"summary": "Get list of Qualification Plan codes and descriptions",
"description": "Sample request:\r\n\r\n GET /ListsAndTypes/QualificationPlans",
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
},
"application/xml": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
}
}
}
}
}
},
"/api/v1/listsandtypes/restricteduseindicator": {
"get": {
"tags": [
"Lists and Types"
],
"summary": "Get list of Restricted Use Indicator codes and descriptions",
"description": "Sample request:\r\n\r\n GET /ListsAndTypes/RestrictedUseIndicator",
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
},
"application/xml": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
}
}
}
}
}
},
"/api/v1/listsandtypes/sex": {
"get": {
"tags": [
"Lists and Types"
],
"summary": "Get list of Sex codes and descriptions",
"description": "Sample request:\r\n\r\n GET /ListsAndTypes/Sex",
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
},
"application/xml": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
}
}
}
}
}
},
"/api/v1/listsandtypes/title": {
"get": {
"tags": [
"Lists and Types"
],
"summary": "Get list of Title codes and descriptions",
"description": "Sample request:\r\n\r\n GET /ListsAndTypes/Title",
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
},
"application/xml": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
}
}
}
}
}
},
"/api/v1/listsandtypes/vatstatus": {
"get": {
"tags": [
"Lists and Types"
],
"summary": "Get list of VAT Status codes and descriptions",
"description": "Sample request:\r\n\r\n GET /ListsAndTypes/VatStatus",
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
},
"application/xml": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
}
}
}
}
}
},
"/api/v1/listsandtypes/filetype": {
"get": {
"tags": [
"Lists and Types"
],
"summary": "Get list of File Types",
"description": "Sample request:\r\n\r\n GET /ListsAndTypes/FileTypes",
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
},
"application/xml": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
}
}
}
}
}
},
"/api/v1/listsandtypes/sites": {
"get": {
"tags": [
"Lists and Types"
],
"summary": "Get list of Sites",
"description": "Sample request:\r\n\r\n GET /ListsAndTypes/Site",
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
},
"application/xml": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
}
}
}
}
}
},
"/api/v1/listsandtypes/componentpriorityflags": {
"get": {
"tags": [
"Lists and Types"
],
"summary": "Get list of Component Priority Flags",
"description": "Sample request:\r\n\r\n GET /ListsAndTypes/componentPriorityFlags",
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
},
"application/xml": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
}
}
}
}
}
},
"/api/v1/officers": {
"get": {
"tags": [
"Officers"
],
"summary": "Search Officers",
"description": "Sample request:\r\n\r\n GET /Officers?Surname=Wilson",
"parameters": [
{
"name": "firstNames",
"in": "query",
"description": "Search for Officer by forename",
"schema": {
"title": "String",
"type": "string"
}
},
{
"name": "surname",
"in": "query",
"description": "Search for Officer by surname",
"schema": {
"title": "String",
"type": "string"
}
},
{
"name": "sex",
"in": "query",
"description": "Search for Officer by sex",
"schema": {
"title": "String",
"type": "string"
}
},
{
"name": "postcode",
"in": "query",
"description": "Search for Officer by postcode",
"schema": {
"title": "String",
"type": "string"
}
},
{
"name": "email",
"in": "query",
"description": "Search for Officer by email",
"schema": {
"title": "String",
"type": "string"
}
},
{
"name": "role",
"in": "query",
"description": "Search for Officer by role",
"schema": {
"title": "List`1",
"type": "array",
"items": {
"title": "String",
"type": "string"
}
}
},
{
"name": "jobTitle",
"in": "query",
"description": "Search for Officer by job title",
"schema": {
"title": "List`1",
"type": "array",
"items": {
"title": "String",
"type": "string"
}
}
},
{
"name": "mainOrganisation",
"in": "query",
"description": "Search for Officer by main organisation",
"schema": {
"title": "String",
"type": "string"
}
},
{
"name": "superiorOfficer",
"in": "query",
"description": "Search for Officer by superior officer",
"schema": {
"title": "String",
"type": "string"
}
},
{
"name": "site",
"in": "query",
"description": "Search for Officers by site",
"schema": {
"title": "String",
"type": "string"
}
},
{
"name": "status",
"in": "query",
"description": "Search for Officers by system status",
"schema": {
"title": "List`1",
"type": "array",
"items": {
"title": "String",
"type": "string"
}
}
},
{
"name": "tag",
"in": "query",
"description": "Search for Officers by tag",
"schema": {
"title": "List`1",
"type": "array",
"items": {
"title": "String",
"type": "string"
}
}
},
{
"name": "createdSince",
"in": "query",
"description": "Search for Officers created since a given date",
"schema": {
"title": "Nullable`1",
"type": "string",
"format": "date-time"
}
},
{
"name": "modifiedSince",
"in": "query",
"description": "Search for Officers modified since a given date",
"schema": {
"title": "Nullable`1",
"type": "string",
"format": "date-time"
}
},
{
"name": "sortBy",
"in": "query",
"description": "Control the sorting of the results using one of the following: Title, Forename, Surname, Sex, Postcode, Email, Type, JobTitle, MainOrg",
"schema": {
"title": "SortBy",
"enum": [
0,
1,
2,
3,
4
],
"type": "integer",
"format": "int32"
}
},
{
"name": "sortDirection",
"in": "query",
"description": "Sort Direction",
"schema": {
"title": "SortDirection",
"enum": [
"Assending",
"Descending"
],
"type": "string",
"default": "Descending"
}
},
{
"name": "pageNumber",
"in": "query",
"description": "Page Number",
"schema": {
"title": "Nullable`1",
"type": "integer",
"format": "int32"
}
},
{
"name": "pageSize",
"in": "query",
"description": "Page Size",
"schema": {
"title": "Int32",
"maximum": 1000,
"minimum": 5,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.SearchResultsViewModel`1[[Business.Core.Api.ViewModels.Officers.SummaryViewModel, Business, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.SearchResultsViewModel`1[[Business.Core.Api.ViewModels.Officers.SummaryViewModel, Business, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Officers"
],
"summary": "Insert Officer",
"requestBody": {
"description": "Officer creation fields",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Officers.CreateViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Officers.CreateViewModel"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"title": "String",
"type": "string"
}
},
"application/xml": {
"schema": {
"title": "String",
"type": "string"
}
}
}
}
}
}
},
"/api/v1/officers/{id}": {
"get": {
"tags": [
"Officers"
],
"summary": "Get an Officer by ID",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Officer's ID",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "RAMAZANI"
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Officers.DetailsViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Officers.DetailsViewModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
},
"put": {
"tags": [
"Officers"
],
"summary": "Edit Officer",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Officer's ID",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "RAMAZANI"
}
],
"requestBody": {
"description": "Fields to be edited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Officers.EditViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Officers.EditViewModel"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/officers/{id}/tags": {
"get": {
"tags": [
"Officers"
],
"summary": "Get Officer Tags",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Officer's ID",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "RAMAZANI"
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.TagsViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.TagsViewModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
},
"post": {
"tags": [
"Officers"
],
"summary": "Insert Officer Tags",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Officer's ID",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "RAMAZANI"
}
],
"requestBody": {
"description": "The tags to be inserted into the Officer's record",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.TagsViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.TagsViewModel"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
},
"delete": {
"tags": [
"Officers"
],
"summary": "Delete Officer Tags",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Id of the Officer to delete Tags from",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "RAMAZANI"
}
],
"requestBody": {
"description": "Tags to be deleted from Officer",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.TagsViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.TagsViewModel"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/officers/tags": {
"get": {
"tags": [
"Officers"
],
"summary": "Get list of all Officer tags",
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.TagsViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.TagsViewModel"
}
}
}
}
}
}
},
"/api/v1/officers/{id}/appointments": {
"get": {
"tags": [
"Officers"
],
"summary": "Get Appointments for an Officer by Officer ID",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Officer's ID",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "RAMAZANI"
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.AppointmentViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.AppointmentViewModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/officers/{id}/photo": {
"get": {
"tags": [
"Officers"
],
"summary": "Get an Officer's Photo",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Officer's ID",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "RAMAZANI"
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.PhotoViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.PhotoViewModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/organisations": {
"get": {
"tags": [
"Organisations"
],
"summary": "Search Organisations",
"description": "Sample request:\r\n\r\n GET /Organisations?Name=Acme",
"parameters": [
{
"name": "additionalID",
"in": "query",
"description": "Additional Portfolio ID for the Organisation to be found",
"schema": {
"title": "List`1",
"type": "array",
"items": {
"title": "String",
"type": "string"
}
}
},
{
"name": "status",
"in": "query",
"description": "Status of the Organisation to be found",
"schema": {
"title": "List`1",
"type": "array",
"items": {
"title": "String",
"type": "string"
}
}
},
{
"name": "name",
"in": "query",
"description": "Name of the Organisation to be found",
"schema": {
"title": "List`1",
"type": "array",
"items": {
"title": "String",
"type": "string"
}
}
},
{
"name": "postcode",
"in": "query",
"description": "Postcode of the Organisation to be found",
"schema": {
"title": "List`1",
"type": "array",
"items": {
"title": "String",
"type": "string"
}
}
},
{
"name": "site",
"in": "query",
"description": "Search for employers by site",
"schema": {
"title": "String",
"type": "string"
}
},
{
"name": "tag",
"in": "query",
"description": "Search for Organisations by tag",
"schema": {
"title": "List`1",
"type": "array",
"items": {
"title": "String",
"type": "string"
}
}
},
{
"name": "createdSince",
"in": "query",
"description": "Search for Organisations created after the given date",
"schema": {
"title": "Nullable`1",
"type": "string",
"format": "date-time"
}
},
{
"name": "updatedSince",
"in": "query",
"description": "Search for Organisations modified after the given date",
"schema": {
"title": "Nullable`1",
"type": "string",
"format": "date-time"
}
},
{
"name": "sortDirection",
"in": "query",
"description": "Sort Direction",
"schema": {
"title": "SortDirection",
"enum": [
"Assending",
"Descending"
],
"type": "string",
"default": "Descending"
}
},
{
"name": "pageNumber",
"in": "query",
"description": "Page Number",
"schema": {
"title": "Nullable`1",
"type": "integer",
"format": "int32"
}
},
{
"name": "pageSize",
"in": "query",
"description": "Page Size",
"schema": {
"title": "Int32",
"maximum": 1000,
"minimum": 5,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.SearchResultsViewModel`1[[Business.Core.Api.ViewModels.Organisations.SummaryViewModel, Business, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.SearchResultsViewModel`1[[Business.Core.Api.ViewModels.Organisations.SummaryViewModel, Business, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Organisations"
],
"summary": "Insert Organisation",
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Organisations.CreateViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Organisations.CreateViewModel"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"title": "String",
"type": "string"
}
},
"application/xml": {
"schema": {
"title": "String",
"type": "string"
}
}
}
}
}
}
},
"/api/v1/organisations/{id}": {
"get": {
"tags": [
"Organisations"
],
"summary": "Get an Organisation by ID",
"description": "Sample request:\r\n\r\n GET /Organisations/ACMEAC",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Organisation's ID",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "ACMEAC"
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Organisations.DetailsViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Organisations.DetailsViewModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
},
"put": {
"tags": [
"Organisations"
],
"summary": "Edit Organisation",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Organisation's code",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "ACMEAC"
}
],
"requestBody": {
"description": "Fields to be edited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Organisations.EditViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Organisations.EditViewModel"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/organisations/{id}/udfanswers": {
"get": {
"tags": [
"Organisations"
],
"summary": "Get Organisation User Defined Form answers",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Organisation's ID",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "ACMEAC"
},
{
"name": "udfApiCodes",
"in": "query",
"description": "The unique codes for the User Defined questions",
"schema": {
"title": "List`1",
"type": "array",
"items": {
"title": "String",
"type": "string"
}
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.UdfAnswersViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.UdfAnswersViewModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
},
"post": {
"tags": [
"Organisations"
],
"summary": "Insert Organisation User Defined Form answers",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Organisation's ID",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "ACMEAC"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.UdfAnswersViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.UdfAnswersViewModel"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/organisations/udfs": {
"get": {
"tags": [
"Organisations"
],
"summary": "Get a list of all Organisation User Defined Questions",
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.UdfQuestionsViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.UdfQuestionsViewModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/organisations/tags": {
"get": {
"tags": [
"Organisations"
],
"summary": "Get list of all Organisation tags",
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.TagsViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.TagsViewModel"
}
}
}
}
}
}
},
"/api/v1/organisations/{id}/tags": {
"get": {
"tags": [
"Organisations"
],
"summary": "Get Organisation Tags",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Organisation's id",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "ACMEAC"
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.TagsViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.TagsViewModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
},
"post": {
"tags": [
"Organisations"
],
"summary": "Insert Organisation Tags",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Organisation's ID",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "ACMEAC"
}
],
"requestBody": {
"description": "The tags to be inserted into the Organisation's record",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.TagsViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.TagsViewModel"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
},
"delete": {
"tags": [
"Organisations"
],
"summary": "Delete Organisation Tags",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Id of the Organisation to delete Tags from",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "ACMEAC"
}
],
"requestBody": {
"description": "Tags to be deleted from Organisation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.TagsViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.TagsViewModel"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/organisations/{id}/photo": {
"get": {
"tags": [
"Organisations"
],
"summary": "Get an Organisation's Photo",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Organisation's ID",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "ACMEAC"
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.PhotoViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.PhotoViewModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/payments": {
"get": {
"tags": [
"Payments"
],
"summary": "Search Payments",
"description": "Sample request:\r\n\r\n GET /Payments?OrganisationCode=ACME",
"parameters": [
{
"name": "learnerIdent",
"in": "query",
"description": "Learner Ident of payments to be found",
"schema": {
"title": "String",
"type": "string"
}
},
{
"name": "organisationCode",
"in": "query",
"description": "Organisation code of payments to be found",
"schema": {
"title": "String",
"type": "string"
}
},
{
"name": "reference",
"in": "query",
"description": "Reference of payments to be found, including Reference, PO Number, or Invoice Number",
"schema": {
"title": "String",
"type": "string"
}
},
{
"name": "status",
"in": "query",
"description": "List of Statuses of payments to be found",
"schema": {
"title": "List`1",
"type": "array",
"items": {
"title": "String",
"type": "string"
}
}
},
{
"name": "sortDirection",
"in": "query",
"description": "Sort Direction",
"schema": {
"title": "SortDirection",
"enum": [
"Assending",
"Descending"
],
"type": "string",
"default": "Descending"
}
},
{
"name": "pageNumber",
"in": "query",
"description": "Page Number",
"schema": {
"title": "Nullable`1",
"type": "integer",
"format": "int32"
}
},
{
"name": "pageSize",
"in": "query",
"description": "Page Size",
"schema": {
"title": "Int32",
"maximum": 1000,
"minimum": 5,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.SearchResultsViewModel`1[[Business.Core.Api.ViewModels.Payments.SummaryViewModel, Business, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.SearchResultsViewModel`1[[Business.Core.Api.ViewModels.Payments.SummaryViewModel, Business, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Payments"
],
"summary": "Insert Payment",
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Payments.CreateViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Payments.CreateViewModel"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"title": "String",
"type": "string"
}
},
"application/xml": {
"schema": {
"title": "String",
"type": "string"
}
}
}
}
}
}
},
"/api/v1/payments/{id}": {
"get": {
"tags": [
"Payments"
],
"summary": "Get a Payment by ID",
"description": "Sample request:\r\n\r\n GET /Payments/ACMEAC",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Payment's ID",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "2268aadb0ef48f44bdd258311816cef4"
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Payments.DetailsViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Payments.DetailsViewModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
},
"put": {
"tags": [
"Payments"
],
"summary": "Edit Payment",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Payment's ID",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "2268aadb0ef48f44bdd258311816cef4"
}
],
"requestBody": {
"description": "Fields to be edited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Payments.EditViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Payments.EditViewModel"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/tasks": {
"get": {
"tags": [
"Tasks"
],
"summary": "Search Tasks",
"description": "Sample request:\r\n\r\n GET /Tasks?ModifiedSince=2023-10-05T00:00:00Z",
"parameters": [
{
"name": "text",
"in": "query",
"description": "Search by Title",
"schema": {
"title": "String",
"type": "string"
}
},
{
"name": "type",
"in": "query",
"description": "Search by Task Type",
"schema": {
"title": "String",
"type": "string"
}
},
{
"name": "status",
"in": "query",
"description": "Search by Task Status",
"schema": {
"title": "String",
"type": "string"
}
},
{
"name": "subStatus",
"in": "query",
"description": "Search by Task SubStatus",
"schema": {
"title": "String",
"type": "string"
}
},
{
"name": "workflow",
"in": "query",
"description": "Search by Task Workflow",
"schema": {
"title": "String",
"type": "string"
}
},
{
"name": "modifiedSince",
"in": "query",
"description": "Search for Tasks Modified Since",
"schema": {
"title": "Nullable`1",
"type": "string",
"format": "date-time"
}
},
{
"name": "createdSince",
"in": "query",
"description": "Search for Tasks Created Since",
"schema": {
"title": "Nullable`1",
"type": "string",
"format": "date-time"
}
},
{
"name": "sortDirection",
"in": "query",
"description": "Sort Direction",
"schema": {
"title": "SortDirection",
"enum": [
"Assending",
"Descending"
],
"type": "string",
"default": "Descending"
}
},
{
"name": "pageNumber",
"in": "query",
"description": "Page Number",
"schema": {
"title": "Nullable`1",
"type": "integer",
"format": "int32"
}
},
{
"name": "pageSize",
"in": "query",
"description": "Page Size",
"schema": {
"title": "Int32",
"maximum": 1000,
"minimum": 5,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.SearchResultsViewModel`1[[Business.Core.Api.ViewModels.Tasks.SearchResultItemViewModel, Business, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.SearchResultsViewModel`1[[Business.Core.Api.ViewModels.Tasks.SearchResultItemViewModel, Business, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Tasks"
],
"summary": "Insert Task",
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Tasks.CreateViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Tasks.CreateViewModel"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"title": "String",
"type": "string"
}
},
"application/xml": {
"schema": {
"title": "String",
"type": "string"
}
}
}
}
}
}
},
"/api/v1/tasks/{id}": {
"get": {
"tags": [
"Tasks"
],
"summary": "Get a Task by ID",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Task's ID",
"required": true,
"schema": {
"title": "Int32",
"type": "integer",
"format": "int32"
},
"example": 10001
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Tasks.DetailsViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Tasks.DetailsViewModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
},
"put": {
"tags": [
"Tasks"
],
"summary": "Edit Task",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Task's ID",
"required": true,
"schema": {
"title": "Int32",
"type": "integer",
"format": "int32"
},
"example": 10001
}
],
"requestBody": {
"description": "Fields to be edited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Tasks.EditViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Tasks.EditViewModel"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/tasks/template/{templateid}/for/{forid}": {
"get": {
"tags": [
"Tasks"
],
"summary": "Get a create task object for a given template and entity",
"parameters": [
{
"name": "templateID",
"in": "path",
"description": "The ID of the template to be used",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "MYTEMPLATE"
},
{
"name": "forID",
"in": "path",
"description": "The ID of the entity the appointment is being create for",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "OABC1"
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Tasks.CreateViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Tasks.CreateViewModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/tasks/{id}/udfanswers": {
"get": {
"tags": [
"Tasks"
],
"summary": "Get Task User Defined Form answers",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Task's ID",
"required": true,
"schema": {
"title": "Int32",
"type": "integer",
"format": "int32"
},
"example": 10001
},
{
"name": "udfApiCodes",
"in": "query",
"description": "The unique codes for the User Defined questions",
"schema": {
"title": "List`1",
"type": "array",
"items": {
"title": "String",
"type": "string"
}
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.UdfAnswersViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.UdfAnswersViewModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
},
"post": {
"tags": [
"Tasks"
],
"summary": "Insert Task User Defined Form answers",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Task's ID",
"required": true,
"schema": {
"title": "Int32",
"type": "integer",
"format": "int32"
},
"example": 10001
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.UdfAnswersViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.UdfAnswersViewModel"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/tasks/udfs": {
"get": {
"tags": [
"Tasks"
],
"summary": "Get a list of all Task User Defined Questions",
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.UdfQuestionsViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.UdfQuestionsViewModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/tasks/tags": {
"get": {
"tags": [
"Tasks"
],
"summary": "Get list of all Task tags",
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.TagsViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.TagsViewModel"
}
}
}
}
}
}
},
"/api/v1/tasks/{id}/tags": {
"get": {
"tags": [
"Tasks"
],
"summary": "Get Task Tags",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Task's id",
"required": true,
"schema": {
"title": "Int32",
"type": "integer",
"format": "int32"
},
"example": 10001
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.TagsViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.TagsViewModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
},
"post": {
"tags": [
"Tasks"
],
"summary": "Insert Task Tags",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Task's ID",
"required": true,
"schema": {
"title": "Int32",
"type": "integer",
"format": "int32"
},
"example": 10001
}
],
"requestBody": {
"description": "The tags to be inserted into the Task's record",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.TagsViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.TagsViewModel"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
},
"delete": {
"tags": [
"Tasks"
],
"summary": "Delete Task Tags",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Id of the Task to delete Tags from",
"required": true,
"schema": {
"title": "Int32",
"type": "integer",
"format": "int32"
},
"example": 10001
}
],
"requestBody": {
"description": "Tags to be deleted from Task",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.TagsViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.TagsViewModel"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/tasks/{id}/attachments": {
"get": {
"tags": [
"Tasks"
],
"summary": "Get a list of all Task attachments",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Task's ID",
"required": true,
"schema": {
"title": "Int32",
"type": "integer",
"format": "int32"
},
"example": 1
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Tasks.AttachmentsViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Tasks.AttachmentsViewModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
},
"post": {
"tags": [
"Tasks"
],
"summary": "Add an Attachment to a Task",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Id of the Task to attach a file to",
"required": true,
"schema": {
"title": "Int32",
"type": "integer",
"format": "int32"
},
"example": 10001
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"required": [
"description",
"file",
"iD"
],
"type": "object",
"properties": {
"iD": {
"title": "Int32",
"type": "integer",
"format": "int32"
},
"description": {
"title": "String",
"type": "string"
},
"fileType": {
"title": "String",
"type": "string"
},
"expires": {
"title": "Nullable`1",
"type": "string",
"format": "date-time"
},
"file": {
"title": "IFormFile",
"type": "string",
"format": "binary"
}
}
},
"encoding": {
"iD": {
"style": "form"
},
"description": {
"style": "form"
},
"fileType": {
"style": "form"
},
"expires": {
"style": "form"
},
"file": {
"style": "form"
}
}
},
"application/json": {
"schema": {
"required": [
"description",
"file",
"iD"
],
"type": "object",
"properties": {
"iD": {
"title": "Int32",
"type": "integer",
"format": "int32"
},
"description": {
"title": "String",
"type": "string"
},
"fileType": {
"title": "String",
"type": "string"
},
"expires": {
"title": "Nullable`1",
"type": "string",
"format": "date-time"
},
"file": {
"title": "IFormFile",
"type": "string",
"format": "binary"
}
}
},
"encoding": {
"iD": {
"style": "form"
},
"description": {
"style": "form"
},
"fileType": {
"style": "form"
},
"expires": {
"style": "form"
},
"file": {
"style": "form"
}
}
},
"application/xml": {
"schema": {
"required": [
"description",
"file",
"iD"
],
"type": "object",
"properties": {
"iD": {
"title": "Int32",
"type": "integer",
"format": "int32"
},
"description": {
"title": "String",
"type": "string"
},
"fileType": {
"title": "String",
"type": "string"
},
"expires": {
"title": "Nullable`1",
"type": "string",
"format": "date-time"
},
"file": {
"title": "IFormFile",
"type": "string",
"format": "binary"
}
}
},
"encoding": {
"iD": {
"style": "form"
},
"description": {
"style": "form"
},
"fileType": {
"style": "form"
},
"expires": {
"style": "form"
},
"file": {
"style": "form"
}
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"title": "String",
"type": "string"
}
},
"application/xml": {
"schema": {
"title": "String",
"type": "string"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/tasks/{id}/attachments/{attachmentid}/download": {
"get": {
"tags": [
"Tasks"
],
"summary": "Download a task file attachment",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The task's ID",
"required": true,
"schema": {
"title": "Int32",
"type": "integer",
"format": "int32"
},
"example": 1
},
{
"name": "attachmentId",
"in": "path",
"description": "The task attachment's 32-character ID",
"required": true,
"schema": {
"title": "String",
"type": "string"
},
"example": "123456789012345678901234567890ab"
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"303": {
"description": "See Other"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/tasks/templates": {
"get": {
"tags": [
"Tasks"
],
"summary": "Get a list of all Task Templates",
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
},
"application/xml": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/tasks/workflows": {
"get": {
"tags": [
"Tasks"
],
"summary": "Get a list of all Task Workflows",
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
},
"application/xml": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/tasks/participantroles": {
"get": {
"tags": [
"Tasks"
],
"summary": "Get a list of all Task participant Roles",
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
},
"application/xml": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/tasks/participanttypes": {
"get": {
"tags": [
"Tasks"
],
"summary": "Get a list of all Task participant Types",
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
},
"application/xml": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/tasks/types": {
"get": {
"tags": [
"Tasks"
],
"summary": "Get a list of all Task Types",
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
},
"application/xml": {
"schema": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string"
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/tasks/statuses": {
"get": {
"tags": [
"Tasks"
],
"summary": "Get a list of all Task Statuses",
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.StatusesViewModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.StatusesViewModel"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"Business.Core.Api.ViewModels.Applicants.CreateViewModel": {
"title": "CreateViewModel",
"required": [
"firstNames",
"surname"
],
"type": "object",
"properties": {
"title": {
"title": "String",
"type": "string",
"description": "Applicant's Title",
"nullable": true
},
"firstNames": {
"title": "String",
"minLength": 1,
"type": "string",
"description": "Applicant's First Names"
},
"preferredFirstName": {
"title": "String",
"type": "string",
"description": "Applicant's Preferred First Name",
"nullable": true
},
"surname": {
"title": "String",
"minLength": 1,
"type": "string",
"description": "Applicant's Surname"
},
"previousSurname": {
"title": "String",
"type": "string",
"description": "Applicant's Previous Surname",
"nullable": true
},
"email": {
"title": "String",
"type": "string",
"description": "Applicant's Email",
"nullable": true
},
"risk": {
"title": "String",
"type": "string",
"description": "Applicant's Risk",
"nullable": true
},
"address": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.AddressViewModel"
},
"homePhone": {
"title": "String",
"type": "string",
"description": "Applicant's Home Phone Number",
"nullable": true
},
"mobile": {
"title": "String",
"type": "string",
"description": "Applicant's Mobile Phone Number",
"format": "tel",
"nullable": true
},
"picsUsername": {
"title": "String",
"type": "string",
"description": "Applicant's PICS Username",
"nullable": true
},
"allowedContactMethods": {
"title": "List`1",
"type": "array",
"items": {
"title": "String",
"type": "string"
},
"description": "Applicant's Allowed Contact Method Codes",
"nullable": true
},
"preferredContactMethod": {
"title": "String",
"type": "string",
"description": "Applicant's Preferred Contact Method Code",
"nullable": true
},
"dateOfBirth": {
"title": "Nullable`1",
"type": "string",
"description": "Applicant's Date Of Birth",
"format": "date-time",
"nullable": true
},
"sex": {
"title": "String",
"type": "string",
"description": "Applicant's Sex",
"nullable": true
},
"ethnicity": {
"title": "String",
"type": "string",
"description": "Applicant's Ethnicity",
"nullable": true
},
"niNumber": {
"title": "String",
"type": "string",
"description": "Applicant's NINumber",
"nullable": true
},
"learnerReferenceNumber": {
"title": "String",
"type": "string",
"description": "Applicant's Learner Reference Number",
"nullable": true
},
"ilrDisability": {
"title": "String",
"type": "string",
"description": "Applicant's ILR Disability",
"nullable": true
},
"lldDs": {
"title": "List`1",
"type": "array",
"items": {
"title": "String",
"type": "string"
},
"description": "Applicant's LLDDs",
"nullable": true
},
"primaryLLDD": {
"title": "String",
"type": "string",
"description": "Applicant's Primary LLDD",
"nullable": true
},
"householdSituation": {
"title": "List`1",
"type": "array",
"items": {
"title": "String",
"type": "string"
},
"description": "Applicant's Household Situation",
"nullable": true
},
"nextOfKinName": {
"title": "String",
"type": "string",
"description": "Applicant's Next Of Kin Name",
"nullable": true
},
"nextOfKinRelationship": {
"title": "String",
"type": "string",
"description": "Applicant's Next Of Kin Relationship",
"nullable": true
},
"nextOfKinPhone": {
"title": "String",
"type": "string",
"description": "Applicant's Next Of Kin Phone Number",
"nullable": true
},
"nextOfKinPhone2": {
"title": "String",
"type": "string",
"description": "Applicant's Next Of Kin Phone Number 2",
"nullable": true
},
"nextOfKinEmail": {
"title": "String",
"type": "string",
"description": "Applicant's Next Of Kin Email",
"nullable": true
},
"otherSystemID": {
"title": "String",
"type": "string",
"description": "Applicant's Other System ID",
"nullable": true
},
"providerIdent": {
"title": "String",
"type": "string",
"description": "Applicant's Provider Ident",
"nullable": true
},
"mainOfficer": {
"title": "String",
"type": "string",
"description": "Applicant's Main Officer Code",
"nullable": true
},
"recruitmentOfficer": {
"title": "String",
"type": "string",
"description": "Applicant's Recruitment Officer Code",
"nullable": true
},
"mentorOfficer": {
"title": "String",
"type": "string",
"description": "Applicant's Mentor Officer Code",
"nullable": true
},
"plannedStart": {
"title": "Nullable`1",
"type": "string",
"description": "Applicant's Planned Start Date",
"format": "date-time",
"nullable": true
},
"expectedEnd": {
"title": "Nullable`1",
"type": "string",
"description": "Applicant's Expected End Date",
"format": "date-time",
"nullable": true
},
"countryOfDomicile": {
"title": "String",
"type": "string",
"description": "Applicant's Country Of Domicile",
"nullable": true
},
"site": {
"title": "String",
"type": "string",
"description": "Applicant's Site Code",
"nullable": true
},
"uln": {
"title": "String",
"type": "string",
"description": "Applicant's ULN",
"nullable": true
},
"restrictedUseIndicator": {
"title": "String",
"type": "string",
"description": "Applicant's Restricted Use Indicator",
"nullable": true
},
"gcseMath": {
"title": "String",
"type": "string",
"description": "Applicant's GCSE Math",
"nullable": true
},
"gcseEnglish": {
"title": "String",
"type": "string",
"description": "Applicant's GCSE English",
"nullable": true
},
"qualificationPlan": {
"title": "String",
"type": "string",
"description": "Applicant's Qualification Plan Code",
"nullable": true
},
"act": {
"title": "String",
"type": "string",
"description": "Applicant's ACT",
"nullable": true
},
"vatStatus": {
"title": "String",
"type": "string",
"description": "Applicant's VATStatus",
"nullable": true
},
"asStatus": {
"title": "String",
"type": "string",
"description": "Applicant's Apprenticeship Service Status",
"nullable": true
},
"asCohort": {
"title": "String",
"type": "string",
"description": "Applicant's Apprenticeship Service Cohort",
"nullable": true
},
"bksbUsername": {
"title": "String",
"type": "string",
"description": "Applicant's BKSB Username",
"nullable": true
},
"workflow": {
"title": "String",
"type": "string",
"description": "Applicant's Workflow",
"nullable": true
},
"employerCode": {
"title": "String",
"type": "string",
"description": "Applicant's Employer Code",
"nullable": true
},
"recruitmentAgencyCode": {
"title": "String",
"type": "string",
"description": "Applicant's Recruitment Agency Code",
"nullable": true
},
"opportunityID": {
"title": "Nullable`1",
"type": "integer",
"description": "Applicant's Opportunity ID",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false,
"description": "Collection of properties used to create an Applicant"
},
"Business.Core.Api.ViewModels.Applicants.DetailsViewModel": {
"title": "DetailsViewModel",
"type": "object",
"properties": {
"id": {
"title": "String",
"type": "string",
"nullable": true
},
"originalApplicantID": {
"title": "String",
"type": "string",
"nullable": true
},
"title": {
"title": "String",
"type": "string",
"nullable": true
},
"firstNames": {
"title": "String",
"type": "string",
"nullable": true
},
"preferredFirstName": {
"title": "String",
"type": "string",
"nullable": true
},
"surname": {
"title": "String",
"type": "string",
"nullable": true
},
"previousSurname": {
"title": "String",
"type": "string",
"nullable": true
},
"email": {
"title": "String",
"type": "string",
"nullable": true
},
"risk": {
"title": "String",
"type": "string",
"nullable": true
},
"address": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.AddressViewModel"
},
"ward": {
"title": "String",
"type": "string",
"nullable": true
},
"homePhone": {
"title": "String",
"type": "string",
"nullable": true
},
"mobile": {
"title": "String",
"type": "string",
"nullable": true
},
"username": {
"title": "String",
"type": "string",
"nullable": true
},
"lastLogin": {
"title": "Nullable`1",
"type": "string",
"format": "date-time",
"nullable": true
},
"allowedContactMethods": {
"title": "List`1",
"type": "array",
"items": {
"title": "String",
"type": "string"
},
"nullable": true
},
"preferredContactMethod": {
"title": "String",
"type": "string",
"nullable": true
},
"dateOfBirth": {
"title": "Nullable`1",
"type": "string",
"format": "date-time",
"nullable": true
},
"currentAge": {
"title": "String",
"type": "string",
"nullable": true
},
"sex": {
"title": "String",
"type": "string",
"nullable": true
},
"ethnicity": {
"title": "String",
"type": "string",
"nullable": true
},
"niNumber": {
"title": "String",
"type": "string",
"nullable": true
},
"learnerReferenceNumber": {
"title": "String",
"type": "string",
"nullable": true
},
"ilrDisability": {
"title": "String",
"type": "string",
"nullable": true
},
"lldDs": {
"title": "List`1",
"type": "array",
"items": {
"title": "String",
"type": "string"
},
"nullable": true
},
"primaryLLDD": {
"title": "String",
"type": "string",
"nullable": true
},
"householdSituation": {
"title": "List`1",
"type": "array",
"items": {
"title": "String",
"type": "string"
},
"nullable": true
},
"nextOfKinName": {
"title": "String",
"type": "string",
"nullable": true
},
"nextOfKinRelationship": {
"title": "String",
"type": "string",
"nullable": true
},
"nextOfKinPhone": {
"title": "String",
"type": "string",
"nullable": true
},
"nextOfKinPhone2": {
"title": "String",
"type": "string",
"nullable": true
},
"nextOfKinEmail": {
"title": "String",
"type": "string",
"nullable": true
},
"otherSystemID": {
"title": "String",
"type": "string",
"nullable": true
},
"hasDrivingLicence": {
"title": "String",
"type": "string",
"nullable": true
},
"hasOwnTransport": {
"title": "String",
"type": "string",
"nullable": true
},
"providerIdent": {
"title": "String",
"type": "string",
"nullable": true
},
"mainOfficer": {
"title": "String",
"type": "string",
"nullable": true
},
"recruitmentOfficer": {
"title": "String",
"type": "string",
"nullable": true
},
"mentorOfficer": {
"title": "String",
"type": "string",
"nullable": true
},
"status": {
"title": "String",
"type": "string",
"nullable": true
},
"plannedStart": {
"title": "Nullable`1",
"type": "string",
"format": "date-time",
"nullable": true
},
"expectedEnd": {
"title": "Nullable`1",
"type": "string",
"format": "date-time",
"nullable": true
},
"countryOfDomicile": {
"title": "String",
"type": "string",
"nullable": true
},
"site": {
"title": "String",
"type": "string",
"nullable": true
},
"uln": {
"title": "String",
"type": "string",
"nullable": true
},
"restrictedUseIndicator": {
"title": "String",
"type": "string",
"nullable": true
},
"gcseMath": {
"title": "String",
"type": "string",
"nullable": true
},
"gcseEnglish": {
"title": "String",
"type": "string",
"nullable": true
},
"qualificationPlan": {
"title": "String",
"type": "string",
"nullable": true
},
"act": {
"title": "String",
"type": "string",
"nullable": true
},
"vatStatus": {
"title": "String",
"type": "string",
"nullable": true
},
"asStatus": {
"title": "String",
"type": "string",
"nullable": true
},
"asCohort": {
"title": "String",
"type": "string",
"nullable": true
},
"bksbUsername": {
"title": "String",
"type": "string",
"nullable": true
},
"workflow": {
"title": "String",
"type": "string",
"nullable": true
},
"workflowStatus": {
"title": "String",
"type": "string",
"nullable": true
},
"workflowSubStatus": {
"title": "String",
"type": "string",
"nullable": true
},
"updatedOn": {
"title": "Nullable`1",
"type": "string",
"format": "date-time",
"nullable": true
},
"createdOn": {
"title": "Nullable`1",
"type": "string",
"format": "date-time",
"nullable": true
},
"employerCode": {
"title": "String",
"type": "string",
"nullable": true
},
"recruitmentAgencyCode": {
"title": "String",
"type": "string",
"nullable": true
},
"opportunityID": {
"title": "Nullable`1",
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"Business.Core.Api.ViewModels.Applicants.EditViewModel": {
"title": "EditViewModel",
"required": [
"firstNames",
"id",
"surname"
],
"type": "object",
"properties": {
"id": {
"title": "String",
"minLength": 1,
"type": "string",
"description": "Applicant's identifier"
},
"originalApplicantID": {
"title": "String",
"type": "string",
"description": "Original applicant's identifier",
"nullable": true
},
"title": {
"title": "String",
"type": "string",
"description": "Applicant's title",
"nullable": true
},
"firstNames": {
"title": "String",
"minLength": 1,
"type": "string",
"description": "Applicant's first names"
},
"preferredFirstName": {
"title": "String",
"type": "string",
"description": "Applicant's preferred first name",
"nullable": true
},
"surname": {
"title": "String",
"minLength": 1,
"type": "string",
"description": "Applicant's surname"
},
"previousSurname": {
"title": "String",
"type": "string",
"description": "Applicant's previous surname",
"nullable": true
},
"email": {
"title": "String",
"type": "string",
"description": "Applicant's email address",
"nullable": true
},
"risk": {
"title": "String",
"type": "string",
"description": "Applicant's risk information",
"nullable": true
},
"address": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.AddressViewModel"
},
"ward": {
"title": "String",
"type": "string",
"description": "Applicant's ward",
"nullable": true
},
"homePhone": {
"title": "String",
"type": "string",
"description": "Applicant's home phone number",
"nullable": true
},
"mobile": {
"title": "String",
"type": "string",
"description": "Applicant's mobile phone number",
"format": "tel",
"nullable": true
},
"username": {
"title": "String",
"type": "string",
"description": "Applicant's username",
"nullable": true
},
"userID": {
"title": "String",
"type": "string",
"description": "Applicant's user ID",
"nullable": true
},
"allowedContactMethods": {
"title": "List`1",
"type": "array",
"items": {
"title": "String",
"type": "string"
},
"description": "List of allowed contact methods for the applicant",
"nullable": true
},
"preferredContactMethod": {
"title": "String",
"type": "string",
"description": "Preferred contact method for the applicant",
"nullable": true
},
"dateOfBirth": {
"title": "Nullable`1",
"type": "string",
"description": "Applicant's date of birth",
"format": "date-time",
"nullable": true
},
"currentAge": {
"title": "String",
"type": "string",
"description": "Applicant's current age",
"nullable": true
},
"sex": {
"title": "String",
"type": "string",
"description": "Applicant's gender",
"nullable": true
},
"ethnicity": {
"title": "String",
"type": "string",
"description": "Applicant's ethnicity",
"nullable": true
},
"niNumber": {
"title": "String",
"type": "string",
"description": "Applicant's National Insurance Number",
"nullable": true
},
"learnerReferenceNumber": {
"title": "String",
"type": "string",
"description": "Applicant's Learner Reference Number",
"nullable": true
},
"ilrDisability": {
"title": "String",
"type": "string",
"description": "Applicant's Individual Learning Record (ILR) disability status",
"nullable": true
},
"lldDs": {
"title": "List`1",
"type": "array",
"items": {
"title": "String",
"type": "string"
},
"description": "List of Learning Difficulties and/or Disabilities (LLDDs) for the applicant",
"nullable": true
},
"primaryLLDD": {
"title": "String",
"type": "string",
"description": "Applicant's primary LLDD",
"nullable": true
},
"householdSituation": {
"title": "List`1",
"type": "array",
"items": {
"title": "String",
"type": "string"
},
"description": "Household situation for the applicant",
"nullable": true
},
"nextOfKinName": {
"title": "String",
"type": "string",
"description": "Name of the next of kin for the applicant",
"nullable": true
},
"nextOfKinRelationship": {
"title": "String",
"type": "string",
"description": "Relationship with the next of kin for the applicant",
"nullable": true
},
"nextOfKinPhone": {
"title": "String",
"type": "string",
"description": "Phone number of the next of kin for the applicant",
"nullable": true
},
"nextOfKinPhone2": {
"title": "String",
"type": "string",
"description": "Second phone number of the next of kin for the applicant",
"nullable": true
},
"nextOfKinEmail": {
"title": "String",
"type": "string",
"description": "Email address of the next of kin for the applicant",
"nullable": true
},
"otherSystemID": {
"title": "String",
"type": "string",
"description": "ID from another system for the applicant",
"nullable": true
},
"providerIdent": {
"title": "String",
"type": "string",
"description": "Provider identifier for the applicant",
"nullable": true
},
"mainOfficer": {
"title": "String",
"type": "string",
"description": "Main officer assigned to the applicant",
"nullable": true
},
"recruitmentOfficer": {
"title": "String",
"type": "string",
"description": "Recruitment officer assigned to the applicant",
"nullable": true
},
"mentorOfficer": {
"title": "String",
"type": "string",
"description": "Mentor officer assigned to the applicant",
"nullable": true
},
"plannedStart": {
"title": "Nullable`1",
"type": "string",
"description": "Planned start date for the applicant",
"format": "date-time",
"nullable": true
},
"expectedEnd": {
"title": "Nullable`1",
"type": "string",
"description": "Expected end date for the applicant",
"format": "date-time",
"nullable": true
},
"countryOfDomicile": {
"title": "String",
"type": "string",
"description": "Country of domicile for the applicant",
"nullable": true
},
"site": {
"title": "String",
"type": "string",
"description": "Site information for the applicant",
"nullable": true
},
"uln": {
"title": "String",
"type": "string",
"description": "Unique Learner Number (ULN) for the applicant",
"nullable": true
},
"restrictedUseIndicator": {
"title": "String",
"type": "string",
"description": "Restricted use indicator for the applicant",
"nullable": true
},
"gcseMath": {
"title": "String",
"type": "string",
"description": "GCSE Math qualification status for the applicant",
"nullable": true
},
"gcseEnglish": {
"title": "String",
"type": "string",
"description": "GCSE English qualification status for the applicant",
"nullable": true
},
"qualificationPlan": {
"title": "String",
"type": "string",
"description": "Qualification plan for the applicant",
"nullable": true
},
"act": {
"title": "String",
"type": "string",
"description": "ACT information for the applicant.",
"nullable": true
},
"vatStatus": {
"title": "String",
"type": "string",
"description": "VAT status for the applicant",
"nullable": true
},
"asStatus": {
"title": "String",
"type": "string",
"description": "AS (Apprenticeship Service) status for the applicant",
"nullable": true
},
"asCohort": {
"title": "String",
"type": "string",
"description": "AS (Apprenticeship Service) cohort for the applicant",
"nullable": true
},
"bksbUsername": {
"title": "String",
"type": "string",
"description": "BKSB username for the applicant",
"nullable": true
},
"employerCode": {
"title": "String",
"type": "string",
"description": "Employer code for the applicant",
"nullable": true
},
"recruitmentAgencyCode": {
"title": "String",
"type": "string",
"description": "Recruitment agency code for the applicant",
"nullable": true
},
"opportunityID": {
"title": "Nullable`1",
"type": "integer",
"description": "Opportunity identifier for the applicant",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false,
"description": "Collection of properties used to edit an Applicant"
},
"Business.Core.Api.ViewModels.Applicants.SearchResultItemViewModel": {
"title": "SearchResultItemViewModel",
"type": "object",
"properties": {
"id": {
"title": "String",
"type": "string",
"nullable": true
},
"originalApplicantID": {
"title": "String",
"type": "string",
"nullable": true
},
"title": {
"title": "String",
"type": "string",
"nullable": true
},
"firstNames": {
"title": "String",
"type": "string",
"nullable": true
},
"preferredFirstName": {
"title": "String",
"type": "string",
"nullable": true
},
"surname": {
"title": "String",
"type": "string",
"nullable": true
},
"email": {
"title": "String",
"type": "string",
"nullable": true
},
"risk": {
"title": "String",
"type": "string",
"nullable": true
},
"address": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.AddressViewModel"
},
"ward": {
"title": "String",
"type": "string",
"nullable": true
},
"homePhone": {
"title": "String",
"type": "string",
"nullable": true
},
"mobile": {
"title": "String",
"type": "string",
"nullable": true
},
"username": {
"title": "String",
"type": "string",
"nullable": true
},
"lastLogin": {
"title": "Nullable`1",
"type": "string",
"format": "date-time",
"nullable": true
},
"allowedContactMethods": {
"title": "List`1",
"type": "array",
"items": {
"title": "String",
"type": "string"
},
"nullable": true
},
"preferredContactMethod": {
"title": "String",
"type": "string",
"nullable": true
},
"dateOfBirth": {
"title": "Nullable`1",
"type": "string",
"format": "date-time",
"nullable": true
},
"currentAge": {
"title": "String",
"type": "string",
"nullable": true
},
"sex": {
"title": "String",
"type": "string",
"nullable": true
},
"ethnicity": {
"title": "String",
"type": "string",
"nullable": true
},
"niNumber": {
"title": "String",
"type": "string",
"nullable": true
},
"learnerReferenceNumber": {
"title": "String",
"type": "string",
"nullable": true
},
"ilrDisability": {
"title": "String",
"type": "string",
"nullable": true
},
"lldDs": {
"title": "List`1",
"type": "array",
"items": {
"title": "String",
"type": "string"
},
"nullable": true
},
"primaryLLDD": {
"title": "String",
"type": "string",
"nullable": true
},
"householdSituation": {
"title": "List`1",
"type": "array",
"items": {
"title": "String",
"type": "string"
},
"nullable": true
},
"nextOfKinName": {
"title": "String",
"type": "string",
"nullable": true
},
"nextOfKinRelationship": {
"title": "String",
"type": "string",
"nullable": true
},
"nextOfKinPhone": {
"title": "String",
"type": "string",
"nullable": true
},
"nextOfKinPhone2": {
"title": "String",
"type": "string",
"nullable": true
},
"nextOfKinEmail": {
"title": "String",
"type": "string",
"nullable": true
},
"otherSystemID": {
"title": "String",
"type": "string",
"nullable": true
},
"hasDrivingLicence": {
"title": "String",
"type": "string",
"nullable": true
},
"hasOwnTransport": {
"title": "String",
"type": "string",
"nullable": true
},
"providerIdent": {
"title": "String",
"type": "string",
"nullable": true
},
"mainOfficer": {
"title": "String",
"type": "string",
"nullable": true
},
"recruitmentOfficer": {
"title": "String",
"type": "string",
"nullable": true
},
"mentorOfficer": {
"title": "String",
"type": "string",
"nullable": true
},
"status": {
"title": "String",
"type": "string",
"nullable": true
},
"plannedStart": {
"title": "Nullable`1",
"type": "string",
"format": "date-time",
"nullable": true
},
"expectedEnd": {
"title": "Nullable`1",
"type": "string",
"format": "date-time",
"nullable": true
},
"countryOfDomicile": {
"title": "String",
"type": "string",
"nullable": true
},
"site": {
"title": "String",
"type": "string",
"nullable": true
},
"uln": {
"title": "String",
"type": "string",
"nullable": true
},
"restrictedUseIndicator": {
"title": "String",
"type": "string",
"nullable": true
},
"gcseMath": {
"title": "String",
"type": "string",
"nullable": true
},
"gcseEnglish": {
"title": "String",
"type": "string",
"nullable": true
},
"qualificationPlan": {
"title": "String",
"type": "string",
"nullable": true
},
"act": {
"title": "String",
"type": "string",
"nullable": true
},
"vatStatus": {
"title": "String",
"type": "string",
"nullable": true
},
"asStatus": {
"title": "String",
"type": "string",
"nullable": true
},
"asCohort": {
"title": "String",
"type": "string",
"nullable": true
},
"bksbUsername": {
"title": "String",
"type": "string",
"nullable": true
},
"workflow": {
"title": "String",
"type": "string",
"nullable": true
},
"workflowStatus": {
"title": "String",
"type": "string",
"nullable": true
},
"workflowSubStatus": {
"title": "String",
"type": "string",
"nullable": true
},
"updatedOn": {
"title": "Nullable`1",
"type": "string",
"format": "date-time",
"nullable": true
},
"createdOn": {
"title": "Nullable`1",
"type": "string",
"format": "date-time",
"nullable": true
},
"opportunityID": {
"title": "Nullable`1",
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"Business.Core.Api.ViewModels.Appointments.AttachmentViewModelItem": {
"title": "AttachmentViewModelItem",
"type": "object",
"properties": {
"id": {
"title": "String",
"type": "string",
"description": "Attachment ID",
"nullable": true
},
"fileName": {
"title": "String",
"type": "string",
"description": "File name",
"nullable": true
},
"description": {
"title": "String",
"type": "string",
"description": "Attachment description",
"nullable": true
},
"expires": {
"title": "Nullable`1",
"type": "string",
"description": "Attachment expires date",
"format": "date-time",
"nullable": true
},
"fileType": {
"title": "String",
"type": "string",
"description": "Attachment file type",
"nullable": true
}
},
"additionalProperties": false,
"description": "Represents a file attached to an Appointment"
},
"Business.Core.Api.ViewModels.Appointments.AttachmentsViewModel": {
"title": "AttachmentsViewModel",
"type": "object",
"properties": {
"items": {
"title": "List`1",
"type": "array",
"items": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Appointments.AttachmentViewModelItem"
},
"description": "List of appointment file attachments",
"nullable": true
}
},
"additionalProperties": false,
"description": "Represents a list of files attached to an Appointment"
},
"Business.Core.Api.ViewModels.Appointments.CreateViewModel": {
"title": "CreateViewModel",
"required": [
"title"
],
"type": "object",
"properties": {
"title": {
"title": "String",
"maxLength": 255,
"minLength": 1,
"type": "string",
"description": "The Appointment Title"
},
"description": {
"title": "String",
"type": "string",
"description": "Description of the Appointment",
"nullable": true
},
"workflow": {
"title": "String",
"type": "string",
"description": "The Appointment's Workflow Code",
"nullable": true
},
"class": {
"title": "String",
"type": "string",
"description": "The Appointment Class",
"nullable": true
},
"type": {
"title": "String",
"type": "string",
"description": "The Appointment Class",
"nullable": true
},
"expectedStart": {
"title": "Nullable`1",
"type": "string",
"description": "The Appointment's Expected Start",
"format": "date-time",
"nullable": true
},
"expectedEnd": {
"title": "Nullable`1",
"type": "string",
"description": "The Appointment's Expected End",
"format": "date-time",
"nullable": true
},
"actualStart": {
"title": "Nullable`1",
"type": "string",
"description": "The Appointment's Actual Start",
"format": "date-time",
"nullable": true
},
"actualEnd": {
"title": "Nullable`1",
"type": "string",
"description": "The Appointment's Actual End",
"format": "date-time",
"nullable": true
},
"allDay": {
"title": "Boolean",
"type": "boolean",
"description": "Indicates if the Appointment is set to run All Day"
},
"participants": {
"title": "List`1",
"type": "array",
"items": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.ParticipantViewModel"
},
"description": "List of Appointment Participants",
"nullable": true
},
"templateID": {
"title": "String",
"type": "string",
"description": "Not user editable. Assigned when using the create with template function.",
"nullable": true
},
"templateIDChecksum": {
"title": "String",
"type": "string",
"description": "Not user editable. Assigned when using the create with template function.",
"nullable": true
}
},
"additionalProperties": false
},
"Business.Core.Api.ViewModels.Appointments.DetailsViewModel": {
"title": "DetailsViewModel",
"type": "object",
"properties": {
"id": {
"title": "Int32",
"type": "integer",
"description": "Appointment ID",
"format": "int32"
},
"title": {
"title": "String",
"type": "string",
"description": "The Appointment Title",
"nullable": true
},
"description": {
"title": "String",
"type": "string",
"description": "Description of the Appointment",
"nullable": true
},
"status": {
"title": "String",
"type": "string",
"description": "The Appointment's Status",
"nullable": true
},
"subStatus": {
"title": "String",
"type": "string",
"description": "The Appointment's Sub Status",
"nullable": true
},
"workflow": {
"title": "String",
"type": "string",
"description": "The Appointment's Workflow Code",
"nullable": true
},
"class": {
"title": "String",
"type": "string",
"description": "The Appointment Class",
"nullable": true
},
"type": {
"title": "String",
"type": "string",
"description": "The Appointment Class",
"nullable": true
},
"createdBy": {
"title": "String",
"type": "string",
"description": "Officer code used to create the Appointment",
"nullable": true
},
"templateID": {
"title": "String",
"type": "string",
"description": "The Template ID used to create the Appointment",
"nullable": true
},
"expectedStart": {
"title": "Nullable`1",
"type": "string",
"description": "The Appointment's Expected Start",
"format": "date-time",
"nullable": true
},
"expectedEnd": {
"title": "Nullable`1",
"type": "string",
"description": "The Appointment's Expected End",
"format": "date-time",
"nullable": true
},
"actualStart": {
"title": "Nullable`1",
"type": "string",
"description": "The Appointment's Actual Start",
"format": "date-time",
"nullable": true
},
"actualEnd": {
"title": "Nullable`1",
"type": "string",
"description": "The Appointment's Actual End",
"format": "date-time",
"nullable": true
},
"allDay": {
"title": "Nullable`1",
"type": "boolean",
"description": "Indicates if the Appointment is set to run All Day",
"nullable": true
},
"participants": {
"title": "List`1",
"type": "array",
"items": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.ParticipantViewModel"
},
"description": "List of Appointment Participants",
"nullable": true
}
},
"additionalProperties": false
},
"Business.Core.Api.ViewModels.Appointments.EditViewModel": {
"title": "EditViewModel",
"required": [
"id",
"title"
],
"type": "object",
"properties": {
"id": {
"title": "Int32",
"type": "integer",
"description": "The Appointment's ID",
"format": "int32"
},
"title": {
"title": "String",
"maxLength": 255,
"minLength": 1,
"type": "string",
"description": "The Appointment Title"
},
"description": {
"title": "String",
"type": "string",
"description": "Description of the Appointment",
"nullable": true
},
"status": {
"title": "String",
"type": "string",
"description": "The Appointment's Status",
"nullable": true
},
"subStatus": {
"title": "String",
"type": "string",
"description": "The Appointment's Sub Status",
"nullable": true
},
"workflow": {
"title": "String",
"type": "string",
"description": "The Appointment's Workflow Code",
"nullable": true
},
"class": {
"title": "String",
"type": "string",
"description": "The Appointment Class",
"nullable": true
},
"type": {
"title": "String",
"type": "string",
"description": "The Appointment Class",
"nullable": true
},
"expectedStart": {
"title": "Nullable`1",
"type": "string",
"description": "The Appointment's Expected Start",
"format": "date-time",
"nullable": true
},
"expectedEnd": {
"title": "Nullable`1",
"type": "string",
"description": "The Appointment's Expected End",
"format": "date-time",
"nullable": true
},
"actualStart": {
"title": "Nullable`1",
"type": "string",
"description": "The Appointment's Actual Start",
"format": "date-time",
"nullable": true
},
"actualEnd": {
"title": "Nullable`1",
"type": "string",
"description": "The Appointment's Actual End",
"format": "date-time",
"nullable": true
},
"allDay": {
"title": "Boolean",
"type": "boolean",
"description": "Indicates if the Appointment is set to run All Day"
},
"participants": {
"title": "List`1",
"type": "array",
"items": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.ParticipantViewModel"
},
"description": "List of Appointment Participants",
"nullable": true
}
},
"additionalProperties": false
},
"Business.Core.Api.ViewModels.Appointments.SearchResultItemViewModel": {
"title": "SearchResultItemViewModel",
"type": "object",
"properties": {
"id": {
"title": "Int32",
"type": "integer",
"description": "Appointment ID",
"format": "int32"
},
"title": {
"title": "String",
"type": "string",
"description": "The Appointment Title",
"nullable": true
},
"description": {
"title": "String",
"type": "string",
"description": "Description of the Appointment",
"nullable": true
},
"status": {
"title": "String",
"type": "string",
"description": "The Appointment's Status",
"nullable": true
},
"subStatus": {
"title": "String",
"type": "string",
"description": "The Appointment's Sub Status",
"nullable": true
},
"workflow": {
"title": "String",
"type": "string",
"description": "The Appointment's Workflow Code",
"nullable": true
},
"class": {
"title": "String",
"type": "string",
"description": "The Appointment Class",
"nullable": true
},
"type": {
"title": "String",
"type": "string",
"description": "The Appointment Class",
"nullable": true
},
"createdBy": {
"title": "String",
"type": "string",
"description": "Officer code used to create the Appointment",
"nullable": true
},
"templateID": {
"title": "String",
"type": "string",
"description": "The Template ID used to create the Appointment",
"nullable": true
},
"expectedStart": {
"title": "Nullable`1",
"type": "string",
"description": "The Appointment's Expected Start",
"format": "date-time",
"nullable": true
},
"expectedEnd": {
"title": "Nullable`1",
"type": "string",
"description": "The Appointment's Expected End",
"format": "date-time",
"nullable": true
},
"actualStart": {
"title": "Nullable`1",
"type": "string",
"description": "The Appointment's Actual Start",
"format": "date-time",
"nullable": true
},
"actualEnd": {
"title": "Nullable`1",
"type": "string",
"description": "The Appointment's Actual End",
"format": "date-time",
"nullable": true
},
"allDay": {
"title": "Nullable`1",
"type": "boolean",
"description": "Indicates if the Appointment is set to run All Day",
"nullable": true
},
"participants": {
"title": "List`1",
"type": "array",
"items": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.ParticipantViewModel"
},
"description": "List of Appointment Participants",
"nullable": true
}
},
"additionalProperties": false
},
"Business.Core.Api.ViewModels.Authentication.AuthenticationViewModel": {
"title": "AuthenticationViewModel",
"type": "object",
"properties": {
"username": {
"title": "String",
"type": "string",
"description": "Username",
"nullable": true
},
"password": {
"title": "String",
"type": "string",
"description": "Password",
"nullable": true
}
},
"additionalProperties": false
},
"Business.Core.Api.ViewModels.Generic.AddFunctionalSkillAssessmentViewModel": {
"title": "AddFunctionalSkillAssessmentViewModel",
"required": [
"date",
"level",
"subject",
"type"
],
"type": "object",
"properties": {
"type": {
"title": "String",
"maxLength": 1,
"minLength": 1,
"type": "string",
"description": "Functional Skills assessment type code",
"example": "I"
},
"subject": {
"title": "String",
"maxLength": 1,
"minLength": 1,
"type": "string",
"description": "Functional Skills assessment subject code",
"example": "E"
},
"level": {
"title": "String",
"maxLength": 3,
"minLength": 1,
"type": "string",
"description": "Functional Skills assessment level code",
"example": "L10"
},
"date": {
"title": "Nullable`1",
"type": "string",
"description": "Functional Skills assessment date",
"format": "date-time"
},
"result": {
"title": "Nullable`1",
"maximum": 100,
"minimum": 0,
"type": "number",
"description": "Functional Skills assessment result",
"format": "double",
"nullable": true,
"example": 50
}
},
"additionalProperties": false
},
"Business.Core.Api.ViewModels.Generic.AddressViewModel": {
"title": "AddressViewModel",
"type": "object",
"properties": {
"line1": {
"title": "String",
"maxLength": 60,
"type": "string",
"nullable": true
},
"line2": {
"title": "String",
"maxLength": 60,
"type": "string",
"nullable": true
},
"line3": {
"title": "String",
"maxLength": 60,
"type": "string",
"nullable": true
},
"line4": {
"title": "String",
"maxLength": 60,
"type": "string",
"nullable": true
},
"line5": {
"title": "String",
"maxLength": 60,
"type": "string",
"nullable": true
},
"postcode": {
"title": "String",
"maxLength": 8,
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Business.Core.Api.ViewModels.Generic.AppointmentViewModel": {
"title": "AppointmentViewModel",
"type": "object",
"properties": {
"items": {
"title": "List`1",
"type": "array",
"items": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.AppointmentViewModelItem"
},
"nullable": true
}
},
"additionalProperties": false
},
"Business.Core.Api.ViewModels.Generic.AppointmentViewModelItem": {
"title": "AppointmentViewModelItem",
"type": "object",
"properties": {
"id": {
"title": "Int32",
"type": "integer",
"format": "int32"
},
"title": {
"title": "String",
"type": "string",
"nullable": true
},
"workflowStatus": {
"title": "String",
"type": "string",
"nullable": true
},
"workflowSubStatus": {
"title": "String",
"type": "string",
"nullable": true,
"readOnly": true
},
"description": {
"title": "String",
"type": "string",
"nullable": true
},
"eventType": {
"title": "String",
"type": "string",
"nullable": true
},
"start": {
"title": "Nullable`1",
"type": "string",
"format": "date-time",
"nullable": true
},
"end": {
"title": "Nullable`1",
"type": "string",
"format": "date-time",
"nullable": true
},
"allDay": {
"title": "Boolean",
"type": "boolean"
},
"completed": {
"title": "Nullable`1",
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"Business.Core.Api.ViewModels.Generic.EditFunctionalSkillAssessmentViewModel": {
"title": "EditFunctionalSkillAssessmentViewModel",
"required": [
"date",
"level",
"subject",
"type"
],
"type": "object",
"properties": {
"type": {
"title": "String",
"maxLength": 1,
"minLength": 1,
"type": "string",
"description": "Functional Skills assessment type code",
"example": "I"
},
"subject": {
"title": "String",
"maxLength": 1,
"minLength": 1,
"type": "string",
"description": "Functional Skills assessment subject code",
"example": "E"
},
"level": {
"title": "String",
"maxLength": 3,
"minLength": 1,
"type": "string",
"description": "Functional Skills assessment level code",
"example": "L10"
},
"date": {
"title": "Nullable`1",
"type": "string",
"description": "Functional Skills assessment date",
"format": "date-time"
},
"result": {
"title": "Nullable`1",
"maximum": 100,
"minimum": 0,
"type": "number",
"description": "Functional Skills assessment result",
"format": "double",
"nullable": true,
"example": 50
}
},
"additionalProperties": false
},
"Business.Core.Api.ViewModels.Generic.FunctionalSkillsViewModel": {
"title": "FunctionalSkillsViewModel",
"type": "object",
"properties": {
"items": {
"title": "List`1",
"type": "array",
"items": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.FunctionalSkillsViewModelItem"
},
"nullable": true
}
},
"additionalProperties": false
},
"Business.Core.Api.ViewModels.Generic.FunctionalSkillsViewModelItem": {
"title": "FunctionalSkillsViewModelItem",
"type": "object",
"properties": {
"id": {
"title": "String",
"type": "string",
"nullable": true
},
"type": {
"title": "String",
"type": "string",
"nullable": true
},
"subject": {
"title": "String",
"type": "string",
"nullable": true
},
"level": {
"title": "String",
"type": "string",
"nullable": true
},
"date": {
"title": "Nullable`1",
"type": "string",
"format": "date-time",
"nullable": true
},
"result": {
"title": "Nullable`1",
"type": "number",
"format": "double",
"nullable": true
}
},
"additionalProperties": false
},
"Business.Core.Api.ViewModels.Generic.OfficerViewModelItem": {
"title": "OfficerViewModelItem",
"type": "object",
"properties": {
"relationshipID": {
"title": "String",
"type": "string",
"description": "Officer's relationship ID",
"nullable": true
},
"relationshipType": {
"title": "String",
"type": "string",
"description": "Officer's relationship type",
"nullable": true
},
"relationshipTitle": {
"title": "String",
"type": "string",
"description": "Officer's relationship title",
"nullable": true
},
"officer": {
"title": "String",
"type": "string",
"description": "Officer's code",
"nullable": true
}
},
"additionalProperties": false,
"description": "Represents a view model item for an officer entity relationship"
},
"Business.Core.Api.ViewModels.Generic.OfficersViewModel": {
"title": "OfficersViewModel",
"type": "object",
"properties": {
"items": {
"title": "List`1",
"type": "array",
"items": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.OfficerViewModelItem"
},
"description": "List of officer items",
"nullable": true
}
},
"additionalProperties": false
},
"Business.Core.Api.ViewModels.Generic.ParticipantViewModel": {
"title": "ParticipantViewModel",
"type": "object",
"properties": {
"eventID": {
"title": "Int32",
"type": "integer",
"description": "Event ID",
"format": "int32"
},
"id": {
"title": "String",
"type": "string",
"description": "The Participant's ID",
"nullable": true
},
"type": {
"title": "String",
"type": "string",
"description": "The Type of Participant",
"nullable": true
},
"roles": {
"title": "List`1",
"type": "array",
"items": {
"title": "String",
"type": "string"
},
"description": "The Roles assigned to the Participant for the Appointment",
"nullable": true
}
},
"additionalProperties": false
},
"Business.Core.Api.ViewModels.Generic.PhotoViewModel": {
"title": "PhotoViewModel",
"type": "object",
"properties": {
"id": {
"title": "String",
"type": "string",
"description": "ID of the entity",
"nullable": true
},
"hasPhoto": {
"title": "Boolean",
"type": "boolean",
"description": "Indicates if a photo was found"
},
"encodedPhoto": {
"title": "String",
"type": "string",
"description": "Base64 encoding of the photo",
"nullable": true
}
},
"additionalProperties": false
},
"Business.Core.Api.ViewModels.Generic.SearchResultsViewModel`1[[Business.Core.Api.ViewModels.Applicants.SearchResultItemViewModel, Business, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"title": "SearchResultsViewModel`1",
"type": "object",
"properties": {
"items": {
"title": "List`1",
"type": "array",
"items": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Applicants.SearchResultItemViewModel"
},
"description": "The list of requested items",
"nullable": true
},
"currentPage": {
"title": "Int32",
"type": "integer",
"description": "The page number currently being displayed",
"format": "int32"
}
},
"additionalProperties": false
},
"Business.Core.Api.ViewModels.Generic.SearchResultsViewModel`1[[Business.Core.Api.ViewModels.Appointments.SearchResultItemViewModel, Business, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"title": "SearchResultsViewModel`1",
"type": "object",
"properties": {
"items": {
"title": "List`1",
"type": "array",
"items": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Appointments.SearchResultItemViewModel"
},
"description": "The list of requested items",
"nullable": true
},
"currentPage": {
"title": "Int32",
"type": "integer",
"description": "The page number currently being displayed",
"format": "int32"
}
},
"additionalProperties": false
},
"Business.Core.Api.ViewModels.Generic.SearchResultsViewModel`1[[Business.Core.Api.ViewModels.Learners.SearchResultsItemViewModel, Business, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"title": "SearchResultsViewModel`1",
"type": "object",
"properties": {
"items": {
"title": "List`1",
"type": "array",
"items": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Learners.SearchResultsItemViewModel"
},
"description": "The list of requested items",
"nullable": true
},
"currentPage": {
"title": "Int32",
"type": "integer",
"description": "The page number currently being displayed",
"format": "int32"
}
},
"additionalProperties": false
},
"Business.Core.Api.ViewModels.Generic.SearchResultsViewModel`1[[Business.Core.Api.ViewModels.Officers.SummaryViewModel, Business, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"title": "SearchResultsViewModel`1",
"type": "object",
"properties": {
"items": {
"title": "List`1",
"type": "array",
"items": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Officers.SummaryViewModel"
},
"description": "The list of requested items",
"nullable": true
},
"currentPage": {
"title": "Int32",
"type": "integer",
"description": "The page number currently being displayed",
"format": "int32"
}
},
"additionalProperties": false
},
"Business.Core.Api.ViewModels.Generic.SearchResultsViewModel`1[[Business.Core.Api.ViewModels.Organisations.SummaryViewModel, Business, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"title": "SearchResultsViewModel`1",
"type": "object",
"properties": {
"items": {
"title": "List`1",
"type": "array",
"items": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Organisations.SummaryViewModel"
},
"description": "The list of requested items",
"nullable": true
},
"currentPage": {
"title": "Int32",
"type": "integer",
"description": "The page number currently being displayed",
"format": "int32"
}
},
"additionalProperties": false
},
"Business.Core.Api.ViewModels.Generic.SearchResultsViewModel`1[[Business.Core.Api.ViewModels.Payments.SummaryViewModel, Business, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"title": "SearchResultsViewModel`1",
"type": "object",
"properties": {
"items": {
"title": "List`1",
"type": "array",
"items": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Payments.SummaryViewModel"
},
"description": "The list of requested items",
"nullable": true
},
"currentPage": {
"title": "Int32",
"type": "integer",
"description": "The page number currently being displayed",
"format": "int32"
}
},
"additionalProperties": false
},
"Business.Core.Api.ViewModels.Generic.SearchResultsViewModel`1[[Business.Core.Api.ViewModels.Tasks.SearchResultItemViewModel, Business, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"title": "SearchResultsViewModel`1",
"type": "object",
"properties": {
"items": {
"title": "List`1",
"type": "array",
"items": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Tasks.SearchResultItemViewModel"
},
"description": "The list of requested items",
"nullable": true
},
"currentPage": {
"title": "Int32",
"type": "integer",
"description": "The page number currently being displayed",
"format": "int32"
}
},
"additionalProperties": false
},
"Business.Core.Api.ViewModels.Generic.StatusViewModel": {
"title": "StatusViewModel",
"type": "object",
"properties": {
"description": {
"title": "String",
"type": "string",
"description": "Status description",
"nullable": true
},
"subStatuses": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string",
"nullable": true
},
"description": "Key value pair list of sub statuses for this status",
"nullable": true
}
},
"additionalProperties": false,
"description": "Represents a workflow status"
},
"Business.Core.Api.ViewModels.Generic.StatusesViewModel": {
"title": "StatusesViewModel",
"type": "object",
"properties": {
"statuses": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.StatusViewModel"
},
"description": "List of Statuses",
"nullable": true
}
},
"additionalProperties": false,
"description": "Represent a list of workflow statuses"
},
"Business.Core.Api.ViewModels.Generic.TagViewModelItem": {
"title": "TagViewModelItem",
"type": "object",
"properties": {
"id": {
"title": "String",
"type": "string",
"description": "Tag ID",
"nullable": true
},
"description": {
"title": "String",
"type": "string",
"description": "Tag Description",
"nullable": true
}
},
"additionalProperties": false
},
"Business.Core.Api.ViewModels.Generic.TagsViewModel": {
"title": "TagsViewModel",
"type": "object",
"properties": {
"items": {
"title": "List`1",
"type": "array",
"items": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.TagViewModelItem"
},
"description": "List of Tag items",
"nullable": true
}
},
"additionalProperties": false,
"description": "Represents a list of tags"
},
"Business.Core.Api.ViewModels.Generic.UdfAnswersViewModel": {
"title": "UdfAnswersViewModel",
"type": "object",
"properties": {
"udfAnswers": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string",
"nullable": true
},
"description": "List of UDF Answer key value pairs",
"nullable": true
}
},
"additionalProperties": false,
"description": "Represents a list of user defined form answers"
},
"Business.Core.Api.ViewModels.Generic.UdfQuestionsViewModel": {
"title": "UdfQuestionsViewModel",
"type": "object",
"properties": {
"items": {
"title": "List`1",
"type": "array",
"items": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.UdfQuestionsViewModelItem"
},
"description": "List of UDF Question key value pairs",
"nullable": true
}
},
"additionalProperties": false,
"description": "Represents a list of user defined form questions"
},
"Business.Core.Api.ViewModels.Generic.UdfQuestionsViewModelItem": {
"title": "UdfQuestionsViewModelItem",
"type": "object",
"properties": {
"apiCode": {
"title": "String",
"type": "string",
"nullable": true
},
"question": {
"title": "String",
"type": "string",
"nullable": true
},
"availableAnswers": {
"title": "Dictionary`2",
"type": "object",
"additionalProperties": {
"title": "String",
"type": "string",
"nullable": true
},
"nullable": true
}
},
"additionalProperties": false
},
"Business.Core.Api.ViewModels.Imports.AddImportFieldViewModel": {
"title": "AddImportFieldViewModel",
"type": "object",
"properties": {
"fieldName": {
"title": "String",
"type": "string",
"description": "Field name",
"nullable": true
},
"fieldValue": {
"title": "String",
"type": "string",
"description": "Fields value",
"nullable": true
}
},
"additionalProperties": false,
"description": "Represents a view model for a single field to be added via an import"
},
"Business.Core.Api.ViewModels.Imports.AddImportViewModel": {
"title": "AddImportViewModel",
"type": "object",
"properties": {
"importType": {
"title": "ImportType",
"enum": [
"Learner",
"Applicant",
"Organisation"
],
"type": "string",
"description": "The import type"
},
"fields": {
"title": "List`1",
"type": "array",
"items": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Imports.AddImportFieldViewModel"
},
"description": "List of field names and values",
"nullable": true
}
},
"additionalProperties": false,
"description": "Represents a view model for adding an import"
},
"Business.Core.Api.ViewModels.Learners.AddComponentViewModel": {
"title": "AddComponentViewModel",
"required": [
"componentID"
],
"type": "object",
"properties": {
"componentID": {
"title": "String",
"minLength": 1,
"type": "string",
"description": "Component ID"
}
},
"additionalProperties": false
},
"Business.Core.Api.ViewModels.Learners.AvailableComponentsViewModel": {
"title": "AvailableComponentsViewModel",
"type": "object",
"properties": {
"id": {
"title": "String",
"type": "string",
"description": "ID of the available component.",
"nullable": true
},
"stageCode": {
"title": "String",
"type": "string",
"description": "Code for the stage of the available component.",
"nullable": true
},
"stageDescription": {
"title": "String",
"type": "string",
"description": "Description of the stage of the available component.",
"nullable": true
},
"typeCode": {
"title": "String",
"type": "string",
"description": "Code for the type of the available component.",
"nullable": true
},
"typeDescription": {
"title": "String",
"type": "string",
"description": "Description of the type of the available component.",
"nullable": true
},
"title": {
"title": "String",
"type": "string",
"description": "Title of the available component.",
"nullable": true
},
"when": {
"title": "String",
"type": "string",
"description": "Information about when the available component is scheduled.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Represents a view model for available components."
},
"Business.Core.Api.ViewModels.Learners.ComponentsViewModel": {
"title": "ComponentsViewModel",
"type": "object",
"properties": {
"items": {
"title": "List`1",
"type": "array",
"items": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Learners.ComponentsViewModelItem"
},
"description": "List of Component items",
"nullable": true
}
},
"additionalProperties": false
},
"Business.Core.Api.ViewModels.Learners.ComponentsViewModelItem": {
"title": "ComponentsViewModelItem",
"type": "object",
"properties": {
"id": {
"title": "String",
"type": "string",
"description": "ID of the component.",
"nullable": true
},
"stage": {
"title": "String",
"type": "string",
"description": "Stage of the component.",
"nullable": true
},
"type": {
"title": "String",
"type": "string",
"description": "Type of the component.",
"nullable": true
},
"typeDescription": {
"title": "String",
"type": "string",
"description": "Description of the component type.",
"nullable": true
},
"title": {
"title": "String",
"type": "string",
"description": "Title of the component.",
"nullable": true
},
"mandatory": {
"title": "Boolean",
"type": "boolean",
"description": "Indicates whether the component is mandatory."
},
"status": {
"title": "String",
"type": "string",
"description": "Status of the component.",
"nullable": true
},
"linkType": {
"title": "String",
"type": "string",
"description": "Type of link associated with the component.",
"nullable": true
},
"linkID": {
"title": "String",
"type": "string",
"description": "ID of the linked component.",
"nullable": true
},
"start": {
"title": "Nullable`1",
"type": "string",
"description": "Start date of the component.",
"format": "date-time",
"nullable": true
},
"due": {
"title": "Nullable`1",
"type": "string",
"description": "Due date of the component.",
"format": "date-time",
"nullable": true
},
"done": {
"title": "Nullable`1",
"type": "string",
"description": "Completion date of the component.",
"format": "date-time",
"nullable": true
},
"priorityFlag": {
"title": "Nullable`1",
"type": "integer",
"description": "Priority flag of the component.",
"format": "int32",
"nullable": true
},
"scopes": {
"title": "List`1",
"type": "array",
"items": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Learners.ScopeViewModelItem"
},
"description": "List of scope view models associated with the component.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Represents a view model for components."
},
"Business.Core.Api.ViewModels.Learners.ContactAndLearningHourTotalsViewModel": {
"title": "ContactAndLearningHourTotalsViewModel",
"type": "object",
"properties": {
"contact": {
"title": "Nullable`1",
"type": "string",
"description": "Total contact hours",
"format": "date-span",
"nullable": true
},
"offTheJob": {
"title": "Nullable`1",
"type": "string",
"description": "Total off the job hours",
"format": "date-span",
"nullable": true
},
"plannedOffTheJob": {
"title": "Nullable`1",
"type": "integer",
"description": "ILR Planned Off the Job Hours",
"format": "int32",
"nullable": true
},
"plannedOffTheJobToDate": {
"title": "Nullable`1",
"type": "integer",
"description": "ILR Planned Off the Job Hours to Date",
"format": "int32",
"nullable": true
},
"averageWeeklyOffTheJob": {
"title": "Nullable`1",
"type": "integer",
"description": "Average Weekly Off the Job Hours",
"format": "int32",
"nullable": true
},
"saRequiredOffJob": {
"title": "Nullable`1",
"type": "integer",
"description": "Required Off the Job Hours from Smart Assessor",
"format": "int32",
"nullable": true
},
"saActualOffJob": {
"title": "Nullable`1",
"type": "integer",
"description": "Actual Off the Job Hours from Smart Assessor",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false,
"description": "View model for contact and learning hour totals"
},
"Business.Core.Api.ViewModels.Learners.ContactAndLearningHoursViewModel": {
"title": "ContactAndLearningHoursViewModel",
"type": "object",
"properties": {
"items": {
"title": "List`1",
"type": "array",
"items": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Learners.ContactAndLearningHoursViewModelItem"
},
"description": "List of Contact and Learning Hour items",
"nullable": true
}
},
"additionalProperties": false,
"description": "View model for Contact and learning Hour records"
},
"Business.Core.Api.ViewModels.Learners.ContactAndLearningHoursViewModelItem": {
"title": "ContactAndLearningHoursViewModelItem",
"type": "object",
"properties": {
"id": {
"title": "String",
"type": "string",
"description": "Record ID",
"nullable": true
},
"date": {
"title": "Nullable`1",
"type": "string",
"description": "Contact Hours Date",
"format": "date-time",
"nullable": true
},
"time": {
"title": "String",
"type": "string",
"description": "Contact Hours Time",
"nullable": true
},
"timeSpanCode": {
"title": "String",
"type": "string",
"description": "Time Span Code",
"nullable": true
},
"timeSpanDescription": {
"title": "String",
"type": "string",
"description": "Time Span Description",
"nullable": true
},
"planned": {
"title": "Nullable`1",
"type": "string",
"description": "Planned Time Allocation",
"format": "date-span",
"nullable": true
},
"actual": {
"title": "Nullable`1",
"type": "string",
"description": "Actual Time Allocation",
"format": "date-span",
"nullable": true
},
"contactTypeCode": {
"title": "String",
"type": "string",
"description": "Contact Type Code",
"nullable": true
},
"contactTypeDescription": {
"title": "String",
"type": "string",
"description": "Contact Type Description",
"nullable": true
},
"isOffTheJob": {
"title": "Boolean",
"type": "boolean",
"description": "Indicates if the Contact and Learning hours are \"Off the Job\" or not."
},
"notes": {
"title": "String",
"type": "string",
"description": "Notes",
"nullable": true
},
"qualificationCode": {
"title": "String",
"type": "string",
"description": "Qualification Code",
"nullable": true
},
"qualificationTitle": {
"title": "String",
"type": "string",
"description": "Qualification Description",
"nullable": true
},
"locationCode": {
"title": "String",
"type": "string",
"description": "Location Code",
"nullable": true
},
"officerCode": {
"title": "String",
"type": "string",
"description": "Officer Code",
"nullable": true
},
"approved": {
"title": "Boolean",
"type": "boolean",
"description": "Indicates the approved status of the record"
}
},
"additionalProperties": false
},
"Business.Core.Api.ViewModels.Learners.DetailsViewModel": {
"title": "DetailsViewModel",
"type": "object",
"properties": {
"id": {
"title": "String",
"type": "string",
"nullable": true
},
"picsSystemID": {
"title": "String",
"type": "string",
"nullable": true
},
"originalApplicantID": {
"title": "String",
"type": "string",
"nullable": true
},
"title": {
"title": "String",
"type": "string",
"nullable": true
},
"firstNames": {
"title": "String",
"type": "string",
"nullable": true
},
"preferredFirstName": {
"title": "String",
"type": "string",
"nullable": true
},
"surname": {
"title": "String",
"type": "string",
"nullable": true
},
"email": {
"title": "String",
"type": "string",
"nullable": true
},
"risk": {
"title": "String",
"type": "string",
"nullable": true
},
"address": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.AddressViewModel"
},
"ward": {
"title": "String",
"type": "string",
"nullable": true
},
"homePhone": {
"title": "String",
"type": "string",
"nullable": true
},
"mobile": {
"title": "String",
"type": "string",
"nullable": true
},
"username": {
"title": "String",
"type": "string",
"nullable": true
},
"userID": {
"title": "String",
"type": "string",
"nullable": true
},
"lastLogin": {
"title": "Nullable`1",
"type": "string",
"format": "date-time",
"nullable": true
},
"allowedContactMethods": {
"title": "List`1",
"type": "array",
"items": {
"title": "String",
"type": "string"
},
"nullable": true
},
"preferredContactMethod": {
"title": "String",
"type": "string",
"nullable": true
},
"dateOfBirth": {
"title": "Nullable`1",
"type": "string",
"format": "date-time",
"nullable": true
},
"currentAge": {
"title": "String",
"type": "string",
"nullable": true
},
"sex": {
"title": "String",
"type": "string",
"nullable": true
},
"ethnicity": {
"title": "String",
"type": "string",
"nullable": true
},
"niNumber": {
"title": "String",
"type": "string",
"nullable": true
},
"learnerReferenceNumber": {
"title": "String",
"type": "string",
"nullable": true
},
"ilrDisability": {
"title": "String",
"type": "string",
"nullable": true
},
"lldDs": {
"title": "List`1",
"type": "array",
"items": {
"title": "String",
"type": "string"
},
"nullable": true
},
"primaryLLDD": {
"title": "String",
"type": "string",
"nullable": true
},
"householdSituation": {
"title": "List`1",
"type": "array",
"items": {
"title": "String",
"type": "string"
},
"nullable": true
},
"nextOfKinName": {
"title": "String",
"type": "string",
"nullable": true
},
"nextOfKinRelationship": {
"title": "String",
"type": "string",
"nullable": true
},
"nextOfKinPhone": {
"title": "String",
"type": "string",
"nullable": true
},
"nextOfKinPhone2": {
"title": "String",
"type": "string",
"nullable": true
},
"nextOfKinEmail": {
"title": "String",
"type": "string",
"nullable": true
},
"otherSystemID": {
"title": "String",
"type": "string",
"nullable": true
},
"hasDrivingLicence": {
"title": "String",
"type": "string",
"nullable": true
},
"hasOwnTransport": {
"title": "String",
"type": "string",
"nullable": true
},
"providerIdent": {
"title": "String",
"type": "string",
"nullable": true
},
"uln": {
"title": "String",
"type": "string",
"nullable": true
},
"group": {
"title": "String",
"type": "string",
"nullable": true
},
"subGroup": {
"title": "String",
"type": "string",
"nullable": true
},
"mainAimReference": {
"title": "String",
"type": "string",
"nullable": true
},
"currentPlacement": {
"title": "String",
"type": "string",
"nullable": true
},
"site": {
"title": "String",
"type": "string",
"nullable": true
},
"qualificationPlan": {
"title": "String",
"type": "string",
"nullable": true
},
"providerEndCode": {
"title": "String",
"type": "string",
"nullable": true
},
"systemStatus": {
"title": "String",
"type": "string",
"nullable": true
},
"trainingStart": {
"title": "Nullable`1",
"type": "string",
"format": "date-time",
"nullable": true
},
"trainingEnd": {
"title": "Nullable`1",
"type": "string",
"format": "date-time",
"nullable": true
},
"trainingExpectedEnd": {
"title": "Nullable`1",
"type": "string",
"format": "date-time",
"nullable": true
},
"onBreakInLearning": {
"title": "Nullable`1",
"type": "boolean",
"nullable": true
},
"breakInLearningStart": {
"title": "Nullable`1",
"type": "string",
"format": "date-time",
"nullable": true
},
"breakInLearningEnd": {
"title": "Nullable`1",
"type": "string",
"format": "date-time",
"nullable": true
},
"mainOfficer": {
"title": "String",
"type": "string",
"nullable": true
},
"careersOfficer": {
"title": "String",
"type": "string",
"nullable": true
},
"trainingOfficer": {
"title": "String",
"type": "string",
"nullable": true
},
"placementOfficer": {
"title": "String",
"type": "string",
"nullable": true
},
"mentorOfficer": {
"title": "String",
"type": "string",
"nullable": true
},
"updatedOn": {
"title": "Nullable`1",
"type": "string",
"format": "date-time",
"nullable": true
},
"createdOn": {
"title": "Nullable`1",
"type": "string",
"format": "date-time",
"nullable": true
},
"workflow": {
"title": "String",
"type": "string",
"nullable": true
},
"workflowStatus": {
"title": "String",
"type": "string",
"nullable": true
},
"workflowSubStatus": {
"title": "String",
"type": "string",
"nullable": true
},
"learningExpectedEndDate": {
"title": "Nullable`1",
"type": "string",
"format": "date-time",
"nullable": true
},
"standardCode": {
"title": "String",
"type": "string",
"nullable": true
},
"standardName": {
"title": "String",
"type": "string",
"nullable": true
},
"standardLevel": {
"title": "String",
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Business.Core.Api.ViewModels.Learners.EditComponentViewModel": {
"title": "EditComponentViewModel",
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"title": "String",
"minLength": 1,
"type": "string",
"description": "Component ID"
},
"start": {
"title": "Nullable`1",
"type": "string",
"description": "Start Date",
"format": "date-time",
"nullable": true
},
"priorityFlag": {
"title": "Nullable`1",
"type": "integer",
"description": "Priority Flag",
"format": "int32",
"nullable": true
},
"due": {
"title": "Nullable`1",
"type": "string",
"description": "Due Date",
"format": "date-time",
"nullable": true
},
"done": {
"title": "Nullable`1",
"type": "string",
"description": "Done Date",
"format": "date-time",
"nullable": true
},
"notes": {
"title": "String",
"type": "string",
"description": "Notes",
"nullable": true
},
"linkId": {
"title": "String",
"type": "string",
"description": "Used to link a task to a component",
"nullable": true
}
},
"additionalProperties": false,
"description": "Represents a view model for editing components"
},
"Business.Core.Api.ViewModels.Learners.EditViewModel": {
"title": "EditViewModel",
"required": [
"firstNames",
"id",
"sex",
"surname"
],
"type": "object",
"properties": {
"id": {
"title": "String",
"minLength": 1,
"type": "string",
"description": "Required. Learner's identifier"
},
"title": {
"title": "String",
"type": "string",
"description": "Learner's title",
"nullable": true
},
"firstNames": {
"title": "String",
"minLength": 1,
"type": "string",
"description": "Required. Learner's first names"
},
"preferredFirstName": {
"title": "String",
"maxLength": 30,
"type": "string",
"description": "Maximum length: 30. Learner's preferred first name",
"nullable": true
},
"surname": {
"title": "String",
"minLength": 1,
"type": "string",
"description": "Required. Learner's surname"
},
"email": {
"title": "String",
"type": "string",
"description": "Learner's email address",
"nullable": true
},
"risk": {
"title": "String",
"type": "string",
"description": "Learner's risk information",
"nullable": true
},
"address": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.AddressViewModel"
},
"ward": {
"title": "String",
"type": "string",
"description": "Learner's ward",
"nullable": true
},
"homePhone": {
"title": "String",
"type": "string",
"description": "Learner's home phone number",
"nullable": true
},
"mobile": {
"title": "String",
"type": "string",
"description": "Learner's mobile phone number",
"format": "tel",
"nullable": true
},
"username": {
"title": "String",
"type": "string",
"description": "Learner's username",
"nullable": true
},
"userID": {
"title": "String",
"type": "string",
"description": "Learner's user ID",
"nullable": true
},
"allowedContactMethods": {
"title": "List`1",
"type": "array",
"items": {
"title": "String",
"type": "string"
},
"description": "List of allowed contact methods for the learner",
"nullable": true
},
"preferredContactMethod": {
"title": "String",
"type": "string",
"description": "Preferred contact method for the learner",
"nullable": true
},
"dateOfBirth": {
"title": "Nullable`1",
"type": "string",
"description": "Learner's date of birth",
"format": "date-time",
"nullable": true
},
"sex": {
"title": "String",
"minLength": 1,
"type": "string",
"description": "Required. Learner's sex"
},
"ethnicity": {
"title": "String",
"type": "string",
"description": "Learner's ethnicity",
"nullable": true
},
"niNumber": {
"title": "String",
"type": "string",
"description": "Learner's National Insurance Number",
"nullable": true
},
"ilrDisability": {
"title": "String",
"type": "string",
"description": "Learner's Individual Learning Record (ILR) disability information",
"nullable": true
},
"lldDs": {
"title": "List`1",
"type": "array",
"items": {
"title": "String",
"type": "string"
},
"description": "List of Learning Difficulties and/or Disabilities (LLDDs) for the learner",
"nullable": true
},
"primaryLLDD": {
"title": "String",
"type": "string",
"description": "Learner's primary LLDD",
"nullable": true
},
"nextOfKinName": {
"title": "String",
"type": "string",
"description": "Name of the next of kin for the learner",
"nullable": true
},
"nextOfKinRelationship": {
"title": "String",
"type": "string",
"description": "Relationship with the next of kin for the learner",
"nullable": true
},
"nextOfKinPhone": {
"title": "String",
"type": "string",
"description": "Phone number of the next of kin for the learner",
"nullable": true
},
"nextOfKinPhone2": {
"title": "String",
"type": "string",
"description": "Second phone number of the next of kin for the learner",
"nullable": true
},
"nextOfKinEmail": {
"title": "String",
"type": "string",
"description": "Email address of the next of kin for the learner",
"nullable": true
},
"otherSystemID": {
"title": "String",
"type": "string",
"description": "ID from another system for the learner",
"nullable": true
},
"providerIdent": {
"title": "String",
"type": "string",
"description": "Provider identifier for the learner",
"nullable": true
},
"mainOfficer": {
"title": "String",
"type": "string",
"description": "Main officer assigned to the learner",
"nullable": true
},
"recruitmentOfficer": {
"title": "String",
"type": "string",
"description": "Recruitment officer assigned to the learner",
"nullable": true
},
"mentorOfficer": {
"title": "String",
"type": "string",
"description": "Mentor officer assigned to the learner",
"nullable": true
},
"plannedStart": {
"title": "Nullable`1",
"type": "string",
"description": "Planned start date for the learner",
"format": "date-time",
"nullable": true
},
"expectedEnd": {
"title": "Nullable`1",
"type": "string",
"description": "Expected end date for the learner",
"format": "date-time",
"nullable": true
},
"countryOfDomicile": {
"title": "String",
"type": "string",
"description": "Country of domicile for the learner",
"nullable": true
},
"site": {
"title": "String",
"type": "string",
"description": "Site information for the learner",
"nullable": true
},
"uln": {
"title": "String",
"type": "string",
"description": "Unique Learner Number (ULN) for the learner",
"nullable": true
},
"restrictedUseIndicator": {
"title": "String",
"type": "string",
"description": "Restricted use indicator for the learner",
"nullable": true
},
"gcseMath": {
"title": "String",
"type": "string",
"description": "GCSE Math qualification status for the learner",
"nullable": true
},
"gcseEnglish": {
"title": "String",
"type": "string",
"description": "GCSE English qualification status for the learner",
"nullable": true
},
"qualificationPlan": {
"title": "String",
"type": "string",
"description": "Qualification plan for the learner",
"nullable": true
}
},
"additionalProperties": false,
"description": "Represents a view model for editing Learner information"
},
"Business.Core.Api.ViewModels.Learners.PlacementsViewModel": {
"title": "PlacementsViewModel",
"type": "object",
"properties": {
"items": {
"title": "List`1",
"type": "array",
"items": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Learners.PlacementsViewModelItem"
},
"description": "List of Placement items",
"nullable": true
}
},
"additionalProperties": false
},
"Business.Core.Api.ViewModels.Learners.PlacementsViewModelItem": {
"title": "PlacementsViewModelItem",
"type": "object",
"properties": {
"organisationId": {
"title": "String",
"type": "string",
"description": "The ID of the placement organisation",
"nullable": true
},
"organisationName": {
"title": "String",
"type": "string",
"description": "The name of the placement organisation",
"nullable": true
},
"type": {
"title": "String",
"type": "string",
"description": "The type of the placement",
"nullable": true
},
"start": {
"title": "Nullable`1",
"type": "string",
"description": "The start date of the placement\r\nNot applicable to custom relationship placements",
"format": "date-time",
"nullable": true
},
"expectedEnd": {
"title": "Nullable`1",
"type": "string",
"description": "The expected end date of the placement\r\nNot applicable to ILR Employer placements or custom relationship placements",
"format": "date-time",
"nullable": true
},
"end": {
"title": "Nullable`1",
"type": "string",
"description": "The actual end date of the placement\r\nNot applicable to ILR Employer placements or custom relationship placements",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false,
"description": "Represents a view model for placements"
},
"Business.Core.Api.ViewModels.Learners.QualificationsViewModel": {
"title": "QualificationsViewModel",
"type": "object",
"properties": {
"items": {
"title": "List`1",
"type": "array",
"items": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Learners.QualificationsViewModelItem"
},
"description": "List of Qualification items",
"nullable": true
}
},
"additionalProperties": false
},
"Business.Core.Api.ViewModels.Learners.QualificationsViewModelItem": {
"title": "QualificationsViewModelItem",
"type": "object",
"properties": {
"aimReference": {
"title": "String",
"type": "string",
"description": "Aim reference for the qualification.",
"nullable": true
},
"title": {
"title": "String",
"type": "string",
"description": "Title of the qualification.",
"nullable": true
},
"level": {
"title": "String",
"type": "string",
"description": "Level of the qualification.",
"nullable": true
},
"awardingBody": {
"title": "String",
"type": "string",
"description": "Awarding body of the qualification.",
"nullable": true
},
"status": {
"title": "String",
"type": "string",
"description": "Status of the qualification.",
"nullable": true
},
"registrationNumber": {
"title": "String",
"type": "string",
"description": "Registration number for the qualification.",
"nullable": true
},
"registrationPackNumber": {
"title": "String",
"type": "string",
"description": "Registration pack number for the qualification.",
"nullable": true
},
"registrationPONumber": {
"title": "String",
"type": "string",
"description": "Registration PO number for the qualification.",
"nullable": true
},
"certificateNumber": {
"title": "String",
"type": "string",
"description": "Certificate number for the qualification.",
"nullable": true
},
"certificateSentTo": {
"title": "String",
"type": "string",
"description": "Recipient of the certificate for the qualification.",
"nullable": true
},
"certificatePostingDetails": {
"title": "String",
"type": "string",
"description": "Posting details of the certificate for the qualification.",
"nullable": true
},
"assessor": {
"title": "String",
"type": "string",
"description": "Assessor for the qualification.",
"nullable": true
},
"internalVerifier": {
"title": "String",
"type": "string",
"description": "Internal verifier for the qualification.",
"nullable": true
},
"externalVerifier": {
"title": "String",
"type": "string",
"description": "External verifier for the qualification.",
"nullable": true
},
"ivCompleter": {
"title": "String",
"type": "string",
"description": "Internal verifier completer for the qualification.",
"nullable": true
},
"evCompleter": {
"title": "String",
"type": "string",
"description": "External verifier completer for the qualification.",
"nullable": true
},
"recGUID": {
"title": "String",
"type": "string",
"description": "Unique identifier for the qualification record.",
"nullable": true
},
"certificateWeight": {
"title": "Nullable`1",
"type": "integer",
"description": "Weight of the certificate for the qualification.",
"format": "int32",
"nullable": true
},
"totalElements": {
"title": "Nullable`1",
"type": "integer",
"description": "Total number of elements in the qualification.",
"format": "int32",
"nullable": true
},
"elementsDone": {
"title": "Nullable`1",
"type": "integer",
"description": "Number of elements completed in the qualification.",
"format": "int32",
"nullable": true
},
"percentAchieved": {
"title": "Nullable`1",
"type": "integer",
"description": "Percentage achieved in the qualification.",
"format": "int32",
"nullable": true
},
"guidedLearningHours": {
"title": "Nullable`1",
"type": "integer",
"description": "Guided learning hours for the qualification.",
"format": "int32",
"nullable": true
},
"startDate": {
"title": "Nullable`1",
"type": "string",
"description": "Start date of the qualification.",
"format": "date-time",
"nullable": true
},
"expectedEndDate": {
"title": "Nullable`1",
"type": "string",
"description": "Expected end date of the qualification.",
"format": "date-time",
"nullable": true
},
"endDate": {
"title": "Nullable`1",
"type": "string",
"description": "Actual end date of the qualification.",
"format": "date-time",
"nullable": true
},
"achievedDate": {
"title": "Nullable`1",
"type": "string",
"description": "Date when the qualification was achieved.",
"format": "date-time",
"nullable": true
},
"claimDate": {
"title": "Nullable`1",
"type": "string",
"description": "Date when the qualification was claimed.",
"format": "date-time",
"nullable": true
},
"enrolledDate": {
"title": "Nullable`1",
"type": "string",
"description": "Date when the qualification was enrolled.",
"format": "date-time",
"nullable": true
},
"registrationDate": {
"title": "Nullable`1",
"type": "string",
"description": "Date of registration for the qualification.",
"format": "date-time",
"nullable": true
},
"registrationExpiresDate": {
"title": "Nullable`1",
"type": "string",
"description": "Expiry date of the registration for the qualification.",
"format": "date-time",
"nullable": true
},
"certificateAppliedDate": {
"title": "Nullable`1",
"type": "string",
"description": "Date when the certificate application was submitted for the qualification.",
"format": "date-time",
"nullable": true
},
"certificateReceivedDate": {
"title": "Nullable`1",
"type": "string",
"description": "Date when the certificate was received for the qualification.",
"format": "date-time",
"nullable": true
},
"certificateSentOutDate": {
"title": "Nullable`1",
"type": "string",
"description": "Date when the certificate was sent out for the qualification.",
"format": "date-time",
"nullable": true
},
"ivCompleteDate": {
"title": "Nullable`1",
"type": "string",
"description": "Date when the internal verifier completed the qualification.",
"format": "date-time",
"nullable": true
},
"evCompleteDate": {
"title": "Nullable`1",
"type": "string",
"description": "Date when the external verifier completed the qualification.",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false,
"description": "Represents a view model for qualifications or educational achievements."
},
"Business.Core.Api.ViewModels.Learners.ScopeViewModelItem": {
"title": "ScopeViewModelItem",
"type": "object",
"properties": {
"id": {
"title": "String",
"type": "string",
"nullable": true
},
"type": {
"title": "String",
"type": "string",
"nullable": true
},
"typeDescription": {
"title": "String",
"type": "string",
"nullable": true
},
"title": {
"title": "String",
"type": "string",
"nullable": true
},
"code": {
"title": "String",
"type": "string",
"nullable": true
},
"sortOrder": {
"title": "String",
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Business.Core.Api.ViewModels.Learners.SearchResultsItemViewModel": {
"title": "SearchResultsItemViewModel",
"type": "object",
"properties": {
"id": {
"title": "String",
"type": "string",
"nullable": true
},
"picsSystemID": {
"title": "String",
"type": "string",
"nullable": true
},
"title": {
"title": "String",
"type": "string",
"nullable": true
},
"firstNames": {
"title": "String",
"type": "string",
"nullable": true
},
"preferredFirstName": {
"title": "String",
"type": "string",
"nullable": true
},
"surname": {
"title": "String",
"type": "string",
"nullable": true
},
"email": {
"title": "String",
"type": "string",
"nullable": true
},
"risk": {
"title": "String",
"type": "string",
"nullable": true
},
"address": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.AddressViewModel"
},
"ward": {
"title": "String",
"type": "string",
"nullable": true
},
"homePhone": {
"title": "String",
"type": "string",
"nullable": true
},
"mobile": {
"title": "String",
"type": "string",
"nullable": true
},
"username": {
"title": "String",
"type": "string",
"nullable": true
},
"lastLogin": {
"title": "Nullable`1",
"type": "string",
"format": "date-time",
"nullable": true
},
"allowedContactMethods": {
"title": "List`1",
"type": "array",
"items": {
"title": "String",
"type": "string"
},
"nullable": true
},
"preferredContactMethod": {
"title": "String",
"type": "string",
"nullable": true
},
"dateOfBirth": {
"title": "Nullable`1",
"type": "string",
"format": "date-time",
"nullable": true
},
"currentAge": {
"title": "String",
"type": "string",
"nullable": true
},
"sex": {
"title": "String",
"type": "string",
"nullable": true
},
"ethnicity": {
"title": "String",
"type": "string",
"nullable": true
},
"niNumber": {
"title": "String",
"type": "string",
"nullable": true
},
"learnerReferenceNumber": {
"title": "String",
"type": "string",
"nullable": true
},
"ilrDisability": {
"title": "String",
"type": "string",
"nullable": true
},
"lldDs": {
"title": "List`1",
"type": "array",
"items": {
"title": "String",
"type": "string"
},
"nullable": true
},
"primaryLLDD": {
"title": "String",
"type": "string",
"nullable": true
},
"nextOfKinName": {
"title": "String",
"type": "string",
"nullable": true
},
"nextOfKinRelationship": {
"title": "String",
"type": "string",
"nullable": true
},
"nextOfKinPhone": {
"title": "String",
"type": "string",
"nullable": true
},
"nextOfKinPhone2": {
"title": "String",
"type": "string",
"nullable": true
},
"nextOfKinEmail": {
"title": "String",
"type": "string",
"nullable": true
},
"otherSystemID": {
"title": "String",
"type": "string",
"nullable": true
},
"hasDrivingLicence": {
"title": "String",
"type": "string",
"nullable": true
},
"hasOwnTransport": {
"title": "String",
"type": "string",
"nullable": true
},
"providerIdent": {
"title": "String",
"type": "string",
"nullable": true
},
"uln": {
"title": "String",
"type": "string",
"nullable": true
},
"group": {
"title": "String",
"type": "string",
"nullable": true
},
"subGroup": {
"title": "String",
"type": "string",
"nullable": true
},
"systemStatus": {
"title": "String",
"type": "string",
"nullable": true
},
"mainAimReference": {
"title": "String",
"type": "string",
"nullable": true
},
"site": {
"title": "String",
"type": "string",
"nullable": true
},
"qualificationPlan": {
"title": "String",
"type": "string",
"nullable": true
},
"providerEndCode": {
"title": "String",
"type": "string",
"nullable": true
},
"trainingStart": {
"title": "Nullable`1",
"type": "string",
"format": "date-time",
"nullable": true
},
"trainingEnd": {
"title": "Nullable`1",
"type": "string",
"format": "date-time",
"nullable": true
},
"trainingExpectedEnd": {
"title": "Nullable`1",
"type": "string",
"format": "date-time",
"nullable": true
},
"mainOfficer": {
"title": "String",
"type": "string",
"nullable": true
},
"careersOfficer": {
"title": "String",
"type": "string",
"nullable": true
},
"trainingOfficer": {
"title": "String",
"type": "string",
"nullable": true
},
"placementOfficer": {
"title": "String",
"type": "string",
"nullable": true
},
"mentorOfficer": {
"title": "String",
"type": "string",
"nullable": true
},
"updatedOn": {
"title": "Nullable`1",
"type": "string",
"format": "date-time",
"nullable": true
},
"createdOn": {
"title": "Nullable`1",
"type": "string",
"format": "date-time",
"nullable": true
},
"workflow": {
"title": "String",
"type": "string",
"nullable": true
},
"workflowStatus": {
"title": "String",
"type": "string",
"nullable": true
},
"workflowSubStatus": {
"title": "String",
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Business.Core.Api.ViewModels.ListsAndTypes.CustomProvisionsViewModel": {
"title": "CustomProvisionsViewModel",
"type": "object",
"properties": {
"items": {
"title": "List`1",
"type": "array",
"items": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.ListsAndTypes.CustomProvisionsViewModelItem"
},
"description": "Collection of custom provision items",
"nullable": true
}
},
"additionalProperties": false
},
"Business.Core.Api.ViewModels.ListsAndTypes.CustomProvisionsViewModelItem": {
"title": "CustomProvisionsViewModelItem",
"type": "object",
"properties": {
"id": {
"title": "String",
"type": "string",
"description": "ID of the custom provision.",
"nullable": true
},
"type": {
"title": "String",
"type": "string",
"description": "Type of the custom provision.",
"nullable": true
},
"code": {
"title": "String",
"type": "string",
"description": "Code associated with the custom provision.",
"nullable": true
},
"description": {
"title": "String",
"type": "string",
"description": "Description of the custom provision.",
"nullable": true
},
"status": {
"title": "String",
"type": "string",
"description": "Status of the custom provision.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Represents a view model for custom provisions."
},
"Business.Core.Api.ViewModels.Officers.CreateViewModel": {
"title": "CreateViewModel",
"required": [
"firstNames",
"roles",
"surname"
],
"type": "object",
"properties": {
"firstNames": {
"title": "String",
"maxLength": 30,
"minLength": 1,
"type": "string",
"description": "Officer's first names"
},
"surname": {
"title": "String",
"maxLength": 30,
"minLength": 1,
"type": "string",
"description": "Officer's surname"
},
"email": {
"title": "String",
"maxLength": 100,
"type": "string",
"description": "Officer's email address",
"format": "email",
"nullable": true
},
"phone": {
"title": "String",
"maxLength": 30,
"type": "string",
"description": "Officer's phone number",
"format": "tel",
"nullable": true
},
"roles": {
"title": "List`1",
"type": "array",
"items": {
"title": "String",
"type": "string"
},
"description": "Officer's roles"
}
},
"additionalProperties": false
},
"Business.Core.Api.ViewModels.Officers.DetailsViewModel": {
"title": "DetailsViewModel",
"type": "object",
"properties": {
"id": {
"title": "String",
"type": "string",
"description": "ID associated with the detailed information.",
"nullable": true
},
"title": {
"title": "String",
"type": "string",
"description": "Title related to the detailed information.",
"nullable": true
},
"firstNames": {
"title": "String",
"type": "string",
"description": "First names associated with the detailed information.",
"nullable": true
},
"surname": {
"title": "String",
"type": "string",
"description": "Surname associated with the detailed information.",
"nullable": true
},
"jobTitle": {
"title": "String",
"type": "string",
"description": "Job title related to the detailed information.",
"nullable": true
},
"email": {
"title": "String",
"type": "string",
"description": "Email address associated with the detailed information.",
"nullable": true
},
"mainOrganisation": {
"title": "String",
"type": "string",
"description": "Main organization associated with the detailed information.",
"nullable": true
},
"roles": {
"title": "List`1",
"type": "array",
"items": {
"title": "String",
"type": "string"
},
"description": "List of roles associated with the detailed information.",
"nullable": true
},
"status": {
"title": "String",
"type": "string",
"description": "Status related to the detailed information.",
"nullable": true
},
"address": {
"title": "String",
"type": "string",
"description": "Address associated with the detailed information.",
"nullable": true
},
"postcode": {
"title": "String",
"type": "string",
"description": "Postcode associated with the detailed information.",
"nullable": true
},
"phone": {
"title": "String",
"type": "string",
"description": "Phone number associated with the detailed information.",
"nullable": true
},
"mobile": {
"title": "String",
"type": "string",
"description": "Mobile number associated with the detailed information.",
"nullable": true
},
"allowedContactMethods": {
"title": "List`1",
"type": "array",
"items": {
"title": "String",
"type": "string"
},
"description": "List of allowed contact methods associated with the detailed information.",
"nullable": true
},
"preferredContactMethod": {
"title": "String",
"type": "string",
"description": "Preferred contact method associated with the detailed information.",
"nullable": true
},
"sex": {
"title": "String",
"type": "string",
"description": "Sex associated with the detailed information.",
"nullable": true
},
"ethnicity": {
"title": "String",
"type": "string",
"description": "Ethnicity associated with the detailed information.",
"nullable": true
},
"additionalID": {
"title": "String",
"type": "string",
"description": "Additional ID associated with the detailed information.",
"nullable": true
},
"superior": {
"title": "String",
"type": "string",
"description": "Superior associated with the detailed information.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Represents a view model for detailed information."
},
"Business.Core.Api.ViewModels.Officers.EditViewModel": {
"title": "EditViewModel",
"required": [
"firstNames",
"id",
"roles",
"surname",
"systemStatus"
],
"type": "object",
"properties": {
"id": {
"title": "String",
"minLength": 1,
"type": "string",
"description": "The Officer's ID"
},
"title": {
"title": "String",
"maxLength": 5,
"type": "string",
"description": "The Officer's title code",
"nullable": true
},
"firstNames": {
"title": "String",
"maxLength": 30,
"minLength": 1,
"type": "string",
"description": "The Officer's first names"
},
"surname": {
"title": "String",
"maxLength": 30,
"minLength": 1,
"type": "string",
"description": "The Officer's surname"
},
"jobTitle": {
"title": "String",
"maxLength": 150,
"type": "string",
"description": "The Officer's job title",
"nullable": true
},
"email": {
"title": "String",
"maxLength": 100,
"type": "string",
"description": "The Officer's email address",
"format": "email",
"nullable": true
},
"roles": {
"title": "List`1",
"type": "array",
"items": {
"title": "String",
"type": "string"
},
"description": "The Officer's role codes"
},
"systemStatus": {
"title": "String",
"maxLength": 1,
"minLength": 1,
"type": "string",
"description": "The Officer's system status"
},
"address": {
"title": "String",
"maxLength": 180,
"type": "string",
"description": "The Officer's address",
"nullable": true
},
"postcode": {
"title": "String",
"type": "string",
"description": "The Officer's postcode",
"format": "postal-code",
"nullable": true
},
"phone": {
"title": "String",
"maxLength": 30,
"type": "string",
"description": "The Officer's phone number",
"format": "tel",
"nullable": true
},
"mobile": {
"title": "String",
"maxLength": 15,
"type": "string",
"description": "The Officer's mobile number",
"format": "tel",
"nullable": true
},
"allowedContactMethods": {
"title": "List`1",
"type": "array",
"items": {
"title": "String",
"type": "string"
},
"description": "The Officer's allowed contact methods",
"nullable": true
},
"preferredContactMethod": {
"title": "String",
"type": "string",
"description": "The officer's preferred contact method",
"nullable": true
},
"sex": {
"title": "String",
"maxLength": 1,
"type": "string",
"description": "The Officer's sex code",
"nullable": true
},
"ethnicity": {
"title": "String",
"maxLength": 2,
"type": "string",
"description": "The Officer's ethnicity",
"nullable": true
},
"additionalID": {
"title": "String",
"type": "string",
"description": "The Officer's additional ID",
"nullable": true
},
"superior": {
"title": "String",
"type": "string",
"description": "The Officer's superior code",
"nullable": true
}
},
"additionalProperties": false
},
"Business.Core.Api.ViewModels.Officers.SummaryViewModel": {
"title": "SummaryViewModel",
"type": "object",
"properties": {
"id": {
"title": "String",
"type": "string",
"description": "ID associated with the summary information.",
"nullable": true
},
"title": {
"title": "String",
"type": "string",
"description": "Title related to the summary information.",
"nullable": true
},
"name": {
"title": "String",
"type": "string",
"description": "Name associated with the summary information.",
"nullable": true
},
"jobTitle": {
"title": "String",
"type": "string",
"description": "Job title related to the summary information.",
"nullable": true
},
"email": {
"title": "String",
"type": "string",
"description": "Email address associated with the summary information.",
"nullable": true
},
"roles": {
"title": "List`1",
"type": "array",
"items": {
"title": "String",
"type": "string"
},
"description": "List of roles associated with the summary information.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Represents a view model for summary information."
},
"Business.Core.Api.ViewModels.Organisations.CreateViewModel": {
"title": "CreateViewModel",
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"title": "String",
"minLength": 1,
"type": "string",
"description": "Name of the organisation"
},
"alias": {
"title": "String",
"maxLength": 60,
"type": "string",
"description": "Alias of the organisation",
"nullable": true
},
"phone": {
"title": "String",
"maxLength": 25,
"type": "string",
"description": "Phone number of the organisation",
"format": "tel",
"nullable": true
},
"mobile": {
"title": "String",
"maxLength": 15,
"type": "string",
"description": "Mobile number of the organisation",
"format": "tel",
"nullable": true
},
"email": {
"title": "String",
"maxLength": 100,
"type": "string",
"description": "Email address of the organisation",
"nullable": true
},
"alternateEmail": {
"title": "String",
"maxLength": 100,
"type": "string",
"description": "Alternate email address of the organisation",
"nullable": true
},
"address": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.AddressViewModel"
},
"ward": {
"title": "String",
"type": "string",
"description": "Ward associated with the organisation",
"nullable": true
},
"allowedContactMethods": {
"title": "List`1",
"type": "array",
"items": {
"title": "String",
"type": "string"
},
"description": "List of allowed contact methods for the organisation",
"nullable": true
},
"preferredContactMethod": {
"title": "String",
"type": "string",
"description": "Preferred contact method for the organisation",
"nullable": true
},
"risk": {
"title": "String",
"maxLength": 1,
"type": "string",
"description": "Risk level associated with the organisation",
"nullable": true
},
"website": {
"title": "String",
"maxLength": 100,
"type": "string",
"description": "Website of the organisation",
"format": "uri",
"nullable": true
},
"upin": {
"title": "String",
"maxLength": 8,
"type": "string",
"description": "UPIN associated with the organisation",
"nullable": true
},
"ukprn": {
"title": "String",
"maxLength": 8,
"type": "string",
"description": "UKPRN associated with the organisation",
"nullable": true
},
"edsReference": {
"title": "String",
"maxLength": 9,
"type": "string",
"description": "EDS reference associated with the organisation",
"nullable": true
},
"companyRegistrationNumber": {
"title": "String",
"maxLength": 8,
"type": "string",
"description": "Company registration number associated with the organisation",
"nullable": true
},
"epaOrganisation": {
"title": "String",
"maxLength": 7,
"minLength": 7,
"type": "string",
"description": "EPA organisation associated with the organisation",
"nullable": true
},
"mainOfficer": {
"title": "String",
"type": "string",
"description": "Main officer associated with the organisation",
"nullable": true
},
"mainContact": {
"title": "String",
"type": "string",
"description": "Main contact associated with the organisation",
"nullable": true
},
"headOffice": {
"title": "String",
"type": "string",
"description": "Head office associated with the organisation",
"nullable": true
},
"status": {
"title": "String",
"type": "string",
"description": "Status of the organisation",
"nullable": true
},
"additionalID": {
"title": "String",
"maxLength": 50,
"type": "string",
"description": "Additional ID associated with the organisation",
"nullable": true
},
"roles": {
"title": "List`1",
"type": "array",
"items": {
"title": "String",
"type": "string"
},
"description": "List of roles associated with the organisation",
"nullable": true
},
"invoiceAddress": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.AddressViewModel"
},
"invoiceName": {
"title": "String",
"type": "string",
"description": "Invoice name associated with the organisation",
"nullable": true
},
"invoicePhone": {
"title": "String",
"type": "string",
"description": "Invoice phone number associated with the organisation",
"nullable": true
},
"invoiceEmail": {
"title": "String",
"type": "string",
"description": "Invoice email address associated with the organisation",
"nullable": true
},
"allowMarketing": {
"title": "String",
"type": "string",
"description": "Allow marketing status associated with the organisation",
"nullable": true
},
"hasIIP": {
"title": "String",
"type": "string",
"description": "Has IIP status associated with the organisation",
"nullable": true
},
"previousTraining": {
"title": "String",
"type": "string",
"description": "Previous training status associated with the organisation",
"nullable": true
},
"ethnicMinorityBusiness": {
"title": "String",
"type": "string",
"description": "Ethnic minority business status associated with the organisation",
"nullable": true
},
"notes": {
"title": "String",
"type": "string",
"description": "Notes associated with the organisation",
"nullable": true
},
"employerSizeBand": {
"title": "String",
"type": "string",
"description": "Employer size band associated with the organisation",
"nullable": true
},
"accountingSystemID": {
"title": "String",
"type": "string",
"description": "Accounting system ID associated with the organisation",
"nullable": true
},
"vatRegNo": {
"title": "String",
"type": "string",
"description": "VAT registration number associated with the organisation",
"nullable": true
},
"employeeCount": {
"title": "Nullable`1",
"type": "integer",
"description": "Employee count associated with the organisation",
"format": "int32",
"nullable": true
},
"annualTurnover": {
"title": "Nullable`1",
"type": "number",
"description": "Annual turnover associated with the organisation",
"format": "double",
"nullable": true
}
},
"additionalProperties": false,
"description": "Represents a view model for creating detailed information related to an organisation"
},
"Business.Core.Api.ViewModels.Organisations.DetailsViewModel": {
"title": "DetailsViewModel",
"type": "object",
"properties": {
"id": {
"title": "String",
"type": "string",
"description": "ID associated with the organisation details",
"nullable": true
},
"name": {
"title": "String",
"type": "string",
"description": "Name of the organisation",
"nullable": true
},
"email": {
"title": "String",
"type": "string",
"description": "Email address of the organisation",
"nullable": true
},
"website": {
"title": "String",
"type": "string",
"description": "Website of the organisation",
"nullable": true
},
"phone": {
"title": "String",
"type": "string",
"description": "Phone number of the organisation",
"nullable": true
},
"risk": {
"title": "String",
"type": "string",
"description": "Risk level associated with the organisation",
"nullable": true
},
"status": {
"title": "String",
"type": "string",
"description": "Status of the organisation",
"nullable": true
},
"alias": {
"title": "String",
"type": "string",
"description": "Alias of the organisation",
"nullable": true
},
"address": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.AddressViewModel"
},
"ward": {
"title": "String",
"type": "string",
"description": "Ward associated with the organisation",
"nullable": true
},
"mobile": {
"title": "String",
"type": "string",
"description": "Mobile number of the organisation",
"nullable": true
},
"alternateEmail": {
"title": "String",
"type": "string",
"description": "Alternate email address of the organisation",
"nullable": true
},
"allowedContactMethods": {
"title": "List`1",
"type": "array",
"items": {
"title": "String",
"type": "string"
},
"description": "List of allowed contact methods for the organisation",
"nullable": true
},
"preferredContactMethod": {
"title": "String",
"type": "string",
"description": "Preferred contact method for the organisation",
"nullable": true
},
"upin": {
"title": "String",
"type": "string",
"description": "UPIN associated with the organisation",
"nullable": true
},
"ukprn": {
"title": "String",
"type": "string",
"description": "UKPRN associated with the organisation",
"nullable": true
},
"edsReference": {
"title": "String",
"type": "string",
"description": "EDS reference associated with the organisation",
"nullable": true
},
"companyRegistrationNumber": {
"title": "String",
"type": "string",
"description": "Company registration number associated with the organisation",
"nullable": true
},
"additionalID": {
"title": "String",
"type": "string",
"description": "Additional ID associated with the organisation",
"nullable": true
},
"epaOrganisation": {
"title": "String",
"type": "string",
"description": "EPA organisation associated with the organisation",
"nullable": true
},
"mainContact": {
"title": "String",
"type": "string",
"description": "Main contact associated with the organisation",
"nullable": true
},
"mainOfficer": {
"title": "String",
"type": "string",
"description": "Main officer associated with the organisation",
"nullable": true
},
"headOffice": {
"title": "String",
"type": "string",
"description": "Head office associated with the organisation",
"nullable": true
},
"username": {
"title": "String",
"type": "string",
"description": "Username associated with the organisation",
"nullable": true
},
"roles": {
"title": "List`1",
"type": "array",
"items": {
"title": "String",
"type": "string"
},
"description": "List of roles associated with the organisation",
"nullable": true
},
"invoiceAddress": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.AddressViewModel"
},
"invoiceName": {
"title": "String",
"type": "string",
"description": "Invoice name associated with the organisation",
"nullable": true
},
"invoicePhone": {
"title": "String",
"type": "string",
"description": "Invoice phone number associated with the organisation",
"nullable": true
},
"invoiceEmail": {
"title": "String",
"type": "string",
"description": "Invoice email address associated with the organisation",
"nullable": true
},
"allowMarketing": {
"title": "String",
"type": "string",
"description": "Allow marketing status associated with the organisation",
"nullable": true
},
"hasIIP": {
"title": "String",
"type": "string",
"description": "Has IIP status associated with the organisation",
"nullable": true
},
"previousTraining": {
"title": "String",
"type": "string",
"description": "Previous training status associated with the organisation",
"nullable": true
},
"ethnicMinorityBusiness": {
"title": "String",
"type": "string",
"description": "Ethnic minority business status associated with the organisation",
"nullable": true
},
"notes": {
"title": "String",
"type": "string",
"description": "Notes associated with the organisation",
"nullable": true
},
"employerSizeBand": {
"title": "String",
"type": "string",
"description": "Employer size band associated with the organisation",
"nullable": true
},
"accountingSystemID": {
"title": "String",
"type": "string",
"description": "Accounting system ID associated with the organisation",
"nullable": true
},
"vatRegNo": {
"title": "String",
"type": "string",
"description": "VAT registration number associated with the organisation",
"nullable": true
},
"employeeCount": {
"title": "Nullable`1",
"type": "integer",
"description": "Employee count associated with the organisation",
"format": "int32",
"nullable": true
},
"annualTurnover": {
"title": "Nullable`1",
"type": "number",
"description": "Annual turnover associated with the organisation",
"format": "double",
"nullable": true
}
},
"additionalProperties": false,
"description": "Represents a view model for detailed information related to an organisation"
},
"Business.Core.Api.ViewModels.Organisations.EditViewModel": {
"title": "EditViewModel",
"required": [
"id",
"name",
"roles"
],
"type": "object",
"properties": {
"id": {
"title": "String",
"minLength": 1,
"type": "string",
"description": "ID associated with the organisation details"
},
"name": {
"title": "String",
"maxLength": 60,
"minLength": 1,
"type": "string",
"description": "Name of the organisation"
},
"alias": {
"title": "String",
"maxLength": 60,
"type": "string",
"description": "Alias of the organisation",
"nullable": true
},
"phone": {
"title": "String",
"maxLength": 25,
"type": "string",
"description": "Phone number of the organisation",
"format": "tel",
"nullable": true
},
"mobile": {
"title": "String",
"maxLength": 15,
"type": "string",
"description": "Mobile number of the organisation",
"format": "tel",
"nullable": true
},
"email": {
"title": "String",
"maxLength": 100,
"type": "string",
"description": "Email address of the organisation",
"format": "email",
"nullable": true
},
"alternateEmail": {
"title": "String",
"maxLength": 100,
"type": "string",
"description": "Alternate email address of the organisation",
"format": "email",
"nullable": true
},
"address": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.AddressViewModel"
},
"ward": {
"title": "String",
"type": "string",
"description": "Ward associated with the organisation",
"nullable": true
},
"allowedContactMethods": {
"title": "List`1",
"type": "array",
"items": {
"title": "String",
"type": "string"
},
"description": "List of allowed contact methods for the organisation",
"nullable": true
},
"preferredContactMethod": {
"title": "String",
"type": "string",
"description": "Preferred contact method for the organisation",
"nullable": true
},
"risk": {
"title": "String",
"maxLength": 1,
"type": "string",
"description": "Risk level associated with the organisation",
"nullable": true
},
"website": {
"title": "String",
"maxLength": 100,
"type": "string",
"description": "Website of the organisation",
"format": "uri",
"nullable": true
},
"upin": {
"title": "String",
"maxLength": 8,
"type": "string",
"description": "UPIN associated with the organisation",
"nullable": true
},
"ukprn": {
"title": "String",
"maxLength": 8,
"type": "string",
"description": "UKPRN associated with the organisation",
"nullable": true
},
"edsReference": {
"title": "String",
"maxLength": 9,
"type": "string",
"description": "EDS reference associated with the organisation",
"nullable": true
},
"companyRegistrationNumber": {
"title": "String",
"maxLength": 8,
"type": "string",
"description": "Company registration number associated with the organisation",
"nullable": true
},
"epaOrganisation": {
"title": "String",
"maxLength": 7,
"minLength": 7,
"type": "string",
"description": "EPA organisation associated with the organisation",
"nullable": true
},
"mainOfficer": {
"title": "String",
"type": "string",
"description": "Main officer associated with the organisation",
"nullable": true
},
"mainContact": {
"title": "String",
"type": "string",
"description": "Main contact associated with the organisation",
"nullable": true
},
"headOffice": {
"title": "String",
"type": "string",
"description": "Head office associated with the organisation",
"nullable": true
},
"status": {
"title": "String",
"type": "string",
"description": "Status of the organisation",
"nullable": true
},
"roles": {
"title": "List`1",
"type": "array",
"items": {
"title": "String",
"type": "string"
},
"description": "List of roles associated with the organisation"
},
"additionalID": {
"title": "String",
"maxLength": 50,
"type": "string",
"description": "Additional ID associated with the organisation",
"nullable": true
},
"invoiceAddress": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.AddressViewModel"
},
"invoiceName": {
"title": "String",
"type": "string",
"description": "Invoice name associated with the organisation",
"nullable": true
},
"invoicePhone": {
"title": "String",
"type": "string",
"description": "Invoice phone number associated with the organisation",
"nullable": true
},
"invoiceEmail": {
"title": "String",
"type": "string",
"description": "Invoice email address associated with the organisation",
"nullable": true
},
"allowMarketing": {
"title": "String",
"type": "string",
"description": "Allow marketing status associated with the organisation",
"nullable": true
},
"hasIIP": {
"title": "String",
"type": "string",
"description": "Has IIP status associated with the organisation",
"nullable": true
},
"previousTraining": {
"title": "String",
"type": "string",
"description": "Previous training status associated with the organisation",
"nullable": true
},
"ethnicMinorityBusiness": {
"title": "String",
"type": "string",
"description": "Ethnic minority business status associated with the organisation",
"nullable": true
},
"notes": {
"title": "String",
"type": "string",
"description": "Notes associated with the organisation",
"nullable": true
},
"employerSizeBand": {
"title": "String",
"type": "string",
"description": "Employer size band associated with the organisation",
"nullable": true
},
"accountingSystemID": {
"title": "String",
"type": "string",
"description": "Accounting system ID associated with the organisation",
"nullable": true
},
"vatRegNo": {
"title": "String",
"type": "string",
"description": "VAT registration number associated with the organisation",
"nullable": true
},
"employeeCount": {
"title": "Nullable`1",
"type": "integer",
"description": "Employee count associated with the organisation",
"format": "int32",
"nullable": true
},
"annualTurnover": {
"title": "Nullable`1",
"type": "number",
"description": "Annual turnover associated with the organisation",
"format": "double",
"nullable": true
}
},
"additionalProperties": false,
"description": "Represents a view model for editing detailed information related to an organisation"
},
"Business.Core.Api.ViewModels.Organisations.SummaryViewModel": {
"title": "SummaryViewModel",
"type": "object",
"properties": {
"id": {
"title": "String",
"type": "string",
"description": "ID associated with the Organisation",
"nullable": true
},
"name": {
"title": "String",
"type": "string",
"description": "Name of the Organisation",
"nullable": true
},
"email": {
"title": "String",
"type": "string",
"description": "Email address of the Organisation",
"nullable": true
},
"website": {
"title": "String",
"type": "string",
"description": "Website of the Organisation",
"nullable": true
},
"phone": {
"title": "String",
"type": "string",
"description": "Phone number of the Organisation",
"nullable": true
},
"risk": {
"title": "String",
"type": "string",
"description": "Risk level associated with the Organisation",
"nullable": true
},
"status": {
"title": "String",
"type": "string",
"description": "Status of the Organisation",
"nullable": true
},
"alias": {
"title": "String",
"type": "string",
"description": "Alias of the Organisation",
"nullable": true
},
"address": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.AddressViewModel"
},
"ward": {
"title": "String",
"type": "string",
"description": "Ward associated with the Organisation",
"nullable": true
},
"mobile": {
"title": "String",
"type": "string",
"description": "Mobile number of the Organisation",
"nullable": true
},
"alternateEmail": {
"title": "String",
"type": "string",
"description": "Alternate email address of the Organisation",
"nullable": true
},
"allowedContactMethods": {
"title": "List`1",
"type": "array",
"items": {
"title": "String",
"type": "string"
},
"description": "List of allowed contact methods for the Organisation",
"nullable": true
},
"preferredContactMethod": {
"title": "String",
"type": "string",
"description": "Preferred contact method for the Organisation",
"nullable": true
},
"upin": {
"title": "String",
"type": "string",
"description": "UPIN associated with the Organisation",
"nullable": true
},
"ukprn": {
"title": "String",
"type": "string",
"description": "UKPRN associated with the Organisation",
"nullable": true
},
"edsReference": {
"title": "String",
"type": "string",
"description": "EDS reference associated with the Organisation",
"nullable": true
},
"companyRegistrationNumber": {
"title": "String",
"type": "string",
"description": "Company registration number associated with the Organisation",
"nullable": true
},
"additionalID": {
"title": "String",
"type": "string",
"description": "Additional ID associated with the Organisation",
"nullable": true
},
"epaOrganisation": {
"title": "String",
"type": "string",
"description": "EPA organisation associated with the Organisation",
"nullable": true
},
"mainContact": {
"title": "String",
"type": "string",
"description": "Main contact associated with the Organisation",
"nullable": true
},
"mainOfficer": {
"title": "String",
"type": "string",
"description": "Main officer associated with the Organisation",
"nullable": true
},
"headOffice": {
"title": "String",
"type": "string",
"description": "Head office associated with the Organisation",
"nullable": true
},
"roles": {
"title": "List`1",
"type": "array",
"items": {
"title": "String",
"type": "string"
},
"description": "List of roles associated with the Organisation",
"nullable": true
},
"invoiceAddress": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.AddressViewModel"
},
"invoiceName": {
"title": "String",
"type": "string",
"description": "Invoice name associated with the Organisation",
"nullable": true
},
"invoicePhone": {
"title": "String",
"type": "string",
"description": "Invoice phone number associated with the Organisation",
"nullable": true
},
"invoiceEmail": {
"title": "String",
"type": "string",
"description": "Invoice email address associated with the Organisation",
"nullable": true
},
"allowMarketing": {
"title": "String",
"type": "string",
"description": "Allow marketing status associated with the Organisation",
"nullable": true
},
"hasIIP": {
"title": "String",
"type": "string",
"description": "Has IIP status associated with the Organisation",
"nullable": true
},
"previousTraining": {
"title": "String",
"type": "string",
"description": "Previous training status associated with the Organisation",
"nullable": true
},
"ethnicMinorityBusiness": {
"title": "String",
"type": "string",
"description": "Ethnic minority business status associated with the Organisation",
"nullable": true
},
"notes": {
"title": "String",
"type": "string",
"description": "Notes associated with the Organisation",
"nullable": true
},
"employerSizeBand": {
"title": "String",
"type": "string",
"description": "Employer size band associated with the Organisation",
"nullable": true
},
"accountingSystemID": {
"title": "String",
"type": "string",
"description": "Accounting system ID associated with the Organisation",
"nullable": true
},
"vatRegNo": {
"title": "String",
"type": "string",
"description": "VAT registration number associated with the Organisation",
"nullable": true
},
"employeeCount": {
"title": "Nullable`1",
"type": "integer",
"description": "Employee count associated with the Organisation",
"format": "int32",
"nullable": true
},
"annualTurnover": {
"title": "Nullable`1",
"type": "number",
"description": "Annual turnover associated with the Organisation",
"format": "double",
"nullable": true
}
},
"additionalProperties": false,
"description": "Represents a view model for summary information related to an Organisation"
},
"Business.Core.Api.ViewModels.Payments.CreateViewModel": {
"title": "CreateViewModel",
"required": [
"description",
"learnerIdent"
],
"type": "object",
"properties": {
"learnerIdent": {
"title": "String",
"minLength": 1,
"type": "string",
"description": "Learner identifier associated with the payment"
},
"organisationCode": {
"title": "String",
"type": "string",
"description": "Organisation code associated with the payment",
"nullable": true
},
"paymentItem": {
"title": "String",
"type": "string",
"description": "Payment item details",
"nullable": true
},
"systemType": {
"title": "String",
"type": "string",
"description": "System type associated with the payment",
"nullable": true
},
"creditDebit": {
"title": "String",
"type": "string",
"description": "Credit or debit status associated with the payment",
"nullable": true
},
"description": {
"title": "String",
"minLength": 1,
"type": "string",
"description": "Description of the payment"
},
"reference": {
"title": "String",
"type": "string",
"description": "Reference number associated with the payment",
"nullable": true
},
"purchaseOrderNumber": {
"title": "String",
"type": "string",
"description": "Purchase order number associated with the payment",
"nullable": true
},
"invoiceNumber": {
"title": "String",
"type": "string",
"description": "Invoice number associated with the payment",
"nullable": true
},
"notes": {
"title": "String",
"type": "string",
"description": "Additional notes related to the payment",
"nullable": true
},
"status": {
"title": "String",
"type": "string",
"description": "Status of the payment",
"nullable": true
},
"createdDate": {
"title": "Nullable`1",
"type": "string",
"description": "Date when the payment is created",
"format": "date-time",
"nullable": true
},
"raisedDate": {
"title": "Nullable`1",
"type": "string",
"description": "Date when the payment is raised",
"format": "date-time",
"nullable": true
},
"raisedBy": {
"title": "String",
"type": "string",
"description": "Person who raised the payment",
"nullable": true
},
"expectedDate": {
"title": "Nullable`1",
"type": "string",
"description": "Date when the payment is expected",
"format": "date-time",
"nullable": true
},
"expectedAmount": {
"title": "Nullable`1",
"type": "number",
"description": "Expected amount for the payment",
"format": "double",
"nullable": true
},
"authorisedDate": {
"title": "Nullable`1",
"type": "string",
"description": "Date when the payment is authorized",
"format": "date-time",
"nullable": true
},
"authorisedBy": {
"title": "String",
"type": "string",
"description": "Person who authorized the payment",
"nullable": true
},
"actualDate": {
"title": "Nullable`1",
"type": "string",
"description": "Date when the payment is actually processed",
"format": "date-time",
"nullable": true
},
"actualAmount": {
"title": "Nullable`1",
"type": "number",
"description": "Actual amount for the payment",
"format": "double",
"nullable": true
},
"actualBy": {
"title": "String",
"type": "string",
"description": "Person associated with the actual processing of the payment",
"nullable": true
},
"invoicedDate": {
"title": "Nullable`1",
"type": "string",
"description": "Date when the payment is invoiced",
"format": "date-time",
"nullable": true
},
"reconciledDate": {
"title": "Nullable`1",
"type": "string",
"description": "Date when the payment is reconciled",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false,
"description": "Represents a view model for creating payment-related information"
},
"Business.Core.Api.ViewModels.Payments.DetailsViewModel": {
"title": "DetailsViewModel",
"type": "object",
"properties": {
"id": {
"title": "String",
"type": "string",
"nullable": true
},
"learnerIdent": {
"title": "String",
"type": "string",
"nullable": true
},
"organisationCode": {
"title": "String",
"type": "string",
"nullable": true
},
"paymentItem": {
"title": "String",
"type": "string",
"nullable": true
},
"systemType": {
"title": "String",
"type": "string",
"nullable": true
},
"creditDebit": {
"title": "String",
"type": "string",
"nullable": true
},
"description": {
"title": "String",
"type": "string",
"nullable": true
},
"reference": {
"title": "String",
"type": "string",
"nullable": true
},
"purchaseOrderNumber": {
"title": "String",
"type": "string",
"nullable": true
},
"invoiceNumber": {
"title": "String",
"type": "string",
"nullable": true
},
"notes": {
"title": "String",
"type": "string",
"nullable": true
},
"status": {
"title": "String",
"type": "string",
"nullable": true
},
"createdDate": {
"title": "Nullable`1",
"type": "string",
"format": "date-time",
"nullable": true
},
"raisedDate": {
"title": "Nullable`1",
"type": "string",
"format": "date-time",
"nullable": true
},
"raisedBy": {
"title": "String",
"type": "string",
"nullable": true
},
"expectedDate": {
"title": "Nullable`1",
"type": "string",
"format": "date-time",
"nullable": true
},
"expectedAmount": {
"title": "Nullable`1",
"type": "number",
"format": "double",
"nullable": true
},
"authorisedDate": {
"title": "Nullable`1",
"type": "string",
"format": "date-time",
"nullable": true
},
"authorisedBy": {
"title": "String",
"type": "string",
"nullable": true
},
"actualDate": {
"title": "Nullable`1",
"type": "string",
"format": "date-time",
"nullable": true
},
"actualAmount": {
"title": "Nullable`1",
"type": "number",
"format": "double",
"nullable": true
},
"actualBy": {
"title": "String",
"type": "string",
"nullable": true
},
"invoicedDate": {
"title": "Nullable`1",
"type": "string",
"format": "date-time",
"nullable": true
},
"reconciledDate": {
"title": "Nullable`1",
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"Business.Core.Api.ViewModels.Payments.EditViewModel": {
"title": "EditViewModel",
"required": [
"description",
"id"
],
"type": "object",
"properties": {
"id": {
"title": "String",
"minLength": 1,
"type": "string",
"description": "ID associated with the payment details"
},
"paymentItem": {
"title": "String",
"type": "string",
"description": "Payment item details",
"nullable": true
},
"systemType": {
"title": "String",
"type": "string",
"description": "System type associated with the payment",
"nullable": true
},
"creditDebit": {
"title": "String",
"type": "string",
"description": "Credit or debit status associated with the payment",
"nullable": true
},
"description": {
"title": "String",
"minLength": 1,
"type": "string",
"description": "Description of the payment"
},
"reference": {
"title": "String",
"type": "string",
"description": "Reference number associated with the payment",
"nullable": true
},
"purchaseOrderNumber": {
"title": "String",
"type": "string",
"description": "Purchase order number associated with the payment",
"nullable": true
},
"invoiceNumber": {
"title": "String",
"type": "string",
"description": "Invoice number associated with the payment",
"nullable": true
},
"notes": {
"title": "String",
"type": "string",
"description": "Additional notes related to the payment",
"nullable": true
},
"status": {
"title": "String",
"type": "string",
"description": "Status of the payment",
"nullable": true
},
"createdDate": {
"title": "Nullable`1",
"type": "string",
"description": "Date when the payment was created",
"format": "date-time",
"nullable": true
},
"raisedDate": {
"title": "Nullable`1",
"type": "string",
"description": "Date when the payment was raised",
"format": "date-time",
"nullable": true
},
"raisedBy": {
"title": "String",
"type": "string",
"description": "Person who raised the payment",
"nullable": true
},
"expectedDate": {
"title": "Nullable`1",
"type": "string",
"description": "Date when the payment is expected",
"format": "date-time",
"nullable": true
},
"expectedAmount": {
"title": "Nullable`1",
"type": "number",
"description": "Expected amount for the payment",
"format": "double",
"nullable": true
},
"authorisedDate": {
"title": "Nullable`1",
"type": "string",
"description": "Date when the payment was authorized",
"format": "date-time",
"nullable": true
},
"authorisedBy": {
"title": "String",
"type": "string",
"description": "Person who authorized the payment",
"nullable": true
},
"actualDate": {
"title": "Nullable`1",
"type": "string",
"description": "Date when the payment was actually processed",
"format": "date-time",
"nullable": true
},
"actualAmount": {
"title": "Nullable`1",
"type": "number",
"description": "Actual amount for the payment",
"format": "double",
"nullable": true
},
"actualBy": {
"title": "String",
"type": "string",
"description": "Person associated with the actual processing of the payment",
"nullable": true
},
"invoicedDate": {
"title": "Nullable`1",
"type": "string",
"description": "Date when the payment was invoiced",
"format": "date-time",
"nullable": true
},
"reconciledDate": {
"title": "Nullable`1",
"type": "string",
"description": "Date when the payment was reconciled",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false,
"description": "Represents a view model for editing payment-related information"
},
"Business.Core.Api.ViewModels.Payments.SummaryViewModel": {
"title": "SummaryViewModel",
"type": "object",
"properties": {
"id": {
"title": "String",
"type": "string",
"description": "ID associated with the payment details",
"nullable": true
},
"learnerIdent": {
"title": "String",
"type": "string",
"description": "Learner identifier associated with the payment",
"nullable": true
},
"organisationCode": {
"title": "String",
"type": "string",
"description": "Organisation code associated with the payment",
"nullable": true
},
"paymentItem": {
"title": "String",
"type": "string",
"description": "Payment item details",
"nullable": true
},
"systemType": {
"title": "String",
"type": "string",
"description": "System type associated with the payment",
"nullable": true
},
"creditDebit": {
"title": "String",
"type": "string",
"description": "Credit or debit status associated with the payment",
"nullable": true
},
"description": {
"title": "String",
"type": "string",
"description": "Description of the payment",
"nullable": true
},
"reference": {
"title": "String",
"type": "string",
"description": "Reference number associated with the payment",
"nullable": true
},
"purchaseOrderNumber": {
"title": "String",
"type": "string",
"description": "Purchase order number associated with the payment",
"nullable": true
},
"invoiceNumber": {
"title": "String",
"type": "string",
"description": "Invoice number associated with the payment",
"nullable": true
},
"notes": {
"title": "String",
"type": "string",
"description": "Additional notes related to the payment",
"nullable": true
},
"status": {
"title": "String",
"type": "string",
"description": "Status of the payment",
"nullable": true
},
"createdDate": {
"title": "Nullable`1",
"type": "string",
"description": "Date when the payment was created",
"format": "date-time",
"nullable": true
},
"raisedDate": {
"title": "Nullable`1",
"type": "string",
"description": "Date when the payment was raised",
"format": "date-time",
"nullable": true
},
"raisedBy": {
"title": "String",
"type": "string",
"description": "Person who raised the payment",
"nullable": true
},
"expectedDate": {
"title": "Nullable`1",
"type": "string",
"description": "Date when the payment is expected",
"format": "date-time",
"nullable": true
},
"expectedAmount": {
"title": "Nullable`1",
"type": "number",
"description": "Expected amount for the payment",
"format": "double",
"nullable": true
},
"authorisedDate": {
"title": "Nullable`1",
"type": "string",
"description": "Date when the payment was authorized",
"format": "date-time",
"nullable": true
},
"authorisedBy": {
"title": "String",
"type": "string",
"description": "Person who authorized the payment",
"nullable": true
},
"actualDate": {
"title": "Nullable`1",
"type": "string",
"description": "Date when the payment was actually processed",
"format": "date-time",
"nullable": true
},
"actualAmount": {
"title": "Nullable`1",
"type": "number",
"description": "Actual amount for the payment",
"format": "double",
"nullable": true
},
"actualBy": {
"title": "String",
"type": "string",
"description": "Person associated with the actual processing of the payment",
"nullable": true
},
"invoicedDate": {
"title": "Nullable`1",
"type": "string",
"description": "Date when the payment was invoiced",
"format": "date-time",
"nullable": true
},
"reconciledDate": {
"title": "Nullable`1",
"type": "string",
"description": "Date when the payment was reconciled",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false,
"description": "Represents a view model summarizing payment-related financial information"
},
"Business.Core.Api.ViewModels.Tasks.AttachmentViewModelItem": {
"title": "AttachmentViewModelItem",
"type": "object",
"properties": {
"id": {
"title": "String",
"type": "string",
"description": "Attachment ID",
"nullable": true
},
"fileName": {
"title": "String",
"type": "string",
"description": "File name",
"nullable": true
},
"description": {
"title": "String",
"type": "string",
"description": "Attachment description",
"nullable": true
},
"expires": {
"title": "Nullable`1",
"type": "string",
"description": "Attachment expires date",
"format": "date-time",
"nullable": true
},
"fileType": {
"title": "String",
"type": "string",
"description": "Attachment file type",
"nullable": true
}
},
"additionalProperties": false,
"description": "Represents a file attached to a Task"
},
"Business.Core.Api.ViewModels.Tasks.AttachmentsViewModel": {
"title": "AttachmentsViewModel",
"type": "object",
"properties": {
"items": {
"title": "List`1",
"type": "array",
"items": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Tasks.AttachmentViewModelItem"
},
"description": "List of task file attachments",
"nullable": true
}
},
"additionalProperties": false,
"description": "Represents a list of files attached to a Task"
},
"Business.Core.Api.ViewModels.Tasks.CreateViewModel": {
"title": "CreateViewModel",
"type": "object",
"properties": {
"description": {
"title": "String",
"type": "string",
"description": "Description of the Task",
"nullable": true
},
"notes": {
"title": "String",
"type": "string",
"description": "Additional Notes for the Task - Employability Only",
"nullable": true
},
"type": {
"title": "String",
"type": "string",
"description": "The Task's Type",
"nullable": true
},
"workflow": {
"title": "String",
"type": "string",
"description": "The Task's Workflow Code",
"nullable": true
},
"dueOn": {
"title": "Nullable`1",
"type": "string",
"description": "The Task's Expected End",
"format": "date-time",
"nullable": true
},
"doneOn": {
"title": "Nullable`1",
"type": "string",
"description": "The Task's Actual End",
"format": "date-time",
"nullable": true
},
"start": {
"title": "Nullable`1",
"type": "string",
"description": "The Task's Actual Start",
"format": "date-time",
"nullable": true
},
"participants": {
"title": "List`1",
"type": "array",
"items": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.ParticipantViewModel"
},
"description": "List of Task Participants",
"nullable": true
},
"templateID": {
"title": "String",
"type": "string",
"description": "Not user editable. Assigned when using the create with template function.",
"nullable": true
},
"templateIDChecksum": {
"title": "String",
"type": "string",
"description": "Not user editable. Assigned when using the create with template function.",
"nullable": true
}
},
"additionalProperties": false
},
"Business.Core.Api.ViewModels.Tasks.DetailsViewModel": {
"title": "DetailsViewModel",
"type": "object",
"properties": {
"id": {
"title": "Int32",
"type": "integer",
"description": "Task ID",
"format": "int32"
},
"description": {
"title": "String",
"type": "string",
"description": "Description of the Task",
"nullable": true
},
"notes": {
"title": "String",
"type": "string",
"description": "Additional Notes for the Task - Employability Only",
"nullable": true
},
"type": {
"title": "String",
"type": "string",
"description": "The Task's Type",
"nullable": true
},
"status": {
"title": "String",
"type": "string",
"description": "The Task's Status",
"nullable": true
},
"subStatus": {
"title": "String",
"type": "string",
"description": "The Task's Sub Status",
"nullable": true
},
"workflow": {
"title": "String",
"type": "string",
"description": "The Task's Workflow Code",
"nullable": true
},
"createdBy": {
"title": "String",
"type": "string",
"description": "Officer code used to create the Task",
"nullable": true
},
"templateID": {
"title": "String",
"type": "string",
"description": "The Template ID used to create the Task",
"nullable": true
},
"dueOn": {
"title": "Nullable`1",
"type": "string",
"description": "The Task's Expected End",
"format": "date-time",
"nullable": true
},
"doneOn": {
"title": "Nullable`1",
"type": "string",
"description": "The Task's Actual End",
"format": "date-time",
"nullable": true
},
"start": {
"title": "Nullable`1",
"type": "string",
"description": "The Task's Actual Start",
"format": "date-time",
"nullable": true
},
"participants": {
"title": "List`1",
"type": "array",
"items": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.ParticipantViewModel"
},
"description": "List of Task Participants",
"nullable": true
}
},
"additionalProperties": false
},
"Business.Core.Api.ViewModels.Tasks.EditViewModel": {
"title": "EditViewModel",
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"title": "Int32",
"type": "integer",
"description": "The Task's ID",
"format": "int32"
},
"description": {
"title": "String",
"type": "string",
"description": "Description of the Task",
"nullable": true
},
"notes": {
"title": "String",
"type": "string",
"description": "Additional Notes for the Task - Employability Only",
"nullable": true
},
"status": {
"title": "String",
"type": "string",
"description": "The Task's Status",
"nullable": true
},
"subStatus": {
"title": "String",
"type": "string",
"description": "The Task's Sub Status",
"nullable": true
},
"workflow": {
"title": "String",
"type": "string",
"description": "The Task's Workflow Code",
"nullable": true
},
"dueOn": {
"title": "Nullable`1",
"type": "string",
"description": "The date the Task is due on",
"format": "date-time",
"nullable": true
},
"doneOn": {
"title": "Nullable`1",
"type": "string",
"description": "The date the Task was completed on",
"format": "date-time",
"nullable": true
},
"start": {
"title": "Nullable`1",
"type": "string",
"description": "The date the Task was started on",
"format": "date-time",
"nullable": true
},
"participants": {
"title": "List`1",
"type": "array",
"items": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.ParticipantViewModel"
},
"description": "List of Task Participants",
"nullable": true
}
},
"additionalProperties": false
},
"Business.Core.Api.ViewModels.Tasks.SearchResultItemViewModel": {
"title": "SearchResultItemViewModel",
"type": "object",
"properties": {
"id": {
"title": "Int32",
"type": "integer",
"description": "Task ID",
"format": "int32"
},
"description": {
"title": "String",
"type": "string",
"description": "Description of the Task",
"nullable": true
},
"type": {
"title": "String",
"type": "string",
"description": "The Task's Type",
"nullable": true
},
"status": {
"title": "String",
"type": "string",
"description": "The Task's Status",
"nullable": true
},
"subStatus": {
"title": "String",
"type": "string",
"description": "The Task's Sub Status",
"nullable": true
},
"workflow": {
"title": "String",
"type": "string",
"description": "The Task's Workflow Code",
"nullable": true
},
"createdBy": {
"title": "String",
"type": "string",
"description": "Officer code used to create the Task",
"nullable": true
},
"templateID": {
"title": "String",
"type": "string",
"description": "The Template ID used to create the Task",
"nullable": true
},
"dueOn": {
"title": "Nullable`1",
"type": "string",
"description": "The Task's Expected End",
"format": "date-time",
"nullable": true
},
"doneOn": {
"title": "Nullable`1",
"type": "string",
"description": "The Task's Actual End",
"format": "date-time",
"nullable": true
},
"start": {
"title": "Nullable`1",
"type": "string",
"description": "The Task's Actual Start",
"format": "date-time",
"nullable": true
},
"participants": {
"title": "List`1",
"type": "array",
"items": {
"$ref": "#/components/schemas/Business.Core.Api.ViewModels.Generic.ParticipantViewModel"
},
"description": "List of Task Participants",
"nullable": true
}
},
"additionalProperties": false
},
"Microsoft.AspNetCore.Mvc.ProblemDetails": {
"title": "ProblemDetails",
"type": "object",
"properties": {
"type": {
"title": "String",
"type": "string",
"nullable": true
},
"title": {
"title": "String",
"type": "string",
"nullable": true
},
"status": {
"title": "Nullable`1",
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"title": "String",
"type": "string",
"nullable": true
},
"instance": {
"title": "String",
"type": "string",
"nullable": true
}
},
"additionalProperties": {
"title": "Object"
}
}
},
"securitySchemes": {
"Bearer": {
"type": "apiKey",
"description": "Please enter a valid token",
"name": "Authorization",
"in": "header"
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment