Jump to

• Request
• Response

Create visit schedule

post

/ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/visits/{visitid}/schedule/{fromEventRefId}

Creates a visit schedule for your study.

Request

Path Parameters

• fromEventRefId(required): string(uuid)
  From Event Ref Id
• studyId(required): string(uuid)
  Study ID. Example: F054C951EB74443C93716CA714AB686E
• version(required): string
  Study version. Example: "1.0.0.1"
• visitid(required): string(uuid)
  Visit identifier

Supported Media Types

• */*

Request Body - */* ()

Root Schema : StudyEventScheduleDto v4.0

Type: object

Title: StudyEventScheduleDto v4.0

Study event schedule details.

Show Source

• branchId: string (uuid)
  Visit branch GUID
• delay(required): object StudyEventScheduleDelay v1.0
  Title: StudyEventScheduleDelay v1.0

  study event schedule delay.
• delayWindow(required): object StudyEventScheduleDelayWindow v1.0
  Title: StudyEventScheduleDelayWindow v1.0

  Study event schedule delay window.
• outOfWindowAlert: string (string)
  Outside Visit Window Alert

  Example: OFF
• outOfWindowHardStopEnforced: integer (int32)
  Out off window hard stop enforced

  Example: 1
• outOfWindowVisitApprovalGranted: integer (int32)
  Out off window visit approval granted

  Example: 1
• projectedFromRefId(required): string (uuid)
  Projected from reference GUID

{
    "title":"StudyEventScheduleDto v4.0",
    "required":[
        "delay",
        "delayWindow",
        "projectedFromRefId"
    ],
    "type":"object",
    "properties":{
        "delay":{
            "$ref":"#/components/schemas/StudyEventScheduleDelayV1"
        },
        "delayWindow":{
            "$ref":"#/components/schemas/StudyEventScheduleDelayWindowV1"
        },
        "outOfWindowHardStopEnforced":{
            "type":"integer",
            "description":"Out off window hard stop enforced",
            "format":"int32",
            "example":"1"
        },
        "outOfWindowVisitApprovalGranted":{
            "type":"integer",
            "description":"Out off window visit approval granted",
            "format":"int32",
            "example":"1"
        },
        "projectedFromRefId":{
            "type":"string",
            "description":"Projected from reference GUID",
            "format":"uuid"
        },
        "branchId":{
            "type":"string",
            "description":"Visit branch GUID",
            "format":"uuid"
        },
        "outOfWindowAlert":{
            "type":"string",
            "description":"Outside Visit Window Alert",
            "format":"string",
            "example":"OFF"
        }
    },
    "description":"Study event schedule details."
}

Nested Schema : StudyEventScheduleDelay v1.0

Type: object

Title: StudyEventScheduleDelay v1.0

study event schedule delay.

Show Source

• days: integer (int32)
  Minimum Value: 0

  Study event schedule delay in days

  Example: 1
• hours: integer (int32)
  Minimum Value: 0

  Study event schedule delay in hours

  Example: 1

{
    "title":"StudyEventScheduleDelay v1.0",
    "type":"object",
    "properties":{
        "days":{
            "minimum":"0",
            "type":"integer",
            "description":"Study event schedule delay in days",
            "format":"int32",
            "example":"1"
        },
        "hours":{
            "minimum":"0",
            "type":"integer",
            "description":"Study event schedule delay in hours",
            "format":"int32",
            "example":"1"
        }
    },
    "description":"study event schedule delay."
}

Nested Schema : StudyEventScheduleDelayWindow v1.0

Type: object

Title: StudyEventScheduleDelayWindow v1.0

Study event schedule delay window.

Show Source

• after: object StudyEventScheduleDelay v1.0
  Title: StudyEventScheduleDelay v1.0

  study event schedule delay.
• before: object StudyEventScheduleDelay v1.0
  Title: StudyEventScheduleDelay v1.0

  study event schedule delay.

