UPDATE a consent
PATCH {{baseUrl}}/consent/v1/consents/{{consentRecordId}}
The PATCH consent/v1/consents/{{consentRecordId}} operation modifies a consent record by specifying only the changes to be made. The request body is a partial representation of the consent record with changes only.
Body
raw ( application/json )
{
"status": "<string>",
"subject": "<string>",
"actor": "<string>",
"audience": "<string>",
"definition": {
"id": "<string>",
"version": "<string>",
"locale": "<string>"
},
"dataText": "<string>",
"purposeText": "<string>",
"data": "<object>",
"consentContext": "<object>"
}
Example Request
-
cURL
-
C#
-
Go
-
HTTP
-
Java
-
jQuery
-
NodeJS
-
Python
-
PHP
-
Ruby
-
Swift
curl --location --globoff --request PATCH '{{baseUrl}}/consent/v1/consents/{{consentRecordId}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
"status": "<string>",
"subject": "<string>",
"actor": "<string>",
"audience": "<string>",
"definition": {
"id": "<string>",
"version": "<string>",
"locale": "<string>"
},
"dataText": "<string>",
"purposeText": "<string>",
"data": "<object>",
"consentContext": "<object>"
}'
var options = new RestClientOptions("{{baseUrl}}/consent/v1/consents/{{consentRecordId}}")
{
MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Patch);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Bearer {{accessToken}}");
var body = @"{" + "\n" +
@" ""status"": ""<string>""," + "\n" +
@" ""subject"": ""<string>""," + "\n" +
@" ""actor"": ""<string>""," + "\n" +
@" ""audience"": ""<string>""," + "\n" +
@" ""definition"": {" + "\n" +
@" ""id"": ""<string>""," + "\n" +
@" ""version"": ""<string>""," + "\n" +
@" ""locale"": ""<string>""" + "\n" +
@" }," + "\n" +
@" ""dataText"": ""<string>""," + "\n" +
@" ""purposeText"": ""<string>""," + "\n" +
@" ""data"": ""<object>""," + "\n" +
@" ""consentContext"": ""<object>""" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/consent/v1/consents/{{consentRecordId}}"
method := "PATCH"
payload := strings.NewReader(`{
"status": "<string>",
"subject": "<string>",
"actor": "<string>",
"audience": "<string>",
"definition": {
"id": "<string>",
"version": "<string>",
"locale": "<string>"
},
"dataText": "<string>",
"purposeText": "<string>",
"data": "<object>",
"consentContext": "<object>"
}`)
client := &http.Client {
}
req, err := http.NewRequest(method, url, payload)
if err != nil {
fmt.Println(err)
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Authorization", "Bearer {{accessToken}}")
res, err := client.Do(req)
if err != nil {
fmt.Println(err)
return
}
defer res.Body.Close()
body, err := io.ReadAll(res.Body)
if err != nil {
fmt.Println(err)
return
}
fmt.Println(string(body))
}
PATCH /consent/v1/consents/{{consentRecordId}} HTTP/1.1
Host: {{baseUrl}}
Content-Type: application/json
Authorization: Bearer {{accessToken}}
{
"status": "<string>",
"subject": "<string>",
"actor": "<string>",
"audience": "<string>",
"definition": {
"id": "<string>",
"version": "<string>",
"locale": "<string>"
},
"dataText": "<string>",
"purposeText": "<string>",
"data": "<object>",
"consentContext": "<object>"
}
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"status\": \"<string>\",\n \"subject\": \"<string>\",\n \"actor\": \"<string>\",\n \"audience\": \"<string>\",\n \"definition\": {\n \"id\": \"<string>\",\n \"version\": \"<string>\",\n \"locale\": \"<string>\"\n },\n \"dataText\": \"<string>\",\n \"purposeText\": \"<string>\",\n \"data\": \"<object>\",\n \"consentContext\": \"<object>\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/consent/v1/consents/{{consentRecordId}}")
.method("PATCH", body)
.addHeader("Content-Type", "application/json")
.addHeader("Authorization", "Bearer {{accessToken}}")
.build();
Response response = client.newCall(request).execute();
var settings = {
"url": "{{baseUrl}}/consent/v1/consents/{{consentRecordId}}",
"method": "PATCH",
"timeout": 0,
"headers": {
"Content-Type": "application/json",
"Authorization": "Bearer {{accessToken}}"
},
"data": JSON.stringify({
"status": "<string>",
"subject": "<string>",
"actor": "<string>",
"audience": "<string>",
"definition": {
"id": "<string>",
"version": "<string>",
"locale": "<string>"
},
"dataText": "<string>",
"purposeText": "<string>",
"data": "<object>",
"consentContext": "<object>"
}),
};
$.ajax(settings).done(function (response) {
console.log(response);
});
var request = require('request');
var options = {
'method': 'PATCH',
'url': '{{baseUrl}}/consent/v1/consents/{{consentRecordId}}',
'headers': {
'Content-Type': 'application/json',
'Authorization': 'Bearer {{accessToken}}'
},
body: JSON.stringify({
"status": "<string>",
"subject": "<string>",
"actor": "<string>",
"audience": "<string>",
"definition": {
"id": "<string>",
"version": "<string>",
"locale": "<string>"
},
"dataText": "<string>",
"purposeText": "<string>",
"data": "<object>",
"consentContext": "<object>"
})
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
import requests
import json
url = "{{baseUrl}}/consent/v1/consents/{{consentRecordId}}"
payload = json.dumps({
"status": "<string>",
"subject": "<string>",
"actor": "<string>",
"audience": "<string>",
"definition": {
"id": "<string>",
"version": "<string>",
"locale": "<string>"
},
"dataText": "<string>",
"purposeText": "<string>",
"data": "<object>",
"consentContext": "<object>"
})
headers = {
'Content-Type': 'application/json',
'Authorization': 'Bearer {{accessToken}}'
}
response = requests.request("PATCH", url, headers=headers, data=payload)
print(response.text)
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{baseUrl}}/consent/v1/consents/{{consentRecordId}}');
$request->setMethod('PATCH');
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'Content-Type' => 'application/json',
'Authorization' => 'Bearer {{accessToken}}'
));
$request->setBody('{\n "status": "<string>",\n "subject": "<string>",\n "actor": "<string>",\n "audience": "<string>",\n "definition": {\n "id": "<string>",\n "version": "<string>",\n "locale": "<string>"\n },\n "dataText": "<string>",\n "purposeText": "<string>",\n "data": "<object>",\n "consentContext": "<object>"\n}');
try {
$response = $request->send();
if ($response->getStatus() == 200) {
echo $response->getBody();
}
else {
echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
$response->getReasonPhrase();
}
}
catch(HTTP_Request2_Exception $e) {
echo 'Error: ' . $e->getMessage();
}
require "uri"
require "json"
require "net/http"
url = URI("{{baseUrl}}/consent/v1/consents/{{consentRecordId}}")
http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Bearer {{accessToken}}"
request.body = JSON.dump({
"status": "<string>",
"subject": "<string>",
"actor": "<string>",
"audience": "<string>",
"definition": {
"id": "<string>",
"version": "<string>",
"locale": "<string>"
},
"dataText": "<string>",
"purposeText": "<string>",
"data": "<object>",
"consentContext": "<object>"
})
response = http.request(request)
puts response.read_body
let parameters = "{\n \"status\": \"<string>\",\n \"subject\": \"<string>\",\n \"actor\": \"<string>\",\n \"audience\": \"<string>\",\n \"definition\": {\n \"id\": \"<string>\",\n \"version\": \"<string>\",\n \"locale\": \"<string>\"\n },\n \"dataText\": \"<string>\",\n \"purposeText\": \"<string>\",\n \"data\": \"<object>\",\n \"consentContext\": \"<object>\"\n}"
let postData = parameters.data(using: .utf8)
var request = URLRequest(url: URL(string: "{{baseUrl}}/consent/v1/consents/{{consentRecordId}}")!,timeoutInterval: Double.infinity)
request.addValue("application/json", forHTTPHeaderField: "Content-Type")
request.addValue("Bearer {{accessToken}}", forHTTPHeaderField: "Authorization")
request.httpMethod = "PATCH"
request.httpBody = postData
let task = URLSession.shared.dataTask(with: request) { data, response, error in
guard let data = data else {
print(String(describing: error))
return
}
print(String(data: data, encoding: .utf8)!)
}
task.resume()
Example Response
200 OK
{
"_links": {
"localization": {
"href": "https://localhost:1443/consent/v1/definitions/medical_record/localizations/en-US",
"hreflang": "en-US"
},
"self": {
"href": "https://localhost:1443/consent/v1/consents/7f577510-414e-4fea-bb2c-43d2b5119431"
},
"definition": {
"href": "https://localhost:1443/consent/v1/definitions/liquor_cabinet"
}
},
"id": "7f577510-414e-4fea-bb2c-43d2b5119431",
"status": "accepted",
"subject": "jacob",
"actor": "jacob",
"audience": "client1",
"definition": {
"id": "medical_record",
"version": "1.0",
"locale": "en-US"
},
"dataText": "You agree to share this data...",
"purposeText": "This data will be used for...",
"createdDate": "2018-03-26T22:45:18.170Z",
"updatedDate": "2018-03-26T22:45:18.170Z"
}