Get contacts and organization association list by ID
get
/ec-site-svc/rest/v1.0/tenantsite/{entityType}/{entityId}/{associationType}/associations
Retrieves a list of contacts and organization associations 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 TopResponse
Supported Media Types
- application/json
200 Response
Successful operation.
Root Schema : TenantSitesDetailsResponse
Type:
Show Source
object-
associationId: string
(uuid)
-
comment: string
Minimum Length:
0Maximum Length:2048 -
modes: array
modes
-
objectVersionNumber: number
-
operationType: string
Minimum Length:
1Maximum 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)
400 Response
Bad request.
Root Schema : SDFResponse
Type:
Show Source
object-
errorData: object
ErrorResponseData
Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
-
result: object
result
-
status: string
Nested Schema : ErrorResponseData
Type:
objectStructure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
Show Source
-
details: string
Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.Example:
User role is missing required permission REPORTING_VIEW. Field: userId -
errorCode: string
Application or business-specific error code representing the error type.Example:
REPT_401 -
errorMessage: string
Human-readable error message describing the failure or issue.Example:
Unauthorized: User does not have access to the requested resource
Nested Schema : result
Type:
object