HealthShare Patient Index Public API

Settings

settingsGet

Query the database for configuration setting values.


/settings

Usage and SDK Samples

curl -X GET\
-H "Accept: application/vnd.intersystems.com.hs.patient-index.settings.v1+json"\
"<base url>/csp/healthshare/hspi/app/api/settings"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SettingsApi;

import java.io.File;
import java.util.*;

public class SettingsApiExample {

    public static void main(String[] args) {

        SettingsApi apiInstance = new SettingsApi();
        try {
            settings_collection result = apiInstance.settingsGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SettingsApi#settingsGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SettingsApi;

public class SettingsApiExample {

    public static void main(String[] args) {
        SettingsApi apiInstance = new SettingsApi();
        try {
            settings_collection result = apiInstance.settingsGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SettingsApi#settingsGet");
            e.printStackTrace();
        }
    }
}

SettingsApi *apiInstance = [[SettingsApi alloc] init];

[apiInstance settingsGetWithCompletionHandler:
              ^(settings_collection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HealthSharePatientIndexPublicApi = require('health_share_patient_index_public_api');

var api = new HealthSharePatientIndexPublicApi.SettingsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.settingsGet(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class settingsGetExample
    {
        public void main()
        {

            var apiInstance = new SettingsApi();

            try
            {
                settings_collection result = apiInstance.settingsGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SettingsApi.settingsGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSettingsApi();

try {
    $result = $api_instance->settingsGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SettingsApi->settingsGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SettingsApi;

my $api_instance = WWW::SwaggerClient::SettingsApi->new();

eval {
    my $result = $api_instance->settingsGet();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SettingsApi->settingsGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SettingsApi()

try:
    api_response = api_instance.settings_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SettingsApi->settingsGet: %s\n" % e)

Parameters

Responses

Status: 200 - The result of querying the settings collection endpoint.

Status: 403 - Forbidden: Authentication Failure

Status: 406 - Not Acceptable: The requested mediatype is not compatible with any supported response mediatypes.


settingsPost

Create new configuration settings in the form of key/value pairs and write them to the database. Currently supported keys: defaultAssigningAuthorityName


/settings

Usage and SDK Samples

curl -X POST\
-H "Accept: application/vnd.intersystems.com.hs.patient-index.settings.v1+json"\
-H "Content-Type: application/vnd.intersystems.com.hs.patient-index.settings.v1+json"\
"<base url>/csp/healthshare/hspi/app/api/settings"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SettingsApi;

import java.io.File;
import java.util.*;

public class SettingsApiExample {

    public static void main(String[] args) {

        SettingsApi apiInstance = new SettingsApi();
        Settings_input body = ; // Settings_input | The information necessary to create a new configuration setting.
        try {
            settings_output result = apiInstance.settingsPost(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SettingsApi#settingsPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SettingsApi;

public class SettingsApiExample {

    public static void main(String[] args) {
        SettingsApi apiInstance = new SettingsApi();
        Settings_input body = ; // Settings_input | The information necessary to create a new configuration setting.
        try {
            settings_output result = apiInstance.settingsPost(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SettingsApi#settingsPost");
            e.printStackTrace();
        }
    }
}
Settings_input *body = ; // The information necessary to create a new configuration setting.

SettingsApi *apiInstance = [[SettingsApi alloc] init];

[apiInstance settingsPostWith:body
              completionHandler: ^(settings_output output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HealthSharePatientIndexPublicApi = require('health_share_patient_index_public_api');

var api = new HealthSharePatientIndexPublicApi.SettingsApi()
var body = ; // {{Settings_input}} The information necessary to create a new configuration setting.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.settingsPost(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class settingsPostExample
    {
        public void main()
        {

            var apiInstance = new SettingsApi();
            var body = new Settings_input(); // Settings_input | The information necessary to create a new configuration setting.

            try
            {
                settings_output result = apiInstance.settingsPost(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SettingsApi.settingsPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSettingsApi();
$body = ; // Settings_input | The information necessary to create a new configuration setting.

try {
    $result = $api_instance->settingsPost($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SettingsApi->settingsPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SettingsApi;

my $api_instance = WWW::SwaggerClient::SettingsApi->new();
my $body = WWW::SwaggerClient::Object::Settings_input->new(); # Settings_input | The information necessary to create a new configuration setting.

eval {
    my $result = $api_instance->settingsPost(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SettingsApi->settingsPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SettingsApi()
body =  # Settings_input | The information necessary to create a new configuration setting.

try:
    api_response = api_instance.settings_post(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SettingsApi->settingsPost: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - The newly-created setting.

Status: 403 - Forbidden: Authentication Failure

Status: 415 - Unsupported Mediatype: Mediatype is not compatible with any supported request mediatypes.


© 2024 InterSystems Corporation, Cambridge, MA. All rights reserved.    Privacy & Terms Guarantee Accessibility