Querying Item Library in Siebel Clinical

This API is used to query the Item Library from EDC Item Mapping in SVT. It fetches all Item Libraries of an SVT under given Protocol where Integrate Flag is Y.

Note: The user invoking this API should have “Digital Gateway Integration Responsibility” responsibility in Siebel. Otherwise, the user will get "access denied" error.

Protocol Number is the required field in the payload.

The following sample request will query Item Library under given Protocol in Siebel Clinical:

• URI: https://ServerName:port/siebel/v1.0/service/LS Clinical Item Library Service/querypage/
• HTTP Method: POST
• Content-Type: application/json
• Authorization: Basic
• Request body:

  {
    "body": {
      "Protocol Number": "PT_Protocol_001",
      "NewQuery": True,
      "PageSize": "10",
      "StartRowNum": "0"
    }
  }

Here are the response details for a successful request:

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

  {
      "NumOutputObjects": "2",
      "ResponseMessage": "Success",
      "LastPage": "true",
      "ItemData": {
          "IntObjectFormat": "Siebel Hierarchical",
          "MessageId": "88-873FM",
          "IntObjectName": "LS Clinical Item Library IO",
          "MessageType": "Integration Object",
          "LS Clinical Item Library": [
              {
                  "Description": "Date of Birth",
                  "Form Name": "Demographics",
                  "Integration Flag": "Y",
                  "Name": "Act601ScreeningAct601",
                  "Payment Amount": "",
                  "Payment Flag": "N",
                  "Protocol Number": "PT_Protocol_001",
                  "Clinical Item": "ScreeningAct601",
                  "Form Id": "Act601"
              },
              {
                  "Description": "Would you like to register visit?",
                  "Form Name": "Register Visit",
                  "Integration Flag": "Y",
                  "Name": "FormId00602ScheduleableActivity602",
                  "Payment Amount": "",
                  "Payment Flag": "N",
                  "Protocol Number": "PT_Protocol_001",
                  "Clinical Item": "ScheduleableActivity602",
                  "Form Id": "FormId00602"
              }
          ]
      }
  }