UserClinician API

User

userGet

Get users based on given search criteria.

Returns an array of User Objects from the User/Clinician registry based on given search criteria.

While this method has no required parameters, it should always be called with a reasonable set of search criteria to avoid returning a response of unmanageable size.


/user

Usage and SDK Samples

curl -X GET "/csp/healthshare/hsregistry/configuration/api/user-clinician/v1/user?active-only=&last-name=&first-name=&user-id=&identifier-extension=&assigning-authority=&clinicians-only=&facilities=&relationship-id=&mpiid=&must-have-delivery-policy="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserApi;

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

public class UserApiExample {

    public static void main(String[] args) {

        UserApi apiInstance = new UserApi();
        Boolean activeOnly = true; // Boolean | Flag to show only active users. If not set, all users (active and inactive) will be shown.
        String lastName = lastName_example; // String | Last name of user.
        String firstName = firstName_example; // String | First name of user.
        String userId = userId_example; // String | User ID of user.
        String identifierExtension = identifierExtension_example; // String | Identifier associated with a clinician.
        String assigningAuthority = assigningAuthority_example; // String | Assigning Authority of a clinician identifier in identifier-extension.
        Boolean cliniciansOnly = true; // Boolean | Flag to show only users marked as clinician.
        String facilities = facilities_example; // String | Facility codes that user is associated with. A comma separated list for multiple codes. If multiple codes are provided, any user whose facility code is intersected by the provided ones will be returned.
        String relationshipId = relationshipId_example; // String | Relationship ID that a clinician is associated with.
        String mpiid = mpiid_example; // String | MPIID that a clinician is associated with.
        Boolean mustHaveDeliveryPolicy = true; // Boolean | Flag to show only results with a delivery policy.
        try {
            array[null] result = apiInstance.userGet(activeOnly, lastName, firstName, userId, identifierExtension, assigningAuthority, cliniciansOnly, facilities, relationshipId, mpiid, mustHaveDeliveryPolicy);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#userGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserApi;

public class UserApiExample {

    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        Boolean activeOnly = true; // Boolean | Flag to show only active users. If not set, all users (active and inactive) will be shown.
        String lastName = lastName_example; // String | Last name of user.
        String firstName = firstName_example; // String | First name of user.
        String userId = userId_example; // String | User ID of user.
        String identifierExtension = identifierExtension_example; // String | Identifier associated with a clinician.
        String assigningAuthority = assigningAuthority_example; // String | Assigning Authority of a clinician identifier in identifier-extension.
        Boolean cliniciansOnly = true; // Boolean | Flag to show only users marked as clinician.
        String facilities = facilities_example; // String | Facility codes that user is associated with. A comma separated list for multiple codes. If multiple codes are provided, any user whose facility code is intersected by the provided ones will be returned.
        String relationshipId = relationshipId_example; // String | Relationship ID that a clinician is associated with.
        String mpiid = mpiid_example; // String | MPIID that a clinician is associated with.
        Boolean mustHaveDeliveryPolicy = true; // Boolean | Flag to show only results with a delivery policy.
        try {
            array[null] result = apiInstance.userGet(activeOnly, lastName, firstName, userId, identifierExtension, assigningAuthority, cliniciansOnly, facilities, relationshipId, mpiid, mustHaveDeliveryPolicy);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#userGet");
            e.printStackTrace();
        }
    }
}
Boolean *activeOnly = true; // Flag to show only active users. If not set, all users (active and inactive) will be shown. (optional) (default to true)
String *lastName = lastName_example; // Last name of user. (optional)
String *firstName = firstName_example; // First name of user. (optional)
String *userId = userId_example; // User ID of user. (optional)
String *identifierExtension = identifierExtension_example; // Identifier associated with a clinician. (optional)
String *assigningAuthority = assigningAuthority_example; // Assigning Authority of a clinician identifier in identifier-extension. (optional)
Boolean *cliniciansOnly = true; // Flag to show only users marked as clinician. (optional)
String *facilities = facilities_example; // Facility codes that user is associated with. A comma separated list for multiple codes. If multiple codes are provided, any user whose facility code is intersected by the provided ones will be returned. (optional)
String *relationshipId = relationshipId_example; // Relationship ID that a clinician is associated with. (optional)
String *mpiid = mpiid_example; // MPIID that a clinician is associated with. (optional)
Boolean *mustHaveDeliveryPolicy = true; // Flag to show only results with a delivery policy. (optional)

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

// Get users based on given search criteria.
[apiInstance userGetWith:activeOnly
    lastName:lastName
    firstName:firstName
    userId:userId
    identifierExtension:identifierExtension
    assigningAuthority:assigningAuthority
    cliniciansOnly:cliniciansOnly
    facilities:facilities
    relationshipId:relationshipId
    mpiid:mpiid
    mustHaveDeliveryPolicy:mustHaveDeliveryPolicy
              completionHandler: ^(NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var UserClinicianApi = require('user_clinician_api');

var api = new UserClinicianApi.UserApi()
var opts = {
  'activeOnly': true, // {{Boolean}} Flag to show only active users. If not set, all users (active and inactive) will be shown.
  'lastName': lastName_example, // {{String}} Last name of user.
  'firstName': firstName_example, // {{String}} First name of user.
  'userId': userId_example, // {{String}} User ID of user.
  'identifierExtension': identifierExtension_example, // {{String}} Identifier associated with a clinician.
  'assigningAuthority': assigningAuthority_example, // {{String}} Assigning Authority of a clinician identifier in identifier-extension.
  'cliniciansOnly': true, // {{Boolean}} Flag to show only users marked as clinician.
  'facilities': facilities_example, // {{String}} Facility codes that user is associated with. A comma separated list for multiple codes. If multiple codes are provided, any user whose facility code is intersected by the provided ones will be returned.
  'relationshipId': relationshipId_example, // {{String}} Relationship ID that a clinician is associated with.
  'mpiid': mpiid_example, // {{String}} MPIID that a clinician is associated with.
  'mustHaveDeliveryPolicy': true // {{Boolean}} Flag to show only results with a delivery policy.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.userGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new UserApi();
            var activeOnly = true;  // Boolean | Flag to show only active users. If not set, all users (active and inactive) will be shown. (optional)  (default to true)
            var lastName = lastName_example;  // String | Last name of user. (optional)
            var firstName = firstName_example;  // String | First name of user. (optional)
            var userId = userId_example;  // String | User ID of user. (optional)
            var identifierExtension = identifierExtension_example;  // String | Identifier associated with a clinician. (optional)
            var assigningAuthority = assigningAuthority_example;  // String | Assigning Authority of a clinician identifier in identifier-extension. (optional)
            var cliniciansOnly = true;  // Boolean | Flag to show only users marked as clinician. (optional)
            var facilities = facilities_example;  // String | Facility codes that user is associated with. A comma separated list for multiple codes. If multiple codes are provided, any user whose facility code is intersected by the provided ones will be returned. (optional)
            var relationshipId = relationshipId_example;  // String | Relationship ID that a clinician is associated with. (optional)
            var mpiid = mpiid_example;  // String | MPIID that a clinician is associated with. (optional)
            var mustHaveDeliveryPolicy = true;  // Boolean | Flag to show only results with a delivery policy. (optional)

            try
            {
                // Get users based on given search criteria.
                array[null] result = apiInstance.userGet(activeOnly, lastName, firstName, userId, identifierExtension, assigningAuthority, cliniciansOnly, facilities, relationshipId, mpiid, mustHaveDeliveryPolicy);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserApi.userGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiUserApi();
$activeOnly = true; // Boolean | Flag to show only active users. If not set, all users (active and inactive) will be shown.
$lastName = lastName_example; // String | Last name of user.
$firstName = firstName_example; // String | First name of user.
$userId = userId_example; // String | User ID of user.
$identifierExtension = identifierExtension_example; // String | Identifier associated with a clinician.
$assigningAuthority = assigningAuthority_example; // String | Assigning Authority of a clinician identifier in identifier-extension.
$cliniciansOnly = true; // Boolean | Flag to show only users marked as clinician.
$facilities = facilities_example; // String | Facility codes that user is associated with. A comma separated list for multiple codes. If multiple codes are provided, any user whose facility code is intersected by the provided ones will be returned.
$relationshipId = relationshipId_example; // String | Relationship ID that a clinician is associated with.
$mpiid = mpiid_example; // String | MPIID that a clinician is associated with.
$mustHaveDeliveryPolicy = true; // Boolean | Flag to show only results with a delivery policy.

try {
    $result = $api_instance->userGet($activeOnly, $lastName, $firstName, $userId, $identifierExtension, $assigningAuthority, $cliniciansOnly, $facilities, $relationshipId, $mpiid, $mustHaveDeliveryPolicy);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->userGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserApi;

my $api_instance = WWW::SwaggerClient::UserApi->new();
my $activeOnly = true; # Boolean | Flag to show only active users. If not set, all users (active and inactive) will be shown.
my $lastName = lastName_example; # String | Last name of user.
my $firstName = firstName_example; # String | First name of user.
my $userId = userId_example; # String | User ID of user.
my $identifierExtension = identifierExtension_example; # String | Identifier associated with a clinician.
my $assigningAuthority = assigningAuthority_example; # String | Assigning Authority of a clinician identifier in identifier-extension.
my $cliniciansOnly = true; # Boolean | Flag to show only users marked as clinician.
my $facilities = facilities_example; # String | Facility codes that user is associated with. A comma separated list for multiple codes. If multiple codes are provided, any user whose facility code is intersected by the provided ones will be returned.
my $relationshipId = relationshipId_example; # String | Relationship ID that a clinician is associated with.
my $mpiid = mpiid_example; # String | MPIID that a clinician is associated with.
my $mustHaveDeliveryPolicy = true; # Boolean | Flag to show only results with a delivery policy.

eval {
    my $result = $api_instance->userGet(activeOnly => $activeOnly, lastName => $lastName, firstName => $firstName, userId => $userId, identifierExtension => $identifierExtension, assigningAuthority => $assigningAuthority, cliniciansOnly => $cliniciansOnly, facilities => $facilities, relationshipId => $relationshipId, mpiid => $mpiid, mustHaveDeliveryPolicy => $mustHaveDeliveryPolicy);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->userGet: $@\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.UserApi()
activeOnly = true # Boolean | Flag to show only active users. If not set, all users (active and inactive) will be shown. (optional) (default to true)
lastName = lastName_example # String | Last name of user. (optional)
firstName = firstName_example # String | First name of user. (optional)
userId = userId_example # String | User ID of user. (optional)
identifierExtension = identifierExtension_example # String | Identifier associated with a clinician. (optional)
assigningAuthority = assigningAuthority_example # String | Assigning Authority of a clinician identifier in identifier-extension. (optional)
cliniciansOnly = true # Boolean | Flag to show only users marked as clinician. (optional)
facilities = facilities_example # String | Facility codes that user is associated with. A comma separated list for multiple codes. If multiple codes are provided, any user whose facility code is intersected by the provided ones will be returned. (optional)
relationshipId = relationshipId_example # String | Relationship ID that a clinician is associated with. (optional)
mpiid = mpiid_example # String | MPIID that a clinician is associated with. (optional)
mustHaveDeliveryPolicy = true # Boolean | Flag to show only results with a delivery policy. (optional)

try:
    # Get users based on given search criteria.
    api_response = api_instance.user_get(activeOnly=activeOnly, lastName=lastName, firstName=firstName, userId=userId, identifierExtension=identifierExtension, assigningAuthority=assigningAuthority, cliniciansOnly=cliniciansOnly, facilities=facilities, relationshipId=relationshipId, mpiid=mpiid, mustHaveDeliveryPolicy=mustHaveDeliveryPolicy)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->userGet: %s\n" % e)

Parameters

Query parameters
Name Description
active-only
Boolean
Flag to show only active users. If not set, all users (active and inactive) will be shown.
last-name
String
Last name of user.
first-name
String
First name of user.
user-id
String
User ID of user.
identifier-extension
String
Identifier associated with a clinician.
assigning-authority
String
Assigning Authority of a clinician identifier in identifier-extension.
clinicians-only
Boolean
Flag to show only users marked as clinician.
facilities
String
Facility codes that user is associated with. A comma separated list for multiple codes. If multiple codes are provided, any user whose facility code is intersected by the provided ones will be returned.
relationship-id
String
Relationship ID that a clinician is associated with.
mpiid
String
MPIID that a clinician is associated with.
must-have-delivery-policy
Boolean
Flag to show only results with a delivery policy.

Responses

Status: 200 - Successfully returned an array of User objects based on the search criteria.

Status: 204 - Request finished successfully but no content was found.

Status: 400 - Invalid search criteria.

Status: 401 - Unauthorized (invalid authentication credentials).

Status: 403 - Forbidden (refuse to authorize access to resource).

Status: 500 - Internal server error.


userPost

Add a user.

Create a new user in the User/Clinician registry using a User Object.


/user

Usage and SDK Samples

curl -X POST "/csp/healthshare/hsregistry/configuration/api/user-clinician/v1/user"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserApi;

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

public class UserApiExample {

    public static void main(String[] args) {

        UserApi apiInstance = new UserApi();
        Body body = ; // Body | A User Object with new user information.
        try {
            inline_response_200 result = apiInstance.userPost(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#userPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserApi;

public class UserApiExample {

    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        Body body = ; // Body | A User Object with new user information.
        try {
            inline_response_200 result = apiInstance.userPost(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#userPost");
            e.printStackTrace();
        }
    }
}
Body *body = ; // A User Object with new user information.

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

// Add a user.
[apiInstance userPostWith:body
              completionHandler: ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var UserClinicianApi = require('user_clinician_api');

var api = new UserClinicianApi.UserApi()
var body = ; // {{Body}} A User Object with new user information.

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

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

            var apiInstance = new UserApi();
            var body = new Body(); // Body | A User Object with new user information.

            try
            {
                // Add a user.
                inline_response_200 result = apiInstance.userPost(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserApi.userPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiUserApi();
$body = ; // Body | A User Object with new user information.

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

my $api_instance = WWW::SwaggerClient::UserApi->new();
my $body = WWW::SwaggerClient::Object::Body->new(); # Body | A User Object with new user information.

eval {
    my $result = $api_instance->userPost(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->userPost: $@\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.UserApi()
body =  # Body | A User Object with new user information.

try:
    # Add a user.
    api_response = api_instance.user_post(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->userPost: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - A user was successfully added to the User/Clinician registry.

Status: 204 - Request finished successfully but no content was found.

Status: 400 - Invalid request body contents.

Status: 401 - Unauthorized (invalid authentication credentials).

Status: 403 - Forbidden (refuse to authorize access to resource).

Status: 500 - Internal server error.


userkeyGet

Get a single user.

Returns the User Object for a single user in the User/Clinician registry given a unique identifier.


/user/:key

Usage and SDK Samples

curl -X GET "/csp/healthshare/hsregistry/configuration/api/user-clinician/v1/user/:key"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserApi;

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

public class UserApiExample {

    public static void main(String[] args) {

        UserApi apiInstance = new UserApi();
        String key = key_example; // String | The unique identifier of a user in the User/Clinician registry.
        try {
            inline_response_200 result = apiInstance.userkeyGet(key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#userkeyGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserApi;

public class UserApiExample {

    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        String key = key_example; // String | The unique identifier of a user in the User/Clinician registry.
        try {
            inline_response_200 result = apiInstance.userkeyGet(key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#userkeyGet");
            e.printStackTrace();
        }
    }
}
String *key = key_example; // The unique identifier of a user in the User/Clinician registry.

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

// Get a single user.
[apiInstance userkeyGetWith:key
              completionHandler: ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var UserClinicianApi = require('user_clinician_api');

var api = new UserClinicianApi.UserApi()
var key = key_example; // {{String}} The unique identifier of a user in the User/Clinician registry.

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

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

            var apiInstance = new UserApi();
            var key = key_example;  // String | The unique identifier of a user in the User/Clinician registry.

            try
            {
                // Get a single user.
                inline_response_200 result = apiInstance.userkeyGet(key);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserApi.userkeyGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiUserApi();
$key = key_example; // String | The unique identifier of a user in the User/Clinician registry.

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

my $api_instance = WWW::SwaggerClient::UserApi->new();
my $key = key_example; # String | The unique identifier of a user in the User/Clinician registry.

eval {
    my $result = $api_instance->userkeyGet(key => $key);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->userkeyGet: $@\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.UserApi()
key = key_example # String | The unique identifier of a user in the User/Clinician registry.

try:
    # Get a single user.
    api_response = api_instance.userkey_get(key)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->userkeyGet: %s\n" % e)

Parameters

Path parameters
Name Description
key*
String
The unique identifier of a user in the User/Clinician registry.
Required

Responses

Status: 200 - A User Object for the given unique identifier has been successfully found.

Status: 204 - Request finished successfully but no content was found.

Status: 400 - Invalid request body contents.

Status: 401 - Unauthorized (invalid authentication credentials).

Status: 403 - Forbidden (refuse to authorize access to resource).

Status: 500 - Internal server error.


userkeyPut

Update a given user.

Updates an existing user's information in the User/Clinician registry using a unique identifier.


/user/:key

Usage and SDK Samples

curl -X PUT "/csp/healthshare/hsregistry/configuration/api/user-clinician/v1/user/:key"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserApi;

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

public class UserApiExample {

    public static void main(String[] args) {

        UserApi apiInstance = new UserApi();
        Body_1 body = ; // Body_1 | A User Object with information needed to update the user.
        try {
            inline_response_200 result = apiInstance.userkeyPut(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#userkeyPut");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserApi;

public class UserApiExample {

    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        Body_1 body = ; // Body_1 | A User Object with information needed to update the user.
        try {
            inline_response_200 result = apiInstance.userkeyPut(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#userkeyPut");
            e.printStackTrace();
        }
    }
}
Body_1 *body = ; // A User Object with information needed to update the user.

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

// Update a given user.
[apiInstance userkeyPutWith:body
              completionHandler: ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var UserClinicianApi = require('user_clinician_api');

var api = new UserClinicianApi.UserApi()
var body = ; // {{Body_1}} A User Object with information needed to update the user.

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

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

            var apiInstance = new UserApi();
            var body = new Body_1(); // Body_1 | A User Object with information needed to update the user.

            try
            {
                // Update a given user.
                inline_response_200 result = apiInstance.userkeyPut(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserApi.userkeyPut: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiUserApi();
$body = ; // Body_1 | A User Object with information needed to update the user.

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

my $api_instance = WWW::SwaggerClient::UserApi->new();
my $body = WWW::SwaggerClient::Object::Body_1->new(); # Body_1 | A User Object with information needed to update the user.

eval {
    my $result = $api_instance->userkeyPut(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->userkeyPut: $@\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.UserApi()
body =  # Body_1 | A User Object with information needed to update the user.

try:
    # Update a given user.
    api_response = api_instance.userkey_put(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->userkeyPut: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - The user with the provided unique identifier was successfully updated in the User/Clinician registry.

Status: 204 - Request finished successfully but no content was found.

Status: 400 - Invalid request body contents.

Status: 401 - Unauthorized (invalid authentication credentials).

Status: 403 - Forbidden (refuse to authorize access to resource).

Status: 500 - Internal server error.


UserFacility

userkeyFacilityGet

Get all facilities associated with a user.

Returns an array of User Facility Objects associated with the given user.


/user/:key/facility

Usage and SDK Samples

curl -X GET "/csp/healthshare/hsregistry/configuration/api/user-clinician/v1/user/:key/facility"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserFacilityApi;

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

public class UserFacilityApiExample {

    public static void main(String[] args) {

        UserFacilityApi apiInstance = new UserFacilityApi();
        String key = key_example; // String | The unique identifier of a user in the User/Clinician registry.
        try {
            inline_response_200_1 result = apiInstance.userkeyFacilityGet(key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserFacilityApi#userkeyFacilityGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserFacilityApi;

public class UserFacilityApiExample {

    public static void main(String[] args) {
        UserFacilityApi apiInstance = new UserFacilityApi();
        String key = key_example; // String | The unique identifier of a user in the User/Clinician registry.
        try {
            inline_response_200_1 result = apiInstance.userkeyFacilityGet(key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserFacilityApi#userkeyFacilityGet");
            e.printStackTrace();
        }
    }
}
String *key = key_example; // The unique identifier of a user in the User/Clinician registry.

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

// Get all facilities associated with a user.
[apiInstance userkeyFacilityGetWith:key
              completionHandler: ^(inline_response_200_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var UserClinicianApi = require('user_clinician_api');

var api = new UserClinicianApi.UserFacilityApi()
var key = key_example; // {{String}} The unique identifier of a user in the User/Clinician registry.

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

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

            var apiInstance = new UserFacilityApi();
            var key = key_example;  // String | The unique identifier of a user in the User/Clinician registry.

            try
            {
                // Get all facilities associated with a user.
                inline_response_200_1 result = apiInstance.userkeyFacilityGet(key);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserFacilityApi.userkeyFacilityGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiUserFacilityApi();
$key = key_example; // String | The unique identifier of a user in the User/Clinician registry.

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

my $api_instance = WWW::SwaggerClient::UserFacilityApi->new();
my $key = key_example; # String | The unique identifier of a user in the User/Clinician registry.

eval {
    my $result = $api_instance->userkeyFacilityGet(key => $key);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserFacilityApi->userkeyFacilityGet: $@\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.UserFacilityApi()
key = key_example # String | The unique identifier of a user in the User/Clinician registry.

try:
    # Get all facilities associated with a user.
    api_response = api_instance.userkey_facility_get(key)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserFacilityApi->userkeyFacilityGet: %s\n" % e)

Parameters

Path parameters
Name Description
key*
String
The unique identifier of a user in the User/Clinician registry.
Required

Responses

Status: 200 - Facilities for the user found successfully.

Status: 204 - Request finished successfully but no content was found.

Status: 401 - Unauthorized (invalid authentication credentials).

Status: 403 - Forbidden (refuse to authorize access to resource).

Status: 500 - Internal server error.


userkeyFacilityPost

Add a facility for a user.

Adds a facility for a given user to the User/Clinician registry.


/user/:key/facility

Usage and SDK Samples

curl -X POST "/csp/healthshare/hsregistry/configuration/api/user-clinician/v1/user/:key/facility"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserFacilityApi;

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

public class UserFacilityApiExample {

    public static void main(String[] args) {

        UserFacilityApi apiInstance = new UserFacilityApi();
        Body_2 body = ; // Body_2 | A User Facility Object with information about the facility to be added.
        try {
            inline_response_200_1 result = apiInstance.userkeyFacilityPost(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserFacilityApi#userkeyFacilityPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserFacilityApi;

public class UserFacilityApiExample {

    public static void main(String[] args) {
        UserFacilityApi apiInstance = new UserFacilityApi();
        Body_2 body = ; // Body_2 | A User Facility Object with information about the facility to be added.
        try {
            inline_response_200_1 result = apiInstance.userkeyFacilityPost(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserFacilityApi#userkeyFacilityPost");
            e.printStackTrace();
        }
    }
}
Body_2 *body = ; // A User Facility Object with information about the facility to be added.

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

// Add a facility for a user.
[apiInstance userkeyFacilityPostWith:body
              completionHandler: ^(inline_response_200_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var UserClinicianApi = require('user_clinician_api');

var api = new UserClinicianApi.UserFacilityApi()
var body = ; // {{Body_2}} A User Facility Object with information about the facility to be added.

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

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

            var apiInstance = new UserFacilityApi();
            var body = new Body_2(); // Body_2 | A User Facility Object with information about the facility to be added.

            try
            {
                // Add a facility for a user.
                inline_response_200_1 result = apiInstance.userkeyFacilityPost(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserFacilityApi.userkeyFacilityPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiUserFacilityApi();
$body = ; // Body_2 | A User Facility Object with information about the facility to be added.

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

my $api_instance = WWW::SwaggerClient::UserFacilityApi->new();
my $body = WWW::SwaggerClient::Object::Body_2->new(); # Body_2 | A User Facility Object with information about the facility to be added.

eval {
    my $result = $api_instance->userkeyFacilityPost(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserFacilityApi->userkeyFacilityPost: $@\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.UserFacilityApi()
body =  # Body_2 | A User Facility Object with information about the facility to be added.

try:
    # Add a facility for a user.
    api_response = api_instance.userkey_facility_post(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserFacilityApi->userkeyFacilityPost: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - A facility for the given user has been added successfully.

Status: 204 - Request finished successfully but no content was found.

Status: 400 - Invalid request body contents.

Status: 401 - Unauthorized (invalid authentication credentials).

Status: 403 - Forbidden (refuse to authorize access to resource).

Status: 500 - Internal server error.


userkeyFacilityfacilityKeyDelete

Deletes a facility of a given user.

Deletes a facility (identified using its unique identifier) for a user in the User/Clinician registry.


/user/:key/facility/:facilityKey

Usage and SDK Samples

curl -X DELETE "/csp/healthshare/hsregistry/configuration/api/user-clinician/v1/user/:key/facility/:facilityKey"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserFacilityApi;

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

public class UserFacilityApiExample {

    public static void main(String[] args) {

        UserFacilityApi apiInstance = new UserFacilityApi();
        String key = key_example; // String | The unique identifier of a user in the User/Clinician registry.
        String facilityKey = facilityKey_example; // String | The unique identifier of a user's facility in the User/Clinician registry.
        try {
            inline_response_200_1 result = apiInstance.userkeyFacilityfacilityKeyDelete(key, facilityKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserFacilityApi#userkeyFacilityfacilityKeyDelete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserFacilityApi;

public class UserFacilityApiExample {

    public static void main(String[] args) {
        UserFacilityApi apiInstance = new UserFacilityApi();
        String key = key_example; // String | The unique identifier of a user in the User/Clinician registry.
        String facilityKey = facilityKey_example; // String | The unique identifier of a user's facility in the User/Clinician registry.
        try {
            inline_response_200_1 result = apiInstance.userkeyFacilityfacilityKeyDelete(key, facilityKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserFacilityApi#userkeyFacilityfacilityKeyDelete");
            e.printStackTrace();
        }
    }
}
String *key = key_example; // The unique identifier of a user in the User/Clinician registry.
String *facilityKey = facilityKey_example; // The unique identifier of a user's facility in the User/Clinician registry.

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

// Deletes a facility of a given user.
[apiInstance userkeyFacilityfacilityKeyDeleteWith:key
    facilityKey:facilityKey
              completionHandler: ^(inline_response_200_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var UserClinicianApi = require('user_clinician_api');

var api = new UserClinicianApi.UserFacilityApi()
var key = key_example; // {{String}} The unique identifier of a user in the User/Clinician registry.
var facilityKey = facilityKey_example; // {{String}} The unique identifier of a user's facility in the User/Clinician registry.

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

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

            var apiInstance = new UserFacilityApi();
            var key = key_example;  // String | The unique identifier of a user in the User/Clinician registry.
            var facilityKey = facilityKey_example;  // String | The unique identifier of a user's facility in the User/Clinician registry.

            try
            {
                // Deletes a facility of a given user.
                inline_response_200_1 result = apiInstance.userkeyFacilityfacilityKeyDelete(key, facilityKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserFacilityApi.userkeyFacilityfacilityKeyDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiUserFacilityApi();
$key = key_example; // String | The unique identifier of a user in the User/Clinician registry.
$facilityKey = facilityKey_example; // String | The unique identifier of a user's facility in the User/Clinician registry.

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

my $api_instance = WWW::SwaggerClient::UserFacilityApi->new();
my $key = key_example; # String | The unique identifier of a user in the User/Clinician registry.
my $facilityKey = facilityKey_example; # String | The unique identifier of a user's facility in the User/Clinician registry.

eval {
    my $result = $api_instance->userkeyFacilityfacilityKeyDelete(key => $key, facilityKey => $facilityKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserFacilityApi->userkeyFacilityfacilityKeyDelete: $@\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.UserFacilityApi()
key = key_example # String | The unique identifier of a user in the User/Clinician registry.
facilityKey = facilityKey_example # String | The unique identifier of a user's facility in the User/Clinician registry.

try:
    # Deletes a facility of a given user.
    api_response = api_instance.userkey_facilityfacility_key_delete(key, facilityKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserFacilityApi->userkeyFacilityfacilityKeyDelete: %s\n" % e)

Parameters

Path parameters
Name Description
key*
String
The unique identifier of a user in the User/Clinician registry.
Required
facilityKey*
String
The unique identifier of a user's facility in the User/Clinician registry.
Required

Responses

Status: 200 - The given facility for this user has been deleted successfully.

Status: 204 - Request finished successfully but no content was found.

Status: 401 - Unauthorized (invalid authentication credentials).

Status: 403 - Forbidden (refuse to authorize access to resource).

Status: 500 - Internal server error.


userkeyFacilityfacilityKeyPut

Update a facility for an existing user.

Updates a facility (identified using its unique identifier) for a user in the User/Clinician registry.


/user/:key/facility/:facilityKey

Usage and SDK Samples

curl -X PUT "/csp/healthshare/hsregistry/configuration/api/user-clinician/v1/user/:key/facility/:facilityKey"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserFacilityApi;

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

public class UserFacilityApiExample {

    public static void main(String[] args) {

        UserFacilityApi apiInstance = new UserFacilityApi();
        Body_3 body = ; // Body_3 | A User Facility Object with facility details to update.
        String key = key_example; // String | The unique identifier of a user in the User/Clinician registry.
        String facilityKey = facilityKey_example; // String | The unique identifier of a user's facility in the User/Clinician registry.
        try {
            inline_response_200_1 result = apiInstance.userkeyFacilityfacilityKeyPut(body, key, facilityKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserFacilityApi#userkeyFacilityfacilityKeyPut");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserFacilityApi;

public class UserFacilityApiExample {

    public static void main(String[] args) {
        UserFacilityApi apiInstance = new UserFacilityApi();
        Body_3 body = ; // Body_3 | A User Facility Object with facility details to update.
        String key = key_example; // String | The unique identifier of a user in the User/Clinician registry.
        String facilityKey = facilityKey_example; // String | The unique identifier of a user's facility in the User/Clinician registry.
        try {
            inline_response_200_1 result = apiInstance.userkeyFacilityfacilityKeyPut(body, key, facilityKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserFacilityApi#userkeyFacilityfacilityKeyPut");
            e.printStackTrace();
        }
    }
}
Body_3 *body = ; // A User Facility Object with facility details to update.
String *key = key_example; // The unique identifier of a user in the User/Clinician registry.
String *facilityKey = facilityKey_example; // The unique identifier of a user's facility in the User/Clinician registry.

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

// Update a facility for an existing user.
[apiInstance userkeyFacilityfacilityKeyPutWith:body
    key:key
    facilityKey:facilityKey
              completionHandler: ^(inline_response_200_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var UserClinicianApi = require('user_clinician_api');

var api = new UserClinicianApi.UserFacilityApi()
var body = ; // {{Body_3}} A User Facility Object with facility details to update.
var key = key_example; // {{String}} The unique identifier of a user in the User/Clinician registry.
var facilityKey = facilityKey_example; // {{String}} The unique identifier of a user's facility in the User/Clinician registry.

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

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

            var apiInstance = new UserFacilityApi();
            var body = new Body_3(); // Body_3 | A User Facility Object with facility details to update.
            var key = key_example;  // String | The unique identifier of a user in the User/Clinician registry.
            var facilityKey = facilityKey_example;  // String | The unique identifier of a user's facility in the User/Clinician registry.

            try
            {
                // Update a facility for an existing user.
                inline_response_200_1 result = apiInstance.userkeyFacilityfacilityKeyPut(body, key, facilityKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserFacilityApi.userkeyFacilityfacilityKeyPut: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiUserFacilityApi();
$body = ; // Body_3 | A User Facility Object with facility details to update.
$key = key_example; // String | The unique identifier of a user in the User/Clinician registry.
$facilityKey = facilityKey_example; // String | The unique identifier of a user's facility in the User/Clinician registry.

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

my $api_instance = WWW::SwaggerClient::UserFacilityApi->new();
my $body = WWW::SwaggerClient::Object::Body_3->new(); # Body_3 | A User Facility Object with facility details to update.
my $key = key_example; # String | The unique identifier of a user in the User/Clinician registry.
my $facilityKey = facilityKey_example; # String | The unique identifier of a user's facility in the User/Clinician registry.

eval {
    my $result = $api_instance->userkeyFacilityfacilityKeyPut(body => $body, key => $key, facilityKey => $facilityKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserFacilityApi->userkeyFacilityfacilityKeyPut: $@\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.UserFacilityApi()
body =  # Body_3 | A User Facility Object with facility details to update.
key = key_example # String | The unique identifier of a user in the User/Clinician registry.
facilityKey = facilityKey_example # String | The unique identifier of a user's facility in the User/Clinician registry.

try:
    # Update a facility for an existing user.
    api_response = api_instance.userkey_facilityfacility_key_put(body, key, facilityKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserFacilityApi->userkeyFacilityfacilityKeyPut: %s\n" % e)

Parameters

Path parameters
Name Description
key*
String
The unique identifier of a user in the User/Clinician registry.
Required
facilityKey*
String
The unique identifier of a user's facility in the User/Clinician registry.
Required
Body parameters
Name Description
body *

Responses

Status: 200 - The given facility for this user has been updated successfully.

Status: 204 - Request finished successfully but no content was found.

Status: 400 - Invalid request body contents.

Status: 401 - Unauthorized (invalid authentication credentials).

Status: 500 - Forbidden (refuse to authorize access to resource).


UserLoginId

userkeyLoginIdGet

Get all login ids associated with a user.

Returns an array of User Login ID Objects associated with the given user.


/user/:key/login-id

Usage and SDK Samples

curl -X GET "/csp/healthshare/hsregistry/configuration/api/user-clinician/v1/user/:key/login-id"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserLoginIdApi;

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

public class UserLoginIdApiExample {

    public static void main(String[] args) {

        UserLoginIdApi apiInstance = new UserLoginIdApi();
        String key = key_example; // String | The unique identifier of a user in the User/Clinician registry.
        try {
            inline_response_200_2 result = apiInstance.userkeyLoginIdGet(key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserLoginIdApi#userkeyLoginIdGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserLoginIdApi;

public class UserLoginIdApiExample {

    public static void main(String[] args) {
        UserLoginIdApi apiInstance = new UserLoginIdApi();
        String key = key_example; // String | The unique identifier of a user in the User/Clinician registry.
        try {
            inline_response_200_2 result = apiInstance.userkeyLoginIdGet(key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserLoginIdApi#userkeyLoginIdGet");
            e.printStackTrace();
        }
    }
}
String *key = key_example; // The unique identifier of a user in the User/Clinician registry.

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

// Get all login ids associated with a user.
[apiInstance userkeyLoginIdGetWith:key
              completionHandler: ^(inline_response_200_2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var UserClinicianApi = require('user_clinician_api');

var api = new UserClinicianApi.UserLoginIdApi()
var key = key_example; // {{String}} The unique identifier of a user in the User/Clinician registry.

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

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

            var apiInstance = new UserLoginIdApi();
            var key = key_example;  // String | The unique identifier of a user in the User/Clinician registry.

            try
            {
                // Get all login ids associated with a user.
                inline_response_200_2 result = apiInstance.userkeyLoginIdGet(key);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserLoginIdApi.userkeyLoginIdGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiUserLoginIdApi();
$key = key_example; // String | The unique identifier of a user in the User/Clinician registry.

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

my $api_instance = WWW::SwaggerClient::UserLoginIdApi->new();
my $key = key_example; # String | The unique identifier of a user in the User/Clinician registry.

eval {
    my $result = $api_instance->userkeyLoginIdGet(key => $key);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserLoginIdApi->userkeyLoginIdGet: $@\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.UserLoginIdApi()
key = key_example # String | The unique identifier of a user in the User/Clinician registry.

try:
    # Get all login ids associated with a user.
    api_response = api_instance.userkey_login_id_get(key)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserLoginIdApi->userkeyLoginIdGet: %s\n" % e)

Parameters

Path parameters
Name Description
key*
String
The unique identifier of a user in the User/Clinician registry.
Required

Responses

Status: 200 - Login ids for the user found successfully.

Status: 204 - Request finished successfully but no content was found.

Status: 401 - Unauthorized (invalid authentication credentials).

Status: 403 - Forbidden (refuse to authorize access to resource).

Status: 500 - Internal server error.


userkeyLoginIdPost

Add a login id for a user.

Adds a login id for a given user to the User/Clinician registry.


/user/:key/login-id

Usage and SDK Samples

curl -X POST "/csp/healthshare/hsregistry/configuration/api/user-clinician/v1/user/:key/login-id"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserLoginIdApi;

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

public class UserLoginIdApiExample {

    public static void main(String[] args) {

        UserLoginIdApi apiInstance = new UserLoginIdApi();
        Body_4 body = ; // Body_4 | A User Login ID Object with information about the login id to be added.
        try {
            inline_response_200_2 result = apiInstance.userkeyLoginIdPost(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserLoginIdApi#userkeyLoginIdPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserLoginIdApi;

public class UserLoginIdApiExample {

    public static void main(String[] args) {
        UserLoginIdApi apiInstance = new UserLoginIdApi();
        Body_4 body = ; // Body_4 | A User Login ID Object with information about the login id to be added.
        try {
            inline_response_200_2 result = apiInstance.userkeyLoginIdPost(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserLoginIdApi#userkeyLoginIdPost");
            e.printStackTrace();
        }
    }
}
Body_4 *body = ; // A User Login ID Object with information about the login id to be added.

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

// Add a login id for a user.
[apiInstance userkeyLoginIdPostWith:body
              completionHandler: ^(inline_response_200_2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var UserClinicianApi = require('user_clinician_api');

var api = new UserClinicianApi.UserLoginIdApi()
var body = ; // {{Body_4}} A User Login ID Object with information about the login id to be added.

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

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

            var apiInstance = new UserLoginIdApi();
            var body = new Body_4(); // Body_4 | A User Login ID Object with information about the login id to be added.

            try
            {
                // Add a login id for a user.
                inline_response_200_2 result = apiInstance.userkeyLoginIdPost(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserLoginIdApi.userkeyLoginIdPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiUserLoginIdApi();
$body = ; // Body_4 | A User Login ID Object with information about the login id to be added.

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

my $api_instance = WWW::SwaggerClient::UserLoginIdApi->new();
my $body = WWW::SwaggerClient::Object::Body_4->new(); # Body_4 | A User Login ID Object with information about the login id to be added.

eval {
    my $result = $api_instance->userkeyLoginIdPost(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserLoginIdApi->userkeyLoginIdPost: $@\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.UserLoginIdApi()
body =  # Body_4 | A User Login ID Object with information about the login id to be added.

try:
    # Add a login id for a user.
    api_response = api_instance.userkey_login_id_post(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserLoginIdApi->userkeyLoginIdPost: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - A login id for the given user has been added successfully.

Status: 204 - Request finished successfully but no content was found.

Status: 400 - Invalid request body contents.

Status: 401 - Unauthorized (invalid authentication credentials).

Status: 403 - Forbidden (refuse to authorize access to resource).

Status: 500 - Internal server error.


userkeyLoginIdloginIdKeyDelete

Deletes a login id of a given user.

Deletes a login id (identified using its unique identifier) for a user in the User/Clinician registry.


/user/:key/login-id/:loginIdKey

Usage and SDK Samples

curl -X DELETE "/csp/healthshare/hsregistry/configuration/api/user-clinician/v1/user/:key/login-id/:loginIdKey"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserLoginIdApi;

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

public class UserLoginIdApiExample {

    public static void main(String[] args) {

        UserLoginIdApi apiInstance = new UserLoginIdApi();
        String key = key_example; // String | The unique identifier of a user in the User/Clinician registry.
        String loginIdKey = loginIdKey_example; // String | The unique identifier of a user's login id in the User/Clinician registry.
        try {
            inline_response_200_2 result = apiInstance.userkeyLoginIdloginIdKeyDelete(key, loginIdKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserLoginIdApi#userkeyLoginIdloginIdKeyDelete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserLoginIdApi;

public class UserLoginIdApiExample {

    public static void main(String[] args) {
        UserLoginIdApi apiInstance = new UserLoginIdApi();
        String key = key_example; // String | The unique identifier of a user in the User/Clinician registry.
        String loginIdKey = loginIdKey_example; // String | The unique identifier of a user's login id in the User/Clinician registry.
        try {
            inline_response_200_2 result = apiInstance.userkeyLoginIdloginIdKeyDelete(key, loginIdKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserLoginIdApi#userkeyLoginIdloginIdKeyDelete");
            e.printStackTrace();
        }
    }
}
String *key = key_example; // The unique identifier of a user in the User/Clinician registry.
String *loginIdKey = loginIdKey_example; // The unique identifier of a user's login id in the User/Clinician registry.

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

// Deletes a login id of a given user.
[apiInstance userkeyLoginIdloginIdKeyDeleteWith:key
    loginIdKey:loginIdKey
              completionHandler: ^(inline_response_200_2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var UserClinicianApi = require('user_clinician_api');

var api = new UserClinicianApi.UserLoginIdApi()
var key = key_example; // {{String}} The unique identifier of a user in the User/Clinician registry.
var loginIdKey = loginIdKey_example; // {{String}} The unique identifier of a user's login id in the User/Clinician registry.

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

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

            var apiInstance = new UserLoginIdApi();
            var key = key_example;  // String | The unique identifier of a user in the User/Clinician registry.
            var loginIdKey = loginIdKey_example;  // String | The unique identifier of a user's login id in the User/Clinician registry.

            try
            {
                // Deletes a login id of a given user.
                inline_response_200_2 result = apiInstance.userkeyLoginIdloginIdKeyDelete(key, loginIdKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserLoginIdApi.userkeyLoginIdloginIdKeyDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiUserLoginIdApi();
$key = key_example; // String | The unique identifier of a user in the User/Clinician registry.
$loginIdKey = loginIdKey_example; // String | The unique identifier of a user's login id in the User/Clinician registry.

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

my $api_instance = WWW::SwaggerClient::UserLoginIdApi->new();
my $key = key_example; # String | The unique identifier of a user in the User/Clinician registry.
my $loginIdKey = loginIdKey_example; # String | The unique identifier of a user's login id in the User/Clinician registry.

eval {
    my $result = $api_instance->userkeyLoginIdloginIdKeyDelete(key => $key, loginIdKey => $loginIdKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserLoginIdApi->userkeyLoginIdloginIdKeyDelete: $@\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.UserLoginIdApi()
key = key_example # String | The unique identifier of a user in the User/Clinician registry.
loginIdKey = loginIdKey_example # String | The unique identifier of a user's login id in the User/Clinician registry.

try:
    # Deletes a login id of a given user.
    api_response = api_instance.userkey_login_idlogin_id_key_delete(key, loginIdKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserLoginIdApi->userkeyLoginIdloginIdKeyDelete: %s\n" % e)

Parameters

Path parameters
Name Description
key*
String
The unique identifier of a user in the User/Clinician registry.
Required
loginIdKey*
String
The unique identifier of a user's login id in the User/Clinician registry.
Required

Responses

Status: 200 - The given facility for this user has been deleted successfully.

Status: 204 - Request finished successfully but no content was found.

Status: 401 - Unauthorized (invalid authentication credentials).

Status: 403 - Forbidden (refuse to authorize access to resource).

Status: 500 - Internal server error.


userkeyLoginIdloginIdKeyPut

Update a login id for an existing user.

Updates a login id (identified using its unique identifier) for a user in the User/Clinician registry.


/user/:key/login-id/:loginIdKey

Usage and SDK Samples

curl -X PUT "/csp/healthshare/hsregistry/configuration/api/user-clinician/v1/user/:key/login-id/:loginIdKey"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserLoginIdApi;

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

public class UserLoginIdApiExample {

    public static void main(String[] args) {

        UserLoginIdApi apiInstance = new UserLoginIdApi();
        Body_5 body = ; // Body_5 | A User Login ID Object with login id details to update.
        String key = key_example; // String | The unique identifier of a user in the User/Clinician registry.
        String loginIdKey = loginIdKey_example; // String | The unique identifier of a user's login id in the User/Clinician registry.
        try {
            inline_response_200_2 result = apiInstance.userkeyLoginIdloginIdKeyPut(body, key, loginIdKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserLoginIdApi#userkeyLoginIdloginIdKeyPut");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserLoginIdApi;

public class UserLoginIdApiExample {

    public static void main(String[] args) {
        UserLoginIdApi apiInstance = new UserLoginIdApi();
        Body_5 body = ; // Body_5 | A User Login ID Object with login id details to update.
        String key = key_example; // String | The unique identifier of a user in the User/Clinician registry.
        String loginIdKey = loginIdKey_example; // String | The unique identifier of a user's login id in the User/Clinician registry.
        try {
            inline_response_200_2 result = apiInstance.userkeyLoginIdloginIdKeyPut(body, key, loginIdKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserLoginIdApi#userkeyLoginIdloginIdKeyPut");
            e.printStackTrace();
        }
    }
}
Body_5 *body = ; // A User Login ID Object with login id details to update.
String *key = key_example; // The unique identifier of a user in the User/Clinician registry.
String *loginIdKey = loginIdKey_example; // The unique identifier of a user's login id in the User/Clinician registry.

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

// Update a login id for an existing user.
[apiInstance userkeyLoginIdloginIdKeyPutWith:body
    key:key
    loginIdKey:loginIdKey
              completionHandler: ^(inline_response_200_2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var UserClinicianApi = require('user_clinician_api');

var api = new UserClinicianApi.UserLoginIdApi()
var body = ; // {{Body_5}} A User Login ID Object with login id details to update.
var key = key_example; // {{String}} The unique identifier of a user in the User/Clinician registry.
var loginIdKey = loginIdKey_example; // {{String}} The unique identifier of a user's login id in the User/Clinician registry.

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

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

            var apiInstance = new UserLoginIdApi();
            var body = new Body_5(); // Body_5 | A User Login ID Object with login id details to update.
            var key = key_example;  // String | The unique identifier of a user in the User/Clinician registry.
            var loginIdKey = loginIdKey_example;  // String | The unique identifier of a user's login id in the User/Clinician registry.

            try
            {
                // Update a login id for an existing user.
                inline_response_200_2 result = apiInstance.userkeyLoginIdloginIdKeyPut(body, key, loginIdKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserLoginIdApi.userkeyLoginIdloginIdKeyPut: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiUserLoginIdApi();
$body = ; // Body_5 | A User Login ID Object with login id details to update.
$key = key_example; // String | The unique identifier of a user in the User/Clinician registry.
$loginIdKey = loginIdKey_example; // String | The unique identifier of a user's login id in the User/Clinician registry.

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

my $api_instance = WWW::SwaggerClient::UserLoginIdApi->new();
my $body = WWW::SwaggerClient::Object::Body_5->new(); # Body_5 | A User Login ID Object with login id details to update.
my $key = key_example; # String | The unique identifier of a user in the User/Clinician registry.
my $loginIdKey = loginIdKey_example; # String | The unique identifier of a user's login id in the User/Clinician registry.

eval {
    my $result = $api_instance->userkeyLoginIdloginIdKeyPut(body => $body, key => $key, loginIdKey => $loginIdKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserLoginIdApi->userkeyLoginIdloginIdKeyPut: $@\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.UserLoginIdApi()
body =  # Body_5 | A User Login ID Object with login id details to update.
key = key_example # String | The unique identifier of a user in the User/Clinician registry.
loginIdKey = loginIdKey_example # String | The unique identifier of a user's login id in the User/Clinician registry.

try:
    # Update a login id for an existing user.
    api_response = api_instance.userkey_login_idlogin_id_key_put(body, key, loginIdKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserLoginIdApi->userkeyLoginIdloginIdKeyPut: %s\n" % e)

Parameters

Path parameters
Name Description
key*
String
The unique identifier of a user in the User/Clinician registry.
Required
loginIdKey*
String
The unique identifier of a user's login id in the User/Clinician registry.
Required
Body parameters
Name Description
body *

Responses

Status: 200 - The given login id for this user has been updated successfully.

Status: 204 - Request finished successfully but no content was found.

Status: 400 - Invalid request body contents.

Status: 401 - Unauthorized (invalid authentication credentials).

Status: 500 - Forbidden (refuse to authorize access to resource).