{ "openapi": "3.0.1", "info": { "title": "SweCRIS API", "description": "Through this API you can access SweCRIS project data.", "contact": { "name": "SweCRIS Helpdesk", "email": "webbredaktor@vr.se" }, "version": "1.0" }, "paths": { "/v{version}/funders": { "get": { "tags": [ "Funders" ], "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FunderDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FunderDto" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v{version}/funders/{funderId}": { "get": { "tags": [ "Funders" ], "parameters": [ { "name": "funderId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FunderDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/FunderDto" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v{version}/funders/projects/{projectId}": { "get": { "tags": [ "Funders" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FunderDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FunderDto" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v{version}/fundings": { "get": { "tags": [ "Fundings" ], "summary": "Get total fundings (from all funders)", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "Returns all the funder", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FunderDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FunderDto" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v{version}/fundings/{year}": { "get": { "tags": [ "Fundings" ], "summary": "Get total fundings for a given year (from all funders).", "parameters": [ { "name": "year", "in": "path", "description": "The year (YYYY).", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FundingDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FundingDto" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v{version}/fundings/funders/{funderId}": { "get": { "tags": [ "Fundings" ], "summary": "Get total fundings for a given funder.", "parameters": [ { "name": "funderId", "in": "path", "description": "The id of the funding organisation.", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FundingDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FundingDto" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v{version}/fundings/funders/{funderId}/{year}": { "get": { "tags": [ "Fundings" ], "summary": "Get total fundings for given funder id and a given year.", "parameters": [ { "name": "funderId", "in": "path", "description": "The id of the funding organisation.", "required": true, "schema": { "type": "string" } }, { "name": "year", "in": "path", "description": "The year (YYYY).", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FundingDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FundingDto" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v{version}/fundings/funders/{funderId}/organisations/{orgId}": { "get": { "tags": [ "Fundings" ], "summary": "Get total fundings for given funder id and a given organisation id.", "parameters": [ { "name": "funderId", "in": "path", "description": "The id for the funding organisation you want to get.", "required": true, "schema": { "type": "string" } }, { "name": "orgId", "in": "path", "description": "The id for the coordinating organisation you want to get.", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FundingDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FundingDto" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v{version}/fundings/funders/{funderId}/organisations/{orgId}/{year}": { "get": { "tags": [ "Fundings" ], "summary": "Get total fundings for given funder id, a given organisation id and a given year.", "parameters": [ { "name": "funderId", "in": "path", "description": "The id for the funding organisation you want to get.", "required": true, "schema": { "type": "string" } }, { "name": "orgId", "in": "path", "description": "The id for the coordinating organisation you want to get.", "required": true, "schema": { "type": "string" } }, { "name": "year", "in": "path", "description": "The year (YYYY).", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FundingDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FundingDto" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v{version}/organisations": { "get": { "tags": [ "Organisations" ], "summary": "Get all organisations.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationDto" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v{version}/organisations/{orgId}": { "get": { "tags": [ "Organisations" ], "summary": "Get organisation by organisation id.", "parameters": [ { "name": "orgId", "in": "path", "description": "The id for the organisation you want to get.", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganisationDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OrganisationDto" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v{version}/organisations/projects/{projectId}": { "get": { "tags": [ "Organisations" ], "summary": "Get all organisations in a project by given project id.", "parameters": [ { "name": "projectId", "in": "path", "description": "The id for the project you want to get", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationDto" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v{version}/persons": { "get": { "tags": [ "Persons" ], "summary": "Get all persons.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PersonDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PersonDto" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v{version}/persons/{personId}": { "get": { "tags": [ "Persons" ], "summary": "Get a person by person id", "parameters": [ { "name": "personId", "in": "path", "description": "The id of the person you want to get", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PersonDto" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v{version}/persons/orcId/{orcId}": { "get": { "tags": [ "Persons" ], "summary": "Get a users by orc id", "parameters": [ { "name": "orcId", "in": "path", "description": "The id of the orc you want to get", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PersonDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PersonDto" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v{version}/persons/organisations/{orgId}": { "get": { "tags": [ "Persons" ], "summary": "Get all persons by a given org id", "parameters": [ { "name": "orgId", "in": "path", "description": "The id of the organisation you want", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PersonDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PersonDto" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v{version}/persons/projects/{projectId}": { "get": { "tags": [ "Persons" ], "summary": "Get all persons by a given project id.", "parameters": [ { "name": "projectId", "in": "path", "description": "The id for the project you want.", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PersonDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PersonDto" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v{version}/projects": { "get": { "tags": [ "Projects" ], "summary": "Get all projects.", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "size", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 999999999 } }, { "name": "loadedFromDate", "in": "query", "schema": { "type": "string", "default": "" } }, { "name": "updatedFromDate", "in": "query", "schema": { "type": "string", "default": "" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectDto" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v{version}/projects/{projectId}": { "get": { "tags": [ "Projects" ], "summary": "Get project by project id.", "parameters": [ { "name": "projectId", "in": "path", "description": "The id for the project", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProjectDto" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v{version}/projects/scb5/{scb5Id}": { "get": { "tags": [ "Projects" ], "summary": "Get all projects by a scb5 id.", "parameters": [ { "name": "scb5Id", "in": "path", "description": "The id of the scb5", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectDto" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v{version}/projects/funders/{funderId}": { "get": { "tags": [ "Projects" ], "summary": "Get all projects by funder id.", "parameters": [ { "name": "funderId", "in": "path", "description": "The id of the funder", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectDto" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v{version}/projects/funders/{funderId}/scb5/{scb5Id}": { "get": { "tags": [ "Projects" ], "summary": "Get all projects by funder id and scb5 id.", "parameters": [ { "name": "funderId", "in": "path", "description": "The id of the funder", "required": true, "schema": { "type": "string" } }, { "name": "scb5Id", "in": "path", "description": "The id of the scb5", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectDto" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v{version}/projects/organisations/{orgId}": { "get": { "tags": [ "Projects" ], "summary": "Get all projects by coordinating organisation id.", "parameters": [ { "name": "orgId", "in": "path", "description": "The id of the organisation", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectDto" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v{version}/projects/organisations/{orgId}/scb5/{scb5Id}": { "get": { "tags": [ "Projects" ], "summary": "Get all projects by coordinating organisation id and scb5 id.", "parameters": [ { "name": "orgId", "in": "path", "description": "The id of the organisation.", "required": true, "schema": { "type": "string" } }, { "name": "scb5Id", "in": "path", "description": "The id of the scb5.", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectDto" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v{version}/projects/organisations/{orgId}/funders/{funderId}": { "get": { "tags": [ "Projects" ], "summary": "Get all projects by coordinating organisation id and funding organisation id.", "parameters": [ { "name": "orgId", "in": "path", "description": "The id of the organisation.", "required": true, "schema": { "type": "string" } }, { "name": "funderId", "in": "path", "description": "The id of the funder.", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectDto" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v{version}/projects/organisations/{orgId}/funders/{funderId}/scb5/{scb5Id}": { "get": { "tags": [ "Projects" ], "summary": "Get all projects by coordinating organisation id and funding organisation id and scb5 id.", "parameters": [ { "name": "orgId", "in": "path", "description": "The id of the organisation.", "required": true, "schema": { "type": "string" } }, { "name": "funderId", "in": "path", "description": "The id of the funder.", "required": true, "schema": { "type": "string" } }, { "name": "scb5Id", "in": "path", "description": "The id of the scb5.", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectDto" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v{version}/projects/persons/{personId}": { "get": { "tags": [ "Projects" ], "summary": "Get all projects by person id.", "parameters": [ { "name": "personId", "in": "path", "description": "The id of a person", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectDto" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v{version}/projects/persons/orcId/{orcId}": { "get": { "tags": [ "Projects" ], "summary": "Get all projects by orc id.", "parameters": [ { "name": "orcId", "in": "path", "description": "The id of the orc", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectDto" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "204": { "description": "Success" } } } }, "/v{version}/scb5": { "get": { "tags": [ "Scb" ], "summary": "Get all scb codes.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScbDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScbDto" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v{version}/scb5/{scb5Id}": { "get": { "tags": [ "Scb" ], "summary": "Get the scb codes by a scb5 id.", "parameters": [ { "name": "scb5Id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScbDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ScbDto" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v{version}/scb5/projects/{projectId}": { "get": { "tags": [ "Scb" ], "summary": "Get all scb5 by a given project id.", "parameters": [ { "name": "projectId", "in": "path", "description": "The id of the project", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScbDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScbDto" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v{version}/scp/funders": { "get": { "tags": [ "Scp" ], "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScpFunderDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScpFunderDto" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v{version}/scp/scbs": { "get": { "tags": [ "Scp" ], "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScpScbDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScpScbDto" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v{version}/scp/organisationtypes": { "get": { "tags": [ "Scp" ], "summary": "Get all organisation types - Used by the SweCRIS portal.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "Returns all organisation types.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScpOrganisationTypeDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScpOrganisationTypeDto" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v{version}/scp/fundings-per-year": { "get": { "tags": [ "Scp" ], "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScpFundPerYearDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScpFundPerYearDto" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v{version}/scp/fundings-per-scb1": { "get": { "tags": [ "Scp" ], "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScpFundPerScb1Dto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScpFundPerScb1Dto" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v{version}/scp/projects-per-year": { "get": { "tags": [ "Scp" ], "summary": "Get Projects per year - Used by the SweCRIS portal.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScpProjectsPerYearDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScpProjectsPerYearDto" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v{version}/scp/search": { "get": { "tags": [ "Scp" ], "operationId": "search", "parameters": [ { "name": "scbIds[]", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "fundingOrganisation[]", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "organisationType[]", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "year[]", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "size", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 999999999 } }, { "name": "searchText", "in": "query", "schema": { "type": "string" } }, { "name": "sortOrder", "in": "query", "schema": { "type": "string", "default": "desc" } }, { "name": "sortColumn", "in": "query", "schema": { "type": "string", "default": "ProjectId" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SearchResult" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v{version}/scp/export": { "get": { "tags": [ "Scp" ], "operationId": "export", "parameters": [ { "name": "scbIds[]", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "fundingOrganisation[]", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "organisationType[]", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "year[]", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "size", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 999999999 } }, { "name": "token", "in": "query", "schema": { "type": "string" } }, { "name": "searchText", "in": "query", "schema": { "type": "string", "default": "" } }, { "name": "sortOrder", "in": "query", "schema": { "type": "string", "default": "desc" } }, { "name": "sortColumn", "in": "query", "schema": { "type": "string", "default": "ProjectId" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string", "format": "binary" } }, "application/xml": { "schema": { "type": "string", "format": "binary" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } } }, "components": { "schemas": { "FunderDto": { "required": [ "fundingAmountSek", "projectId" ], "type": "object", "properties": { "fundingOrganisationId": { "maxLength": 12, "type": "string", "description": "The id of the funding organisation.", "nullable": true }, "fundingOrganisationNameSv": { "maxLength": 255, "type": "string", "description": "The name of the funding organisation in Swedish.", "nullable": true }, "fundingOrganisationNameEn": { "maxLength": 255, "type": "string", "description": "The name of the funding organisation in English.", "nullable": true }, "fundingAmountSek": { "type": "number", "description": "The funding amount in SEK.", "format": "double" }, "fundingStartDate": { "maxLength": 25, "type": "string", "description": "The start date of the funding.", "nullable": true }, "fundingEndDate": { "maxLength": 25, "type": "string", "description": "The end date of the funding.", "nullable": true }, "projectId": { "maxLength": 50, "type": "string", "description": "The id of the funded project." } }, "additionalProperties": false, "description": "A funder with the following information:\r\nfunding organisation id, \r\nfunding organisation name Sv, \r\nfunding organisation name En,\r\nfunding amount SEK,\r\nfunding start date,\r\nfunding end date,\r\nfunded project id." }, "FundingDto": { "required": [ "projectId" ], "type": "object", "properties": { "fundingOrganisationId": { "type": "string", "description": "The id of the funding organisation.", "nullable": true }, "fundingOrganisationNameSv": { "type": "string", "description": "The name of the funding organisation in Swedish.", "nullable": true }, "fundingOrganisationNameEn": { "type": "string", "description": "The name of the funding organisation in English.", "nullable": true }, "fundingAmountSek": { "type": "number", "description": "The funding amount in SEK", "format": "double" }, "fundingStartDate": { "type": "string", "description": "The start date of the funding.", "nullable": true }, "fundingEndDate": { "type": "string", "description": "The end date of the funding.", "nullable": true }, "projectId": { "maxLength": 50, "type": "string", "description": "The id of the funded project." }, "coordinatingOrganisationId": { "type": "string", "description": "The id of the coordinating organisation.", "nullable": true }, "coordinatingOrganisationNameSv": { "type": "string", "description": "The name of the coordinator in Swedish", "nullable": true }, "coordinatingOrganisationNameEn": { "type": "string", "description": "The name of the coordinator in English", "nullable": true } }, "additionalProperties": false, "description": "A funding with the following information:\r\nfunding organisation id,\r\nfunding organisation name Sv,\r\nfunding organisation name En,\r\nfunding amount SEK,\r\nfunding start date.\r\nfunding end date,\r\nfunded project id," }, "InvolvedPerson": { "type": "object", "properties": { "personId": { "type": "string", "nullable": true }, "fullName": { "type": "string", "nullable": true }, "orcId": { "type": "string", "nullable": true }, "roleEn": { "type": "string", "nullable": true }, "roleSv": { "type": "string", "nullable": true }, "gender": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OrganisationDto": { "required": [ "organisationId" ], "type": "object", "properties": { "organisationId": { "maxLength": 12, "type": "string", "description": "The id of the organisation." }, "organisationNameSv": { "maxLength": 255, "type": "string", "description": "The name of the organisation in Swedish.", "nullable": true }, "organisationNameEn": { "maxLength": 255, "type": "string", "description": "The name of the organisation in English.", "nullable": true }, "organisationTypeSv": { "maxLength": 39, "type": "string", "description": "The type of organisation in Swedish.", "nullable": true }, "organisationTypeEn": { "maxLength": 25, "type": "string", "description": "The type of organisation in English.", "nullable": true }, "relatedProjectIds": { "type": "string", "description": "The id of the related projects.", "nullable": true } }, "additionalProperties": false, "description": "A organisation with:\r\norganisation id,\r\norganisation name Sv,\r\norganisation name En,\r\norganisation type Sv,\r\norganisation type En,\r\nids of related projects." }, "PersonDto": { "required": [ "personId" ], "type": "object", "properties": { "personId": { "type": "integer", "description": "The id of the person.", "format": "int32" }, "firstName": { "type": "string", "description": "The first names of the person.", "nullable": true }, "lastName": { "type": "string", "description": "The last names of the person.", "nullable": true }, "fullName": { "type": "string", "description": "The full name of the person(First name and Last name).", "nullable": true }, "organisations": { "type": "string", "description": "The related organisations.", "nullable": true }, "relatedProjectIds": { "type": "string", "description": "The related projects to the person.", "nullable": true }, "orcId": { "maxLength": 19, "type": "string", "description": "The Orc id of the person.", "nullable": true } }, "additionalProperties": false, "description": "A person with a person id,\r\nfirst name,\r\nlast name,\r\nfull name,\r\nemails,\r\norganisations,\r\nrelated persons,\r\norcId." }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } }, "additionalProperties": { } }, "ProjectDto": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "maxLength": 50, "type": "string", "description": "The id of the project." }, "projectTitleSv": { "maxLength": 255, "type": "string", "description": "The title of the project in Swedish.", "nullable": true }, "projectTitleEn": { "maxLength": 255, "type": "string", "description": "The title of the project in English.", "nullable": true }, "projectAbstractSv": { "type": "string", "description": "The abstract of the project in Swedish.", "nullable": true }, "projectAbstractEn": { "type": "string", "description": "The abstract of the project in English.", "nullable": true }, "projectStartDate": { "maxLength": 25, "type": "string", "description": "The start date of the project.", "nullable": true }, "projectEndDate": { "maxLength": 25, "type": "string", "description": "The end date of the project.", "nullable": true }, "coordinatingOrganisationId": { "maxLength": 12, "type": "string", "description": "The id of the coordinating organisation.", "nullable": true }, "coordinatingOrganisationNameSv": { "maxLength": 255, "type": "string", "description": "The name of the coordinating organisation in Swedish.", "nullable": true }, "coordinatingOrganisationNameEn": { "maxLength": 255, "type": "string", "description": "The name of the coordinating organisation in English.", "nullable": true }, "coordinatingOrganisationTypeOfOrganisationSv": { "maxLength": 39, "type": "string", "description": "The type of coordinating organisation in swedish.", "nullable": true }, "coordinatingOrganisationTypeOfOrganisationEn": { "maxLength": 25, "type": "string", "description": "The type of coordinating organisation in english.", "nullable": true }, "fundingOrganisationId": { "maxLength": 12, "type": "string", "description": "The id of the funding organisation.", "nullable": true }, "fundingOrganisationNameSv": { "maxLength": 255, "type": "string", "description": "The name of the funding organisation in Swedish.", "nullable": true }, "fundingOrganisationNameEn": { "maxLength": 255, "type": "string", "description": "The name of the funding organisation in English.", "nullable": true }, "fundingOrganisationTypeOfOrganisationSv": { "maxLength": 39, "type": "string", "description": "The type of funding organisation in swedish.", "nullable": true }, "fundingOrganisationTypeOfOrganisationEn": { "maxLength": 25, "type": "string", "description": "The type of coordinating organisation in english.", "nullable": true }, "fundingsSek": { "type": "number", "description": "The funding amount in SEK.", "format": "double", "nullable": true }, "fundingYear": { "maxLength": 4, "type": "string", "description": "The funding year.", "nullable": true }, "fundingStartDate": { "maxLength": 25, "type": "string", "description": "The funding start date.", "nullable": true }, "fundingEndDate": { "maxLength": 25, "type": "string", "description": "The funding end date.", "nullable": true }, "typeOfAwardId": { "type": "integer", "description": "The Sc type of award id.", "format": "int32", "nullable": true }, "typeOfAwardDescrSv": { "maxLength": 50, "type": "string", "description": "The type of award description in swedish.", "nullable": true }, "typeOfAwardDescrEn": { "maxLength": 50, "type": "string", "description": "The type of award description in english.", "nullable": true }, "updatedDate": { "type": "string", "description": "Date the project was last updated", "format": "date-time", "nullable": true }, "loadedDate": { "type": "string", "description": "Date the project was loaded", "format": "date-time" }, "peopleList": { "type": "array", "items": { "$ref": "#/components/schemas/InvolvedPerson" }, "description": "A list of the involved people.", "nullable": true }, "scbs": { "type": "array", "items": { "$ref": "#/components/schemas/ScpScbDto" }, "nullable": true } }, "additionalProperties": false, "description": "A project with the following data:\r\nproject id,\r\nproject title Sv,\r\nproject title En,\r\nproject abstract Sv,\r\nproject abstract En,\r\nproject start date,\r\nproject end date,\r\ncoordinating organisation id,\r\ncoordinating organisation name Sv,\r\ncoordinating organisation name En,\r\ntype of coordinating organisation Sv,\r\ntype of coordinating organisation En,\r\nfunding organisation id,\r\nfunding organisation name Sv,\r\nfunding organisation name En,\r\ntype of funding organisation Sv,\r\ntype of funding organisation En,\r\nfunding amount sek,\r\nfunding year,\r\nfunding start date,\r\nfunding end date,\r\nSCB5 Id 1st layer,\r\nSCB3 Id 1st layer,\r\nSCB1 Id 1st layer,\r\nSCB5 Id 2nd layer,\r\nSCB3 Id 2nd layer,\r\nSCB1 Id 2nd layer,\r\nSCB5 Id 3rd layer,\r\nSCB3 Id 3rd layer,\r\nSCB1 Id 3rd layer,\r\nSCB5 Id 4th layer,\r\nSCB3 Id 4th layer,\r\nSCB1 Id 4th layer,\r\nSCB5 Id 5th layer,\r\nSCB3 Id 5th layer,\r\nSCB1 Id 5th layer,\r\nSCB5 count,\r\nfundings 1st layer,\r\nfundings 2st layer,\r\nfundings 3st layer,\r\nfundings 4st layer,\r\nfundings 5st layer,\r\ntype of award id,\r\ntype of award description Sv,\r\ntype of award description En,\r\na list of the involved people." }, "ScbDto": { "required": [ "projectId", "scb1Id", "scb3Id", "scb5NameEn", "scb5NameSv" ], "type": "object", "properties": { "scb5Id": { "maxLength": 5, "type": "string", "description": "The id of the SCB5.", "nullable": true }, "scb5NameSv": { "maxLength": 255, "type": "string", "description": "The name of the SCB5 in Swedish." }, "scb5NameEn": { "maxLength": 255, "type": "string", "description": "The name of the SCB5 in English." }, "scb3Id": { "maxLength": 3, "type": "string", "description": "The id of the SCB3." }, "scb3NameSv": { "maxLength": 255, "type": "string", "description": "The name of the SCB3 in Swedish.", "nullable": true }, "scb3NameEn": { "maxLength": 255, "type": "string", "description": "The name of the SCB3 in English.", "nullable": true }, "scb1Id": { "maxLength": 1, "type": "string", "description": "The id of the SCB1" }, "scb1NameSv": { "maxLength": 255, "type": "string", "description": "The name of the SCB1 in Swedish", "nullable": true }, "scb1NameEn": { "maxLength": 255, "type": "string", "description": "The name of the SCB1 in English", "nullable": true }, "projectId": { "maxLength": 50, "type": "string", "description": "The id of a project" } }, "additionalProperties": false, "description": "A SCB with SCB5 id,\r\nSCB5 name Sv,\r\nSCB5 name En,\r\nSCB3 id,\r\nSCB3 name Sv,\r\nSCB3 name En,\r\nSCB1 id,\r\nSCB1 name Sv,\r\nSCB1 name En,\r\nids of related projects." }, "ScpFunderDto": { "type": "object", "properties": { "fundingOrganisationId": { "maxLength": 12, "type": "string", "description": "The id of the funding organisation.", "nullable": true }, "fundingOrganisationNameSv": { "maxLength": 255, "type": "string", "description": "The name of the funding organisation in Swedish.", "nullable": true }, "fundingOrganisationNameEn": { "maxLength": 255, "type": "string", "description": "The name of the funding organisation in English.", "nullable": true } }, "additionalProperties": false, "description": "A funder with the following information:\r\nfunding organisation id, \r\nfunding organisation name Sv, \r\nfunding organisation name En," }, "ScpFundPerScb1Dto": { "required": [ "scb1Id" ], "type": "object", "properties": { "scb1Id": { "maxLength": 1, "type": "string", "description": "The scb1 id." }, "scb1NameSv": { "maxLength": 255, "type": "string", "description": "The scb1 name sv.", "nullable": true }, "scb1NameEn": { "maxLength": 255, "type": "string", "description": "The scb1 name en.", "nullable": true }, "totalFundingsSek": { "type": "number", "description": "The total funding amount in sek.", "format": "double", "nullable": true } }, "additionalProperties": false, "description": "Funder per Scb1 with this information:\r\nscb1 id,\r\nscb1 name sv,\r\nscb1 name en,\r\ntotal funding amount in sek." }, "ScpFundPerYearDto": { "type": "object", "properties": { "startYear": { "maxLength": 4, "type": "string", "description": "The start year.", "nullable": true }, "totalFundingsSek": { "maxLength": 50, "type": "number", "description": "The total amount of funding in sek.", "format": "double", "nullable": true } }, "additionalProperties": false, "description": "Fund per year with the following information:\r\nthe start year,\r\nthe total amount of funding in sek." }, "ScpOrganisationTypeDto": { "required": [ "organisationTypeEn", "organisationTypeSv" ], "type": "object", "properties": { "organisationTypeEn": { "maxLength": 25, "type": "string", "description": "The type of organisation in English." }, "organisationTypeSv": { "maxLength": 39, "type": "string", "description": "The type of organisation in Swedish." } }, "additionalProperties": false, "description": "Organisation type with this information:\r\norganisation type En,\r\norganisation type Sv." }, "ScpProjectsPerYearDto": { "type": "object", "properties": { "startYear": { "maxLength": 4, "type": "string", "description": "The start year.", "nullable": true }, "noOfProjects": { "type": "integer", "description": "The number of projects.", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "Project per year with:\r\nthe start year\r\nthe number of projects," }, "ScpScbDto": { "required": [ "scb1Id", "scb3Id", "scb5NameEn", "scb5NameSv" ], "type": "object", "properties": { "scb5Id": { "maxLength": 5, "type": "string", "description": "The id of the SCB5.", "nullable": true }, "scb5NameSv": { "maxLength": 255, "type": "string", "description": "The name of the SCB5 in Swedish." }, "scb5NameEn": { "maxLength": 255, "type": "string", "description": "The name of the SCB5 in English." }, "scb3Id": { "maxLength": 3, "type": "string", "description": "The id of the SCB3." }, "scb3NameSv": { "maxLength": 255, "type": "string", "description": "The name of the SCB3 in Swedish.", "nullable": true }, "scb3NameEn": { "maxLength": 255, "type": "string", "description": "The name of the SCB3 in English.", "nullable": true }, "scb1Id": { "maxLength": 1, "type": "string", "description": "The id of the SCB1" }, "scb1NameSv": { "maxLength": 255, "type": "string", "description": "The name of the SCB1 in Swedish", "nullable": true }, "scb1NameEn": { "maxLength": 255, "type": "string", "description": "The name of the SCB1 in English", "nullable": true } }, "additionalProperties": false, "description": "A SCB with:\r\nSCB5 id,\r\nSCB5 name Sv,\r\nSCB5 name En,\r\nSCB3 id,\r\nSCB3 name Sv,\r\nSCB3 name En,\r\nSCB1 id,\r\nSCB1 name Sv,\r\nSCB1 name En," }, "ScpSweCrisCompleteDto": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "maxLength": 50, "type": "string", "description": "The id of the project." }, "projectTitleSv": { "maxLength": 255, "type": "string", "description": "The title of the project in Swedish.", "nullable": true }, "projectTitleEn": { "maxLength": 255, "type": "string", "description": "The title of the project in English.", "nullable": true }, "projectAbstractSv": { "type": "string", "description": "The abstract of the project in Swedish.", "nullable": true }, "projectAbstractEn": { "type": "string", "description": "The abstract of the project in English.", "nullable": true }, "projectStartDate": { "maxLength": 25, "type": "string", "description": "The start date of the project.", "nullable": true }, "projectEndDate": { "maxLength": 25, "type": "string", "description": "The end date of the project.", "nullable": true }, "coordinatingOrganisationId": { "maxLength": 12, "type": "string", "description": "The id of the coordinating organisation.", "nullable": true }, "coordinatingOrganisationNameSv": { "maxLength": 255, "type": "string", "description": "The name of the coordinating organisation in Swedish.", "nullable": true }, "coordinatingOrganisationNameEn": { "maxLength": 255, "type": "string", "description": "The name of the coordinating organisation in English.", "nullable": true }, "coordinatingOrganisationTypeOfOrganisationSv": { "maxLength": 39, "type": "string", "description": "The type of coordinating organisation in swedish.", "nullable": true }, "coordinatingOrganisationTypeOfOrganisationEn": { "maxLength": 25, "type": "string", "description": "The type of coordinating organisation in english.", "nullable": true }, "fundingOrganisationId": { "maxLength": 12, "type": "string", "description": "The id of the funding organisation.", "nullable": true }, "fundingOrganisationNameSv": { "maxLength": 255, "type": "string", "description": "The name of the funding organisation in Swedish.", "nullable": true }, "fundingOrganisationNameEn": { "maxLength": 255, "type": "string", "description": "The name of the funding organisation in English.", "nullable": true }, "fundingOrganisationTypeOfOrganisationSv": { "maxLength": 39, "type": "string", "description": "The type of funding organisation in swedish.", "nullable": true }, "fundingOrganisationTypeOfOrganisationEn": { "maxLength": 25, "type": "string", "description": "The type of coordinating organisation in english.", "nullable": true }, "fundingsSek": { "type": "number", "description": "The funding amount in SEK.", "format": "double", "nullable": true }, "fundingYear": { "maxLength": 4, "type": "string", "description": "The funding year.", "nullable": true }, "fundingStartDate": { "maxLength": 25, "type": "string", "description": "The funding start date.", "nullable": true }, "fundingEndDate": { "maxLength": 25, "type": "string", "description": "The funding end date.", "nullable": true }, "typeOfAwardId": { "type": "integer", "description": "The Sc type of award id.", "format": "int32", "nullable": true }, "typeOfAwardDescrSv": { "maxLength": 50, "type": "string", "description": "The type of award description in swedish.", "nullable": true }, "typeOfAwardDescrEn": { "maxLength": 50, "type": "string", "description": "The type of award description in english.", "nullable": true }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true }, "loadedDate": { "type": "string", "format": "date-time" }, "peopleList": { "type": "array", "items": { "$ref": "#/components/schemas/InvolvedPerson" }, "description": "A list of the involved people.", "nullable": true }, "scbs": { "type": "array", "items": { "$ref": "#/components/schemas/ScpScbDto" }, "description": "A list of the scb5 codes.", "nullable": true } }, "additionalProperties": false, "description": "A SweCRIS complete with the following data:\r\nproject id,\r\nproject title Sv,\r\nproject title En,\r\nproject abstract Sv,\r\nproject abstract En,\r\nproject start date,\r\nproject end date,\r\ncoordinating organisation id,\r\ncoordinating organisation name Sv,\r\ncoordinating organisation name En,\r\ntype of coordinating organisation Sv,\r\ntype of coordinating organisation En,\r\nfunding organisation id,\r\nfunding organisation name Sv,\r\nfunding organisation name En,\r\ntype of funding organisation Sv,\r\ntype of funding organisation En,\r\nfunding amount sek,\r\nfunding year,\r\nfunding start date,\r\nfunding end date,\r\nSCB5 Id 1st layer,\r\nSCB3 Id 1st layer,\r\nSCB1 Id 1st layer,\r\nSCB5 Id 2nd layer,\r\nSCB3 Id 2nd layer,\r\nSCB1 Id 2nd layer,\r\nSCB5 Id 3rd layer,\r\nSCB3 Id 3rd layer,\r\nSCB1 Id 3rd layer,\r\nSCB5 Id 4th layer,\r\nSCB3 Id 4th layer,\r\nSCB1 Id 4th layer,\r\nSCB5 Id 5th layer,\r\nSCB3 Id 5th layer,\r\nSCB1 Id 5th layer,\r\nSCB5 count,\r\nfundings 1st layer,\r\nfundings 2st layer,\r\nfundings 3st layer,\r\nfundings 4st layer,\r\nfundings 5st layer,\r\ntype of award id,\r\ntype of award description Sv,\r\ntype of award description En,\r\na list of the involved people." }, "SearchResult": { "type": "object", "properties": { "result": { "type": "array", "items": { "$ref": "#/components/schemas/ScpSweCrisCompleteDto" }, "description": "The search result", "nullable": true }, "total": { "type": "integer", "description": "Total matches from the search query, useful when using page/size parameters", "format": "int64" }, "yearlyCompilation": { "type": "array", "items": { }, "description": "Compilation of number projects per year and total fundings per year based on search criteria", "nullable": true }, "scb1IdCompilation": { "type": "array", "items": { }, "description": "Compilation of fundings per Scb1Id based on search criteria", "nullable": true } }, "additionalProperties": false } } } }