Note
Endpoints for Note
ReferenceView as Markdown
Endpoints for Note
POST/api/v1/note
Authentication: Bearer token (JWT)
application/jsonnotestringRequiredmaxLength: 10000memberIdstringRequired{
"note": "string",
"memberId": "string"
}idnumberRequirednotestringRequiredmemberIdstringRequiredadminUserIdcurlcurl https://api.subrite.no/api/v1/note \
--request POST \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"note": "string",
"memberId": "string"
}'DELETE/api/v1/note/{id}
Authentication: Bearer token (JWT)
idnumberRequiredThis response has no body.
PATCH/api/v1/note/{id}
Authentication: Bearer token (JWT)
idnumberRequiredapplication/jsonnotestringRequiredmaxLength: 10000numberadminUserNamestringRequiredcreatedAtstring (date-time)Required{
"id": 0,
"note": "string",
"memberId": "string",
"adminUserId": 0,
"adminUserName": "<adminUserName>",
"createdAt": "2019-08-24T14:15:22Z"
}shouldNotBeEmpty, invalidFormat
messageCodestringRequired"shouldNotBeEmpty", "invalidFormat"messagestringerrorsarray of FieldErrorRequired7 fieldserrorsfieldstringRequired when parent is presentField path: errors[].fieldfieldValuestringRequired when parent is presentField path: errors[].fieldValueidentifierstringRequired when parent is presentField path: errors[].identifieridentifierValuestringRequired when parent is presentField path: errors[].identifierValuemessageCodestringRequired when parent is presentField path: errors[].messageCodemessagestringField path: errors[].messageerrorTypestringRequired when parent is present{
"messageCode": "shouldNotBeEmpty",
"message": "string",
"errors": [
{}
]
}unauthorized
This response has no body.
forbiddenResource
messageCodestringRequiredmessagestringerrorsarray of FieldErrorRequired7 fieldserrorsfieldstringRequired when parent is presentField path: errors[].fieldfieldValuestringRequired when parent is presentField path: errors[].fieldValueidentifierstringRequired when parent is presentField path: errors[].identifieridentifierValuestringRequired when parent is presentField path: errors[].identifierValuemessageCodestringRequired when parent is presentField path: errors[].messageCodemessagestringField path: errors[].messageerrorTypestringRequired when parent is presentField path: errors[].errorType{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}memberNotFound
messageCodestringRequired"memberNotFound"messagestringerrorsarray of FieldErrorRequired7 fieldserrorsfieldstringRequired when parent is presentField path: errors[].fieldfieldValuestringRequired when parent is presentField path: errors[].fieldValueidentifierstringRequired when parent is presentField path: errors[].identifieridentifierValuestringRequired when parent is presentField path: errors[].identifierValuemessageCodestringRequired when parent is presentField path: errors[].messageCodemessagestringField path: errors[].messageerrorTypestringRequired when parent is present{
"messageCode": "memberNotFound",
"message": "string",
"errors": [
{}
]
}application/jsonshouldNotBeEmpty, badRequest
messageCodestringRequired"shouldNotBeEmpty", "badRequest"messagestringerrorsarray of FieldErrorRequired7 fieldserrorsfieldstringRequired when parent is presentField path: errors[].fieldfieldValuestringRequired when parent is presentField path: errors[].fieldValueidentifierstringRequired when parent is presentField path: errors[].identifieridentifierValuestringRequired when parent is presentField path: errors[].identifierValuemessageCodestringRequired when parent is presentField path: errors[].messageCodemessagestringField path: errors[].messageerrorTypestringRequired when parent is presentField path: errors[].errorType{
"messageCode": "shouldNotBeEmpty",
"message": "string",
"errors": [
{}
]
}unauthorized
This response has no body.
forbiddenResource
Same fields as Create a note on member (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}notFound
messageCodestringRequired"notFound"messagestringerrorsarray of FieldErrorRequired7 fieldserrorsfieldstringRequired when parent is presentField path: errors[].fieldfieldValuestringRequired when parent is presentField path: errors[].fieldValueidentifierstringRequired when parent is presentField path: errors[].identifieridentifierValuestringRequired when parent is presentField path: errors[].identifierValuemessageCodestringRequired when parent is presentField path: errors[].messageCodemessagestringField path: errors[].messageerrorTypestringRequired when parent is present{
"messageCode": "notFound",
"message": "string",
"errors": [
{}
]
}curlcurl 'https://api.subrite.no/api/v1/note/{id}' \
--request DELETE \
--header 'Authorization: Bearer <token>'{
"note": "string"
}Same fields as Create a note on member (201).
{
"id": 0,
"note": "string",
"memberId": "string",
"adminUserId": 0,
"adminUserName": "<adminUserName>",
"createdAt": "2019-08-24T14:15:22Z"
}badRequest, shouldNotBeEmpty, invalidFormat
messageCodestringRequired"badRequest", "shouldNotBeEmpty", "invalidFormat"messagestringerrorsunauthorized
This response has no body.
forbiddenResource
Same fields as Create a note on member (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}notFound
Same fields as delete a note (404).
{
"messageCode": "notFound",
"message": "string",
"errors": [
{}
]
}curlcurl 'https://api.subrite.no/api/v1/note/{id}' \
--request PATCH \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"note": "string"
}'array of FieldErrorerrorsfieldstringRequired when parent is presentField path: errors[].fieldfieldValuestringRequired when parent is presentField path: errors[].fieldValueidentifierstringRequired when parent is presentField path: errors[].identifieridentifierValuestringRequired when parent is presentField path: errors[].identifierValuemessageCodestringRequired when parent is presentField path: errors[].messageCodemessagestringField path: errors[].messageerrorTypestringRequired when parent is presentField path: errors[].errorType{
"messageCode": "badRequest",
"message": "string",
"errors": [
{}
]
}