Using Siebel REST API For Siebel Clinical

This chapter describes Siebel Representational State Transfer (RESTful) Services for Siebel Clinical users and how to use them. It includes the following topics:

Configuring Siebel Clinical Users

You can use Siebel Tools to configure Siebel Clinical users to pass default position and responsibility information in the Siebel REST response. For more information about Siebel Clinical, see Siebel Clinical Trial Management System Guide.

To configure Siebel Clinical Users

Log into Siebel Tools as an administrator.
Navigate to the Administration - Application screen and then the Business Service view.
In the Business Service list, select the Clinical User Provisioning Service business service.
In the Business Service Method list, select the CreateUser method.
The selected business service method appears in the Business Service Method list view.
In the Business Service Method Arguments list, select Default Position.

Note: The Default Position must belong to the Default Organization.
In the Business Service Method Arguments list, select Default Responsibility.
Step off the record to save changes.

Using the Siebel REST API with Siebel Clinical

You can use the Siebel REST API to create, synchronize, and delete Siebel Clinical users. For more information about Siebel Clinical, see Siebel Clinical Trial Management System Guide.

You can also use the Siebel REST API to invoke business services using Siebel server script techniques. For more information, see Using Siebel Tools.

When you create or synchronize Siebel Clinical users, you can pass default position and responsibility information in the Siebel REST API response by configuring the LS Clinical User Provisioning Service Business method. For more information, see Configuring Siebel Clinical Users.

Creating a Siebel Clinical User

The following details are for a request to create a Siebel clinical user on the Siebel CRM Server:

URI:http://ServerName:port/siebel-rest/v1.0/service/LS Clinical User Provisioning Service/CreateUser
HTTP Method: POST
Content-Type: application/json
Authorization: Basic

Request body:

{
  "body":
  {
    "Employee":
    {
      "First Name": "Cathy",
      "Last Name": "Rogers",
      "Login Name":"Cathy.Rogers",
      "EMail Addr":"Cathy.Rogers@oracle.com"
    }
    "ListOfPosition":
    {
      "Position":
      {
        "Name":"Cathy.Rogers",
        "Division":"Default Organization"
      }
    },
    "ListOfEmployee_Responsibility":
    {
      "Employee_Responsibility":
      {
        "Responsibility":"Clinical Research Associate
      }
    }
  }
}

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json
Response body: None.

Synchronizing a Siebel Clinical User

The following details are for a request to synchronize a Siebel clinical user on the Siebel CRM Server:

URI: http:/ServerName:port//siebel-rest/v1.0/service/LS Clinical User Provisioning Service/SynchronizeUser
HTTP Method: POST
Content-Type: application/json
Authorization: Basic
Request body:

{
  "body": 
    {
      "Employee": 
       {
         "Login Name": "Cathy.Rogers",
         "Field 1": "Value 1",
         "Field 2": "Value 2",
         ………..
       }
    }
}

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json
Response body: None.

Deleting a Siebel Clinical User

When you use the Siebel REST API to delete a Siebel clinical user, the Siebel Clinical application performs a soft delete of the clinical user by stamping the Termination Date field with the Current Date value and removing the user’s responsibilities.

The following details are for a request to delete a Siebel clinical user on the Siebel CRM Server:

URI: http://ServerName:port/siebel-rest/v1.0/service/LS Clinical User Provisioning Service/TerminateUser
HTTP Method: POST
Content-Type: application/json
Authorization: Basic

Request body:

{
 "body":
  {
    "Employee":
    {
      "First Name": "Cathy",
      "Last Name": "Rogers",
      "Login Name":"Cathy.Rogers",
      "EMail Addr":"Cathy.Rogers@oracle.com"
    }
    "ListOfPosition":
    {
      "Position":
      {
         "Name":"Cathy.Rogers",
         "Division":"Default Organization"
       }
    },
     "ListOfEmployee_Responsibility":
     {
        "Employee_Responsibility":
        {
           "Responsibility":"Clinical Research Associate
        }
     }
  }
}

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json
Response body: None.