groupGet
Get a Group resource based on the resource ID, type, characteristic, or member.
/Group/
Usage and SDK Samples
curl -X GET\
-H "Accept: application/json,application/xml"\
"//Group/?id=&type=&characteristic=&characteristic-value=&member="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GroupApi;
import java.io.File;
import java.util.*;
public class GroupApiExample {
public static void main(String[] args) {
GroupApi apiInstance = new GroupApi();
String id = id_example; // String | Resource ID.
String type = type_example; // String | Type of group. For example, person, animal, practitioner, or device. The complete list can be found here.
String characteristic = characteristic_example; // String | Include or exclude group members by trait.
String characteristicValue = characteristicValue_example; // String | A composite of both characteristic and value.
String member = member_example; // String | Who or what is in the group.
try {
Group result = apiInstance.groupGet(id, type, characteristic, characteristicValue, member);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling GroupApi#groupGet");
e.printStackTrace();
}
}
}
import io.swagger.client.api.GroupApi;
public class GroupApiExample {
public static void main(String[] args) {
GroupApi apiInstance = new GroupApi();
String id = id_example; // String | Resource ID.
String type = type_example; // String | Type of group. For example, person, animal, practitioner, or device. The complete list can be found here.
String characteristic = characteristic_example; // String | Include or exclude group members by trait.
String characteristicValue = characteristicValue_example; // String | A composite of both characteristic and value.
String member = member_example; // String | Who or what is in the group.
try {
Group result = apiInstance.groupGet(id, type, characteristic, characteristicValue, member);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling GroupApi#groupGet");
e.printStackTrace();
}
}
}
String *id = id_example; // Resource ID. (optional)
String *type = type_example; // Type of group. For example, person, animal, practitioner, or device. The complete list can be found here. (optional)
String *characteristic = characteristic_example; // Include or exclude group members by trait. (optional)
String *characteristicValue = characteristicValue_example; // A composite of both characteristic and value. (optional)
String *member = member_example; // Who or what is in the group. (optional)
GroupApi *apiInstance = [[GroupApi alloc] init];
[apiInstance groupGetWith:id
type:type
characteristic:characteristic
characteristicValue:characteristicValue
member:member
completionHandler: ^(Group output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var Group = require('group');
var api = new Group.GroupApi()
var opts = {
'id': id_example, // {{String}} Resource ID.
'type': type_example, // {{String}} Type of group. For example, person, animal, practitioner, or device. The complete list can be found here.
'characteristic': characteristic_example, // {{String}} Include or exclude group members by trait.
'characteristicValue': characteristicValue_example, // {{String}} A composite of both characteristic and value.
'member': member_example // {{String}} Who or what is in the group.
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.groupGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class groupGetExample
{
public void main()
{
var apiInstance = new GroupApi();
var id = id_example; // String | Resource ID. (optional)
var type = type_example; // String | Type of group. For example, person, animal, practitioner, or device. The complete list can be found here. (optional)
var characteristic = characteristic_example; // String | Include or exclude group members by trait. (optional)
var characteristicValue = characteristicValue_example; // String | A composite of both characteristic and value. (optional)
var member = member_example; // String | Who or what is in the group. (optional)
try
{
Group result = apiInstance.groupGet(id, type, characteristic, characteristicValue, member);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling GroupApi.groupGet: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\ApiGroupApi();
$id = id_example; // String | Resource ID.
$type = type_example; // String | Type of group. For example, person, animal, practitioner, or device. The complete list can be found here.
$characteristic = characteristic_example; // String | Include or exclude group members by trait.
$characteristicValue = characteristicValue_example; // String | A composite of both characteristic and value.
$member = member_example; // String | Who or what is in the group.
try {
$result = $api_instance->groupGet($id, $type, $characteristic, $characteristicValue, $member);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling GroupApi->groupGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GroupApi;
my $api_instance = WWW::SwaggerClient::GroupApi->new();
my $id = id_example; # String | Resource ID.
my $type = type_example; # String | Type of group. For example, person, animal, practitioner, or device. The complete list can be found here.
my $characteristic = characteristic_example; # String | Include or exclude group members by trait.
my $characteristicValue = characteristicValue_example; # String | A composite of both characteristic and value.
my $member = member_example; # String | Who or what is in the group.
eval {
my $result = $api_instance->groupGet(id => $id, type => $type, characteristic => $characteristic, characteristicValue => $characteristicValue, member => $member);
print Dumper($result);
};
if ($@) {
warn "Exception when calling GroupApi->groupGet: $@\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.GroupApi()
id = id_example # String | Resource ID. (optional)
type = type_example # String | Type of group. For example, person, animal, practitioner, or device. The complete list can be found here. (optional)
characteristic = characteristic_example # String | Include or exclude group members by trait. (optional)
characteristicValue = characteristicValue_example # String | A composite of both characteristic and value. (optional)
member = member_example # String | Who or what is in the group. (optional)
try:
api_response = api_instance.group_get(id=id, type=type, characteristic=characteristic, characteristicValue=characteristicValue, member=member)
pprint(api_response)
except ApiException as e:
print("Exception when calling GroupApi->groupGet: %s\n" % e)
Parameters
Query parameters
| Name | Description |
|---|---|
| id |
String
Resource ID.
|
| type |
String
Type of group. For example, person, animal, practitioner, or device. The complete list can be found <a href="https://hl7.org/fhir/group.html#resource">here</a>.
|
| characteristic |
String
Include or exclude group members by trait.
|
| characteristic-value |
String
A composite of both characteristic and value.
|
| member |
String
Who or what is in the group.
|