Marking Visits as Planned or UnPlanned

This API accepts list of subject visits and marks them as 'Planned Visits'. Rest of the subject visits, which are not included in this API will be marked as 'Unplanned Visits' for that particular subject.

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

The Clinical Item field is used for Clinical One Integration.

Integration Id and Protocol Number are mandatory fields in Clinical Subject section and Clinical Item is mandatory field in Visit Plan section to use this API.

Populate “Clinical Item” field of a visit during Insert SVT API call. Once Subject is scheduled, this field's data will be copied from SVT to Subject Visit.

The following request will Mark Visits Planned/Unplanned in Siebel Clinical:

• URI: https://ServerName:port/siebel/v1.0/workflow/LS Clinical Subject Visit Plan
• HTTP Method: POST
• Content-Type: application/json
• Authorization: Basic
• Request body:

  {
      "DATA": {
          "MessageId": "",
          "MessageType": "Integration Object",
          "IntObjectName": "LS Clinical Visit Plan Mark",
          "IntObjectFormat": "Siebel Hierarchical",
          "ListOfLS Clinical Visit Plan Mark": {
              "Clinical Subject": [
                  {
                      "Protocol Number": "PT_Protocol_001",
                      "Integration Id": "Int_Test_SVT_01",
                      "ListOfVisit Plan": {
                          "Visit Plan": [
                              {
                                  "Clinical Item": "Re-screening Visit"
                              },
                              {
                                  "Clinical Item": "Screening Visit"
                              }
                          ]
                      }
                  }
              ]
          }
      }
  }

Here are the response details for a successful request:

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

  {
      "Error Code": "",
      "ResponseMessage": "Success",
      "Error Message": ""
  }