Jump to

• Request
• Response

v1.0

post

/ec-site-svc/rest/v1.0/tenantsite/associations/{associationId}/studySites

Creates the study sites for the given association ID.

Request

Path Parameters

• associationId(required): string
  Association ID to create the study sites.

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : STUDY_SITES_REQUEST_TITLE

Type: object

Title: STUDY_SITES_REQUEST_TITLE

STUDY_SITES_REQUEST_DESC

Show Source

• studySites: object CREATE_STUDY_SITES_DTO_TITLE
  Title: CREATE_STUDY_SITES_DTO_TITLE

  CREATE_STUDY_SITES_DTO_DESC

{
    "title":"STUDY_SITES_REQUEST_TITLE",
    "type":"object",
    "properties":{
        "studySites":{
            "title":"CREATE_STUDY_SITES_DTO_TITLE",
            "required":[
                "modeId",
                "siteIdName",
                "studyId"
            ],
            "type":"object",
            "properties":{
                "reason":{
                    "title":"Reason",
                    "maxLength":255,
                    "minLength":0,
                    "type":"string",
                    "description":"Reason provided for the audited update.",
                    "example":"Protocol update requested by study operations."
                },
                "comment":{
                    "title":"Comment",
                    "maxLength":2048,
                    "minLength":0,
                    "type":"string",
                    "description":"Additional comment captured for the audited update.",
                    "example":"Association adjusted after data reconciliation."
                },
                "id":{
                    "title":"CREATE_STUDY_SITES_DTO_ID_TITLE",
                    "type":"string",
                    "description":"CREATE_STUDY_SITES_DTO_ID_DESC",
                    "format":"uuid"
                },
                "studyId":{
                    "title":"CREATE_STUDY_SITES_DTO_STUDY_ID_TITLE",
                    "type":"string",
                    "description":"CREATE_STUDY_SITES_DTO_STUDY_ID_DESC",
                    "format":"uuid"
                },
                "modeId":{
                    "title":"CREATE_STUDY_SITES_DTO_MODE_ID_TITLE",
                    "type":"string",
                    "description":"CREATE_STUDY_SITES_DTO_MODE_ID_DESC",
                    "format":"uuid"
                },
                "siteIdName":{
                    "title":"CREATE_STUDY_SITES_DTO_SITE_ID_NAME_TITLE",
                    "maxLength":50,
                    "minLength":0,
                    "type":"string",
                    "description":"CREATE_STUDY_SITES_DTO_SITE_ID_NAME_DESC",
                    "example":"SITE-123"
                },
                "statusId":{
                    "title":"CREATE_STUDY_SITES_DTO_STATUS_ID_TITLE",
                    "type":"string",
                    "description":"CREATE_STUDY_SITES_DTO_STATUS_ID_DESC",
                    "format":"uuid"
                }
            },
            "description":"CREATE_STUDY_SITES_DTO_DESC",
            "example":[
                {
                    "id":"C36A3197FDEE433FB5547EE83DE99E4B"
                }
            ]
        }
    },
    "description":"STUDY_SITES_REQUEST_DESC"
}

Nested Schema : CREATE_STUDY_SITES_DTO_TITLE

Type: object

Title: CREATE_STUDY_SITES_DTO_TITLE

CREATE_STUDY_SITES_DTO_DESC

Show Source

• comment: string
  Title: Comment

  Minimum Length: 0

  Maximum Length: 2048

  Additional comment captured for the audited update.

  Example: Association adjusted after data reconciliation.
• id: string (uuid)
  Title: CREATE_STUDY_SITES_DTO_ID_TITLE

  CREATE_STUDY_SITES_DTO_ID_DESC
• modeId(required): string (uuid)
  Title: CREATE_STUDY_SITES_DTO_MODE_ID_TITLE

  CREATE_STUDY_SITES_DTO_MODE_ID_DESC
• reason: string
  Title: Reason

  Minimum Length: 0

  Maximum Length: 255

  Reason provided for the audited update.

  Example: Protocol update requested by study operations.
• siteIdName(required): string
  Title: CREATE_STUDY_SITES_DTO_SITE_ID_NAME_TITLE

  Minimum Length: 0

  Maximum Length: 50

  CREATE_STUDY_SITES_DTO_SITE_ID_NAME_DESC

  Example: SITE-123
