Protocol service – Protocols – Backend API

Protocol service

Copy Markdown

Open in

POST

/api/protocol-service

The request body should be a serialized ProtocolServiceRequest (string). The response body will also be serialized (string). The request-response mappings are as follows:

Add -> Unit
AddVersion -> Unit
UpdateParticipantDataConfiguration -> StudyProtocolSnapshot
GetBy -> StudyProtocolSnapshot
GetAllForOwner -> StudyProtocolSnapshot[]
GetVersionHistoryFor -> ProtocolVersion[]

Authorization

bearer

headerAuthorizationBearer <token>

Provide the username and password of the user

Request body

application/json

body

protocol*

versionTag*string

apiVersion*

responseSerializer*

Response body

*/*

response

Example request

curl -X POST 'https://dev.carp.dk/api/protocol-service' \  -H 'Content-Type: application/json' \  -d '{  "protocol": {},  "versionTag": "string",  "apiVersion": {    "major": 0,    "minor": 0  },  "responseSerializer": {    "descriptor": {      "annotations": [        {}      ],      "serialName": "string",      "elementsCount": 0,      "isInline": true,      "kind": null,      "isNullable": true    }  }}'

Example responseSchema

{}