{
    "title":"StudyEventScheduleDelayWindow v1.0",
    "type":"object",
    "properties":{
        "before":{
            "$ref":"#/components/schemas/StudyEventScheduleDelayV1"
        },
        "after":{
            "$ref":"#/components/schemas/StudyEventScheduleDelayV1"
        }
    },
    "description":"Study event schedule delay window."
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : StudyEventScheduleDto v4.0

Type: object

Title: StudyEventScheduleDto v4.0

Study event schedule details.

Show Source

• branchId: string (uuid)
  Visit branch GUID
• delay(required): object StudyEventScheduleDelay v1.0
  Title: StudyEventScheduleDelay v1.0

  study event schedule delay.
• delayWindow(required): object StudyEventScheduleDelayWindow v1.0
  Title: StudyEventScheduleDelayWindow v1.0

  Study event schedule delay window.
• outOfWindowAlert: string (string)
  Outside Visit Window Alert

  Example: OFF
• outOfWindowHardStopEnforced: integer (int32)
  Out off window hard stop enforced

  Example: 1
• outOfWindowVisitApprovalGranted: integer (int32)
  Out off window visit approval granted

  Example: 1
• projectedFromRefId(required): string (uuid)
  Projected from reference GUID

{
    "title":"StudyEventScheduleDto v4.0",
    "required":[
        "delay",
        "delayWindow",
        "projectedFromRefId"
    ],
    "type":"object",
    "properties":{
        "delay":{
            "$ref":"#/components/schemas/StudyEventScheduleDelayV1"
        },
        "delayWindow":{
            "$ref":"#/components/schemas/StudyEventScheduleDelayWindowV1"
        },
        "outOfWindowHardStopEnforced":{
            "type":"integer",
            "description":"Out off window hard stop enforced",
            "format":"int32",
            "example":"1"
        },
        "outOfWindowVisitApprovalGranted":{
            "type":"integer",
            "description":"Out off window visit approval granted",
            "format":"int32",
            "example":"1"
        },
        "projectedFromRefId":{
            "type":"string",
            "description":"Projected from reference GUID",
            "format":"uuid"
        },
        "branchId":{
            "type":"string",
            "description":"Visit branch GUID",
            "format":"uuid"
        },
        "outOfWindowAlert":{
            "type":"string",
            "description":"Outside Visit Window Alert",
            "format":"string",
            "example":"OFF"
        }
    },
    "description":"Study event schedule details."
}

Nested Schema : StudyEventScheduleDelay v1.0

Type: object

Title: StudyEventScheduleDelay v1.0

study event schedule delay.

Show Source

• days: integer (int32)
  Minimum Value: 0

  Study event schedule delay in days

  Example: 1
• hours: integer (int32)
  Minimum Value: 0

  Study event schedule delay in hours

  Example: 1

{
    "title":"StudyEventScheduleDelay v1.0",
    "type":"object",
    "properties":{
        "days":{
            "minimum":"0",
            "type":"integer",
            "description":"Study event schedule delay in days",
            "format":"int32",
            "example":"1"
        },
        "hours":{
            "minimum":"0",
            "type":"integer",
            "description":"Study event schedule delay in hours",
            "format":"int32",
            "example":"1"
        }
    },
    "description":"study event schedule delay."
}

Nested Schema : StudyEventScheduleDelayWindow v1.0

Type: object

Title: StudyEventScheduleDelayWindow v1.0

Study event schedule delay window.

Show Source

• after: object StudyEventScheduleDelay v1.0
  Title: StudyEventScheduleDelay v1.0

  study event schedule delay.
• before: object StudyEventScheduleDelay v1.0
  Title: StudyEventScheduleDelay v1.0

  study event schedule delay.

{
    "title":"StudyEventScheduleDelayWindow v1.0",
    "type":"object",
    "properties":{
        "before":{
            "$ref":"#/components/schemas/StudyEventScheduleDelayV1"
        },
        "after":{
            "$ref":"#/components/schemas/StudyEventScheduleDelayV1"
        }
    },
    "description":"Study event schedule delay window."
}

500 Response

Error

Body ()

Root Schema : ErrorResponseData

Type: object

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : details

Type: object

Back to Top