Jump to

• Request
• Response

Update subject's site transfer information

post

/ec-query-svc/rest/v1.0/studies/{studyId}/{mode}/queries/subjectsitetransfer

Updates the subject's site transfer information, in order for the query to be shown in the latest site.

Request

Path Parameters

• mode(required): string
  Study mode.
• studyId(required): string
  Study ID.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Request and Response for Query Subject Transfer API

Show Source

• fromSiteId(required): string (uuid)
  Transfer from Site Unique GUID
• id: string (uuid)
  Read Only: true

  Site Transfer Unique GUID
• newSubjectNumber(required): string
  Minimum Length: 0

  Maximum Length: 500

  New Subject Number
• objectVersionNumber(required): number
  Object Version Number
• subjectId(required): string (uuid)
  Subject Unique GUID
• toSiteId(required): string (uuid)
  Transfer to Site Unique GUID

{
    "required":[
        "fromSiteId",
        "newSubjectNumber",
        "objectVersionNumber",
        "subjectId",
        "toSiteId"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Site Transfer Unique GUID",
            "format":"uuid",
            "readOnly":true
        },
        "subjectId":{
            "type":"string",
            "description":"Subject Unique GUID",
            "format":"uuid"
        },
        "newSubjectNumber":{
            "maxLength":"500",
            "minLength":"0",
            "type":"string",
            "description":"New Subject Number"
        },
        "fromSiteId":{
            "type":"string",
            "description":"Transfer from Site Unique GUID",
            "format":"uuid"
        },
        "toSiteId":{
            "type":"string",
            "description":"Transfer to Site Unique GUID",
            "format":"uuid"
        },
        "objectVersionNumber":{
            "type":"number",
            "description":"Object Version Number"
        }
    },
    "description":"Request and Response for Query Subject Transfer API"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : schema

Type: object

Request and Response for Query Subject Transfer API

Show Source

• fromSiteId(required): string (uuid)
  Transfer from Site Unique GUID
• id: string (uuid)
  Read Only: true

  Site Transfer Unique GUID
• newSubjectNumber(required): string
  Minimum Length: 0

  Maximum Length: 500

  New Subject Number
• objectVersionNumber(required): number
  Object Version Number
• subjectId(required): string (uuid)
  Subject Unique GUID
• toSiteId(required): string (uuid)
  Transfer to Site Unique GUID

{
    "required":[
        "fromSiteId",
        "newSubjectNumber",
        "objectVersionNumber",
        "subjectId",
        "toSiteId"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Site Transfer Unique GUID",
            "format":"uuid",
            "readOnly":true
        },
        "subjectId":{
            "type":"string",
            "description":"Subject Unique GUID",
            "format":"uuid"
        },
        "newSubjectNumber":{
            "maxLength":"500",
            "minLength":"0",
            "type":"string",
            "description":"New Subject Number"
        },
        "fromSiteId":{
            "type":"string",
            "description":"Transfer from Site Unique GUID",
            "format":"uuid"
        },
        "toSiteId":{
            "type":"string",
            "description":"Transfer to Site Unique GUID",
            "format":"uuid"
        },
        "objectVersionNumber":{
            "type":"number",
            "description":"Object Version Number"
        }
    },
    "description":"Request and Response for Query Subject Transfer API"
}

400 Response

Data is invalid.

Body ()

Root Schema : Response DTO

Type: object

Response from Query APIs

Show Source

• errorData: object Error details DTO
  Read Only: true

  Error details from Query APIs
• result: object result
  Read Only: true

  Result Object
• status: string
  Read Only: true

  Allowed Values: [ "success, failed" ]

  Status
• version: string
  Read Only: true

  Response version

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status",
            "readOnly":true,
            "enum":[
                "success, failed"
            ]
        },
        "result":{
            "type":"object",
            "description":"Result Object",
            "readOnly":true
        },
        "errorData":{
            "$ref":"#/components/schemas/Error details DTO"
        },
        "version":{
            "type":"string",
            "description":"Response version",
            "readOnly":true
        }
    },
    "description":"Response from Query APIs"
}

Nested Schema : Error details DTO

Type: object

Read Only: true

Error details from Query APIs

Show Source

• details: object details
  Read Only: true

  Error Details
• errorCode: string
  Read Only: true

  Error Code
• errorMessage: string
  Read Only: true

  Error Message

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error Code",
            "readOnly":true
        },
        "errorMessage":{
            "type":"string",
            "description":"Error Message",
            "readOnly":true
        },
        "details":{
            "type":"object",
            "description":"Error Details",
            "readOnly":true
        }
    },
    "description":"Error details from Query APIs",
    "readOnly":true
}

Nested Schema : result

Type: object

Read Only: true

Result Object

Nested Schema : details

Type: object

Read Only: true

Error Details

Back to Top