Personal Community Services REST API

Auth

authLogoutPost

Log out the current user


/auth/logout

Usage and SDK Samples

curl -X POST\
"//auth/logout"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthApi;

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

public class AuthApiExample {

    public static void main(String[] args) {
        
        AuthApi apiInstance = new AuthApi();
        try {
            apiInstance.authLogoutPost();
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#authLogoutPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuthApi;

public class AuthApiExample {

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

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

[apiInstance authLogoutPostWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PersonalCommunityServicesRestApi = require('personal_community_services_rest_api');

var api = new PersonalCommunityServicesRestApi.AuthApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.authLogoutPost(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new AuthApi();

            try
            {
                apiInstance.authLogoutPost();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthApi.authLogoutPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

eval { 
    $api_instance->authLogoutPost();
};
if ($@) {
    warn "Exception when calling AuthApi->authLogoutPost: $@\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.AuthApi()

try: 
    api_instance.auth_logout_post()
except ApiException as e:
    print("Exception when calling AuthApi->authLogoutPost: %s\n" % e)

Parameters

Responses

Status: 200 - A successful response


authStatusGet

Get information about the current user


/auth/status

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//auth/status"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthApi;

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

public class AuthApiExample {

    public static void main(String[] args) {
        
        AuthApi apiInstance = new AuthApi();
        try {
            AuthStatusResponse result = apiInstance.authStatusGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#authStatusGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuthApi;

public class AuthApiExample {

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

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

[apiInstance authStatusGetWithCompletionHandler: 
              ^(AuthStatusResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PersonalCommunityServicesRestApi = require('personal_community_services_rest_api');

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

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

            var apiInstance = new AuthApi();

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

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

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

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

eval { 
    my $result = $api_instance->authStatusGet();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthApi->authStatusGet: $@\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.AuthApi()

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

Parameters

Responses

Status: 200 - A representation of the current user

Status: 204 - No Content: No information was found on the current user


Enrollment

enrollmentgetEnrollmentStatusGet

Given a Medical Record Number and Assigning Authority, or a MPI ID, get enrollment status for the patient. This method returns the user status for either given MRN and AssigningAuthority, or given MPI ID Possible user statuses are : StatusCode - StatusDisplay 0 - Inactive Account 1 - Active Account 2 - Inactive Minor Account 3 - Pending Account 4 - Expired Pending Account -1 - MRN not found/Not Registered -2 - Matches more than one patient found with same MRN and assigning authority


/enrollment/$get-enrollment-status

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json,default"\
"//enrollment/$get-enrollment-status?assigningAuthority=&mpiid=&mrn="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EnrollmentApi;

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

public class EnrollmentApiExample {

    public static void main(String[] args) {
        
        EnrollmentApi apiInstance = new EnrollmentApi();
        String assigningAuthority = assigningAuthority_example; // String | Assigning Authority, associated with a particular `mrn`.
        String mpiid = mpiid_example; // String | MPI ID
        String mrn = mrn_example; // String | MRN, associated with a particular `assigningAuthority`.
        try {
            EnrollmentStatusResponse result = apiInstance.enrollmentgetEnrollmentStatusGet(assigningAuthority, mpiid, mrn);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EnrollmentApi#enrollmentgetEnrollmentStatusGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EnrollmentApi;

public class EnrollmentApiExample {

    public static void main(String[] args) {
        EnrollmentApi apiInstance = new EnrollmentApi();
        String assigningAuthority = assigningAuthority_example; // String | Assigning Authority, associated with a particular `mrn`.
        String mpiid = mpiid_example; // String | MPI ID
        String mrn = mrn_example; // String | MRN, associated with a particular `assigningAuthority`.
        try {
            EnrollmentStatusResponse result = apiInstance.enrollmentgetEnrollmentStatusGet(assigningAuthority, mpiid, mrn);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EnrollmentApi#enrollmentgetEnrollmentStatusGet");
            e.printStackTrace();
        }
    }
}
String *assigningAuthority = assigningAuthority_example; // Assigning Authority, associated with a particular `mrn`. (optional)
String *mpiid = mpiid_example; // MPI ID (optional)
String *mrn = mrn_example; // MRN, associated with a particular `assigningAuthority`. (optional)

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

[apiInstance enrollmentgetEnrollmentStatusGetWith:assigningAuthority
    mpiid:mpiid
    mrn:mrn
              completionHandler: ^(EnrollmentStatusResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PersonalCommunityServicesRestApi = require('personal_community_services_rest_api');

var api = new PersonalCommunityServicesRestApi.EnrollmentApi()
var opts = { 
  'assigningAuthority': assigningAuthority_example, // {{String}} Assigning Authority, associated with a particular `mrn`.
  'mpiid': mpiid_example, // {{String}} MPI ID
  'mrn': mrn_example // {{String}} MRN, associated with a particular `assigningAuthority`.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.enrollmentgetEnrollmentStatusGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new EnrollmentApi();
            var assigningAuthority = assigningAuthority_example;  // String | Assigning Authority, associated with a particular `mrn`. (optional) 
            var mpiid = mpiid_example;  // String | MPI ID (optional) 
            var mrn = mrn_example;  // String | MRN, associated with a particular `assigningAuthority`. (optional) 

            try
            {
                EnrollmentStatusResponse result = apiInstance.enrollmentgetEnrollmentStatusGet(assigningAuthority, mpiid, mrn);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EnrollmentApi.enrollmentgetEnrollmentStatusGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiEnrollmentApi();
$assigningAuthority = assigningAuthority_example; // String | Assigning Authority, associated with a particular `mrn`.
$mpiid = mpiid_example; // String | MPI ID
$mrn = mrn_example; // String | MRN, associated with a particular `assigningAuthority`.

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

my $api_instance = WWW::SwaggerClient::EnrollmentApi->new();
my $assigningAuthority = assigningAuthority_example; # String | Assigning Authority, associated with a particular `mrn`.
my $mpiid = mpiid_example; # String | MPI ID
my $mrn = mrn_example; # String | MRN, associated with a particular `assigningAuthority`.

eval { 
    my $result = $api_instance->enrollmentgetEnrollmentStatusGet(assigningAuthority => $assigningAuthority, mpiid => $mpiid, mrn => $mrn);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EnrollmentApi->enrollmentgetEnrollmentStatusGet: $@\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.EnrollmentApi()
assigningAuthority = assigningAuthority_example # String | Assigning Authority, associated with a particular `mrn`. (optional)
mpiid = mpiid_example # String | MPI ID (optional)
mrn = mrn_example # String | MRN, associated with a particular `assigningAuthority`. (optional)

try: 
    api_response = api_instance.enrollmentget_enrollment_status_get(assigningAuthority=assigningAuthority, mpiid=mpiid, mrn=mrn)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnrollmentApi->enrollmentgetEnrollmentStatusGet: %s\n" % e)

Parameters

Query parameters
Name Description
assigningAuthority
String
Assigning Authority, associated with a particular `mrn`.
mpiid
String
MPI ID
mrn
String
MRN, associated with a particular `assigningAuthority`.

Responses

Status: 200 - A successful response

Status: 400 - Error when only one of `assigningAuthority` or `mrn` is passed in, or none of the query parameters are passed in.

Status: 401 - Unauthorized

Status: 403 - Forbidden: Authentication Failure

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

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

Status: 500 - Internal Server Error


Invitations

invitationssendEnrollInvitationPost

Sends an enrollment invitation to a patient, associating it with an IRIS user as authenticated by the caller. Make sure to use the following header parameter: `Accept: application/json`


/invitations/$send-enroll-invitation

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//invitations/$send-enroll-invitation"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InvitationsApi;

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

public class InvitationsApiExample {

    public static void main(String[] args) {
        
        InvitationsApi apiInstance = new InvitationsApi();
        PatientEnrollInvitationNotification body = ; // PatientEnrollInvitationNotification | The details required for sending an enrollment invitation.
        try {
            InvitationsNotificationResponse result = apiInstance.invitationssendEnrollInvitationPost(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvitationsApi#invitationssendEnrollInvitationPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InvitationsApi;

public class InvitationsApiExample {

    public static void main(String[] args) {
        InvitationsApi apiInstance = new InvitationsApi();
        PatientEnrollInvitationNotification body = ; // PatientEnrollInvitationNotification | The details required for sending an enrollment invitation.
        try {
            InvitationsNotificationResponse result = apiInstance.invitationssendEnrollInvitationPost(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InvitationsApi#invitationssendEnrollInvitationPost");
            e.printStackTrace();
        }
    }
}
PatientEnrollInvitationNotification *body = ; // The details required for sending an enrollment invitation.

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

[apiInstance invitationssendEnrollInvitationPostWith:body
              completionHandler: ^(InvitationsNotificationResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PersonalCommunityServicesRestApi = require('personal_community_services_rest_api');

var api = new PersonalCommunityServicesRestApi.InvitationsApi()
var body = ; // {{PatientEnrollInvitationNotification}} The details required for sending an enrollment invitation.

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

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

            var apiInstance = new InvitationsApi();
            var body = new PatientEnrollInvitationNotification(); // PatientEnrollInvitationNotification | The details required for sending an enrollment invitation.

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

$api_instance = new Swagger\Client\ApiInvitationsApi();
$body = ; // PatientEnrollInvitationNotification | The details required for sending an enrollment invitation.

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

my $api_instance = WWW::SwaggerClient::InvitationsApi->new();
my $body = WWW::SwaggerClient::Object::PatientEnrollInvitationNotification->new(); # PatientEnrollInvitationNotification | The details required for sending an enrollment invitation.

eval { 
    my $result = $api_instance->invitationssendEnrollInvitationPost(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InvitationsApi->invitationssendEnrollInvitationPost: $@\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.InvitationsApi()
body =  # PatientEnrollInvitationNotification | The details required for sending an enrollment invitation.

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

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - Successful operation. The invitation has been sent.

Status: 400 - Bad Request. Invalid input data.

Status: 403 - Forbidden. The user does not have the necessary permissions.

Status: 415 - Unsupported Media Type. The server cannot process the provided media type.


Tasks

tasksIdPut

Update properties of the tasks whose ID matches the one supplied with the specified values. Make sure to use the following header parameter: `Content-Type: application/vnd.intersystems.com.hs.hspc.tasks.v0+json`


/tasks/{id}

Usage and SDK Samples

curl -X PUT\
-H "Accept: application/vnd.intersystems.com.hs.hspc.tasks.v0+json,application/json,default"\
-H "Content-Type: application/vnd.intersystems.com.hs.hspc.tasks.v0+json"\
"//tasks/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TasksApi;

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

public class TasksApiExample {

    public static void main(String[] args) {
        
        TasksApi apiInstance = new TasksApi();
        String id = id_example; // String | 
        TasksUpdateRequest body = ; // TasksUpdateRequest | 
        try {
            TasksResponse result = apiInstance.tasksIdPut(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TasksApi#tasksIdPut");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TasksApi;

public class TasksApiExample {

    public static void main(String[] args) {
        TasksApi apiInstance = new TasksApi();
        String id = id_example; // String | 
        TasksUpdateRequest body = ; // TasksUpdateRequest | 
        try {
            TasksResponse result = apiInstance.tasksIdPut(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TasksApi#tasksIdPut");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // 
TasksUpdateRequest *body = ; //  (optional)

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

[apiInstance tasksIdPutWith:id
    body:body
              completionHandler: ^(TasksResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PersonalCommunityServicesRestApi = require('personal_community_services_rest_api');

var api = new PersonalCommunityServicesRestApi.TasksApi()
var id = id_example; // {{String}} 
var opts = { 
  'body':  // {{TasksUpdateRequest}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.tasksIdPut(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new TasksApi();
            var id = id_example;  // String | 
            var body = new TasksUpdateRequest(); // TasksUpdateRequest |  (optional) 

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

$api_instance = new Swagger\Client\ApiTasksApi();
$id = id_example; // String | 
$body = ; // TasksUpdateRequest | 

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

my $api_instance = WWW::SwaggerClient::TasksApi->new();
my $id = id_example; # String | 
my $body = WWW::SwaggerClient::Object::TasksUpdateRequest->new(); # TasksUpdateRequest | 

eval { 
    my $result = $api_instance->tasksIdPut(id => $id, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TasksApi->tasksIdPut: $@\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.TasksApi()
id = id_example # String | 
body =  # TasksUpdateRequest |  (optional)

try: 
    api_response = api_instance.tasks_id_put(id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TasksApi->tasksIdPut: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Required
Body parameters
Name Description
body

Responses

Status: 200 - The updated tasks

Status: 403 - Forbidden: Authentication Failure

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


tasksPost

Create a new task, and write it to the database. Make sure to use the following header parameter: `Content-Type: application/vnd.intersystems.com.hs.hspc.tasks.v0+json`


/tasks

Usage and SDK Samples

curl -X POST\
-H "Accept: application/vnd.intersystems.com.hs.hspc.tasks.v0+json,application/json,default"\
-H "Content-Type: application/vnd.intersystems.com.hs.hspc.tasks.v0+json"\
"//tasks"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TasksApi;

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

public class TasksApiExample {

    public static void main(String[] args) {
        
        TasksApi apiInstance = new TasksApi();
        TasksCreateRequest body = ; // TasksCreateRequest | The information necessary to create a new task.
        try {
            TasksResponse result = apiInstance.tasksPost(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TasksApi#tasksPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TasksApi;

public class TasksApiExample {

    public static void main(String[] args) {
        TasksApi apiInstance = new TasksApi();
        TasksCreateRequest body = ; // TasksCreateRequest | The information necessary to create a new task.
        try {
            TasksResponse result = apiInstance.tasksPost(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TasksApi#tasksPost");
            e.printStackTrace();
        }
    }
}
TasksCreateRequest *body = ; // The information necessary to create a new task.

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

[apiInstance tasksPostWith:body
              completionHandler: ^(TasksResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PersonalCommunityServicesRestApi = require('personal_community_services_rest_api');

var api = new PersonalCommunityServicesRestApi.TasksApi()
var body = ; // {{TasksCreateRequest}} The information necessary to create a new task.

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

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

            var apiInstance = new TasksApi();
            var body = new TasksCreateRequest(); // TasksCreateRequest | The information necessary to create a new task.

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

$api_instance = new Swagger\Client\ApiTasksApi();
$body = ; // TasksCreateRequest | The information necessary to create a new task.

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

my $api_instance = WWW::SwaggerClient::TasksApi->new();
my $body = WWW::SwaggerClient::Object::TasksCreateRequest->new(); # TasksCreateRequest | The information necessary to create a new task.

eval { 
    my $result = $api_instance->tasksPost(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TasksApi->tasksPost: $@\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.TasksApi()
body =  # TasksCreateRequest | The information necessary to create a new task.

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

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - The newly-created tasks.

Status: 403 - Forbidden: Authentication Failure

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


tasksinsertDocumentProcessorPost

Associates an IRIS user, as determined by the authenticated user making this call, with a document processor class. Make sure to use the following header parameter: `Accept: application/json`


/tasks/$insert-document-processor

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json,default"\
-H "Content-Type: application/json"\
"//tasks/$insert-document-processor"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TasksApi;

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

public class TasksApiExample {

    public static void main(String[] args) {
        
        TasksApi apiInstance = new TasksApi();
        DocumentProcessorCreateRequest body = ; // DocumentProcessorCreateRequest | The information necessary to specify a document processor class for on-demand document patient tasks.
        try {
            DocumentProcessorCreateResponse result = apiInstance.tasksinsertDocumentProcessorPost(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TasksApi#tasksinsertDocumentProcessorPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TasksApi;

public class TasksApiExample {

    public static void main(String[] args) {
        TasksApi apiInstance = new TasksApi();
        DocumentProcessorCreateRequest body = ; // DocumentProcessorCreateRequest | The information necessary to specify a document processor class for on-demand document patient tasks.
        try {
            DocumentProcessorCreateResponse result = apiInstance.tasksinsertDocumentProcessorPost(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TasksApi#tasksinsertDocumentProcessorPost");
            e.printStackTrace();
        }
    }
}
DocumentProcessorCreateRequest *body = ; // The information necessary to specify a document processor class for on-demand document patient tasks.

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

[apiInstance tasksinsertDocumentProcessorPostWith:body
              completionHandler: ^(DocumentProcessorCreateResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PersonalCommunityServicesRestApi = require('personal_community_services_rest_api');

var api = new PersonalCommunityServicesRestApi.TasksApi()
var body = ; // {{DocumentProcessorCreateRequest}} The information necessary to specify a document processor class for on-demand document patient tasks.

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

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

            var apiInstance = new TasksApi();
            var body = new DocumentProcessorCreateRequest(); // DocumentProcessorCreateRequest | The information necessary to specify a document processor class for on-demand document patient tasks.

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

$api_instance = new Swagger\Client\ApiTasksApi();
$body = ; // DocumentProcessorCreateRequest | The information necessary to specify a document processor class for on-demand document patient tasks.

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

my $api_instance = WWW::SwaggerClient::TasksApi->new();
my $body = WWW::SwaggerClient::Object::DocumentProcessorCreateRequest->new(); # DocumentProcessorCreateRequest | The information necessary to specify a document processor class for on-demand document patient tasks.

eval { 
    my $result = $api_instance->tasksinsertDocumentProcessorPost(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TasksApi->tasksinsertDocumentProcessorPost: $@\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.TasksApi()
body =  # DocumentProcessorCreateRequest | The information necessary to specify a document processor class for on-demand document patient tasks.

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

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - An empty object indicating a successful request

Status: 403 - Forbidden: Authentication Failure

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

Status: 500 - Internal Server Error


tasksinsertStatusUpdateOperationPost

Associates an IRIS user, as determined by the authenticated user making this call, with a the operation name for the status update operation business component. Make sure to use the following header parameter: `Accept: application/json`


/tasks/$insert-status-update-operation

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json,default"\
-H "Content-Type: application/json"\
"//tasks/$insert-status-update-operation"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TasksApi;

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

public class TasksApiExample {

    public static void main(String[] args) {
        
        TasksApi apiInstance = new TasksApi();
        StatusUpdateOperationCreateRequest body = ; // StatusUpdateOperationCreateRequest | The information necessary to specify the operation name for the status update operation business component for the external system to be notified of changes to a patient task or task item.
        try {
            StatusUpdateOperationCreateResponse result = apiInstance.tasksinsertStatusUpdateOperationPost(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TasksApi#tasksinsertStatusUpdateOperationPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TasksApi;

public class TasksApiExample {

    public static void main(String[] args) {
        TasksApi apiInstance = new TasksApi();
        StatusUpdateOperationCreateRequest body = ; // StatusUpdateOperationCreateRequest | The information necessary to specify the operation name for the status update operation business component for the external system to be notified of changes to a patient task or task item.
        try {
            StatusUpdateOperationCreateResponse result = apiInstance.tasksinsertStatusUpdateOperationPost(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TasksApi#tasksinsertStatusUpdateOperationPost");
            e.printStackTrace();
        }
    }
}
StatusUpdateOperationCreateRequest *body = ; // The information necessary to specify the operation name for the status update operation business component for the external system to be notified of changes to a patient task or task item.

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

[apiInstance tasksinsertStatusUpdateOperationPostWith:body
              completionHandler: ^(StatusUpdateOperationCreateResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PersonalCommunityServicesRestApi = require('personal_community_services_rest_api');

var api = new PersonalCommunityServicesRestApi.TasksApi()
var body = ; // {{StatusUpdateOperationCreateRequest}} The information necessary to specify the operation name for the status update operation business component for the external system to be notified of changes to a patient task or task item.

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

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

            var apiInstance = new TasksApi();
            var body = new StatusUpdateOperationCreateRequest(); // StatusUpdateOperationCreateRequest | The information necessary to specify the operation name for the status update operation business component for the external system to be notified of changes to a patient task or task item.

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

$api_instance = new Swagger\Client\ApiTasksApi();
$body = ; // StatusUpdateOperationCreateRequest | The information necessary to specify the operation name for the status update operation business component for the external system to be notified of changes to a patient task or task item.

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

my $api_instance = WWW::SwaggerClient::TasksApi->new();
my $body = WWW::SwaggerClient::Object::StatusUpdateOperationCreateRequest->new(); # StatusUpdateOperationCreateRequest | The information necessary to specify the operation name for the status update operation business component for the external system to be notified of changes to a patient task or task item.

eval { 
    my $result = $api_instance->tasksinsertStatusUpdateOperationPost(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TasksApi->tasksinsertStatusUpdateOperationPost: $@\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.TasksApi()
body =  # StatusUpdateOperationCreateRequest | The information necessary to specify the operation name for the status update operation business component for the external system to be notified of changes to a patient task or task item.

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

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - An empty object indicating a successful request

Status: 403 - Forbidden: Authentication Failure

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

Status: 500 - Internal Server Error