• statusId: string (uuid)
  Title: CREATE_STUDY_SITES_DTO_STATUS_ID_TITLE

  CREATE_STUDY_SITES_DTO_STATUS_ID_DESC
• studyId(required): string (uuid)
  Title: CREATE_STUDY_SITES_DTO_STUDY_ID_TITLE

  CREATE_STUDY_SITES_DTO_STUDY_ID_DESC

{
    "title":"CREATE_STUDY_SITES_DTO_TITLE",
    "required":[
        "modeId",
        "siteIdName",
        "studyId"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "title":"Reason",
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason provided for the audited update.",
            "example":"Protocol update requested by study operations."
        },
        "comment":{
            "title":"Comment",
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Additional comment captured for the audited update.",
            "example":"Association adjusted after data reconciliation."
        },
        "id":{
            "title":"CREATE_STUDY_SITES_DTO_ID_TITLE",
            "type":"string",
            "description":"CREATE_STUDY_SITES_DTO_ID_DESC",
            "format":"uuid"
        },
        "studyId":{
            "title":"CREATE_STUDY_SITES_DTO_STUDY_ID_TITLE",
            "type":"string",
            "description":"CREATE_STUDY_SITES_DTO_STUDY_ID_DESC",
            "format":"uuid"
        },
        "modeId":{
            "title":"CREATE_STUDY_SITES_DTO_MODE_ID_TITLE",
            "type":"string",
            "description":"CREATE_STUDY_SITES_DTO_MODE_ID_DESC",
            "format":"uuid"
        },
        "siteIdName":{
            "title":"CREATE_STUDY_SITES_DTO_SITE_ID_NAME_TITLE",
            "maxLength":50,
            "minLength":0,
            "type":"string",
            "description":"CREATE_STUDY_SITES_DTO_SITE_ID_NAME_DESC",
            "example":"SITE-123"
        },
        "statusId":{
            "title":"CREATE_STUDY_SITES_DTO_STATUS_ID_TITLE",
            "type":"string",
            "description":"CREATE_STUDY_SITES_DTO_STATUS_ID_DESC",
            "format":"uuid"
        }
    },
    "description":"CREATE_STUDY_SITES_DTO_DESC",
    "example":[
        {
            "id":"C36A3197FDEE433FB5547EE83DE99E4B"
        }
    ]
}

Example:

[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]

Examples

Select an example Create Study Sites Request

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : SDFResponse

Type: object

Title: SDFResponse

Wrapper for service responses containing result or error data.

Show Source

• errorData: object ErrorResponseData
• result: object result
  The result object for successful requests. Type depends on the API operation.
• status: string
  Status of the response, either 'success' or an error indication.

  Example: success

{
    "title":"SDFResponse",
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of the response, either 'success' or an error indication.",
            "example":"success"
        },
        "result":{
            "type":"object",
            "description":"The result object for successful requests. Type depends on the API operation.",
            "example":{
                "hasMore":"true",
                "totalResults":5,
                "count":5,
                "data":[
                ]
            }
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    },
    "description":"Wrapper for service responses containing result or error data."
}

Nested 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 : result

Type: object

The result object for successful requests. Type depends on the API operation.

Example:

{
    "hasMore":"true",
    "totalResults":5,
    "count":5,
    "data":[
    ]
}

Nested Schema : details

Type: object

Examples

Select an example Create Study Sites Success Response

400 Response

Returned when one or more path parameters, query parameters, or request-body values fail endpoint validation.

Body ()

Root Schema : SDFResponse

Type: object

Title: SDFResponse

Wrapper for service responses containing result or error data.

Show Source

• errorData: object ErrorResponseData
• result: object result
  The result object for successful requests. Type depends on the API operation.
• status: string
  Status of the response, either 'success' or an error indication.

  Example: success

{
    "title":"SDFResponse",
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of the response, either 'success' or an error indication.",
            "example":"success"
        },
        "result":{
            "type":"object",
            "description":"The result object for successful requests. Type depends on the API operation.",
            "example":{
                "hasMore":"true",
                "totalResults":5,
                "count":5,
                "data":[
                ]
            }
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    },
    "description":"Wrapper for service responses containing result or error data."
}

Nested 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 : result

Type: object

The result object for successful requests. Type depends on the API operation.

Example:

{
    "hasMore":"true",
    "totalResults":5,
    "count":5,
    "data":[
    ]
}

Nested Schema : details

Type: object

Examples

Select an example Bad Request Response

Back to Top