Jump to

• Request
• Response

Get contacts and Organization association list by ID

get

/ec-site-svc/rest/v1.0/tenantsite/{entityType}/{entityId}/{associationType}/associations

Get contacts and Organization association list by Association ID.

Request

Path Parameters

• associationType(required): string
  Association type of entities in request. Allowed values are INVESTIGATOR_INSTITUTION, DEPOT_INSTITUTION, LAB_INSTITUTION
• entityId(required): string
  Institution, Investigator, Lab or Depot ID.
• entityType(required): string
  Institution, Investigator, Lab or Depot.

Query Parameters

• limit: integer(int32)
  Number of rows to return.
• modeId: string
  Mode of the contact or organization.
• name: string
  Filters contact, institution, lab and depots based on name
• offset: integer(int32)
  Row number to start from.
• order: string
  The Order in which the sites are returned.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : TenantSitesDetailsResponse

Type: object

Show Source

• associationId: string (uuid)
• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• modes: array modes
• objectVersionNumber: number
• operationType: string
  Minimum Length: 1

  Maximum Length: 16
• reason: string
• reasonForInvalidAssoc: array reasonForInvalidAssoc
• softwareVersionNumber: number
• studySitesCount: integer (int32)
• tenantFirstEntityId: string (uuid)
• tenantFirstEntityName: string
• tenantFirstEntityStatus: string (uuid)
• tenantSecondEntityId: string (uuid)
• tenantSecondEntityName: string
• tenantSecondEntityStatus: string (uuid)
• userId: string (uuid)
• valid: boolean
• versionEnd: string (date-time)
• versionStart: string (date-time)

{
    "type":"object",
    "properties":{
        "reason":{
            "type":"string"
        },
        "comment":{
            "maxLength":"2048",
            "minLength":"0",
            "type":"string"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "operationType":{
            "maxLength":"16",
            "minLength":"1",
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "tenantFirstEntityId":{
            "type":"string",
            "format":"uuid"
        },
        "tenantSecondEntityId":{
            "type":"string",
            "format":"uuid"
        },
        "associationId":{
            "type":"string",
            "format":"uuid"
        },
        "tenantFirstEntityName":{
            "type":"string"
        },
        "tenantSecondEntityName":{
            "type":"string"
        },
        "studySitesCount":{
            "type":"integer",
            "format":"int32"
        },
        "tenantFirstEntityStatus":{
            "type":"string",
            "format":"uuid"
        },
        "tenantSecondEntityStatus":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "reasonForInvalidAssoc":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ReasonForInvalidAssociationTO"
            }
        },
        "modes":{
            "type":"array",
            "items":{
                "type":"string",
                "format":"uuid"
            }
        },
        "valid":{
            "type":"boolean"
        }
    }
}

Nested Schema : modes

Type: array

Show Source

• Array of: string(uuid)

{
    "type":"array",
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

Nested Schema : reasonForInvalidAssoc

Type: array

Show Source

• Array of: object ReasonForInvalidAssociationTO

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ReasonForInvalidAssociationTO"
    }
}

Nested Schema : ReasonForInvalidAssociationTO

Type: object

Show Source

• context: string
• message: string

{
    "type":"object",
    "properties":{
        "context":{
            "type":"string"
        },
        "message":{
            "type":"string"
        }
    }
}

400 Response

Bad request.

Body ()

Root Schema : SDFResponse

Type: object

Show Source

• errorData: object ErrorResponseData
• result: object result
• status: string

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    }
}

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

Nested Schema : details

Type: object

Back to Top