Jump to

• Request
• Response

v2.0

get

/ec-site-svc/rest/v2.0/organizations

Compared with v1, this version includes studyUsage details in organization addresses.

Request

Query Parameters

• countryId(required): string
  Minimum Length: 32

  Maximum Length: 32

  Pattern: ^[A-F0-9]{32}$

  Country identifier as a 32-character uppercase hexadecimal UUID string.

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

• entitiesOption(required): string
  entitiesOption is optional. Allowed values are all, associated, notAssociated. Default is all.

  Allowed Values: [ "all", "associated", "notAssociated" ]

  Example:

  all

• entityId(required): string
  Minimum Length: 32

  Maximum Length: 32

  Pattern: ^[A-F0-9]{32}$

  Optional entity identifier filter. This value is used only when entitiesOption is provided.

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

• limit(required): integer(int32)
  Minimum Value: 0

  Maximum Value: 1000

  Maximum number of rows to return. Only non-negative integers are accepted.

  Example:

  50

• modeId(required): string
  Minimum Length: 32

  Maximum Length: 32

  Pattern: ^[A-F0-9]{32}$

  Mode filter identifier for organizations. Use the modeId associated with active, test, or training mode.

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

• name(required): string
  Minimum Length: 1

  Maximum Length: 255

  Optional organization-name filter. Matches organizations by full or partial name.

  Example:

  Site A

• offset(required): integer(int32)
  Minimum Value: 0

  Zero-based row index to start pagination. Only non-negative integers are accepted.

  Example:

  0

• order(required): string
  Optional query parameter. Sort direction for returned rows. Allowed values: asc, desc, ASC, DESC.

  Allowed Values: [ "ASC", "DESC", "asc", "desc" ]

  Example:

  DESC

• orgId(required): string
  Minimum Length: 32

  Maximum Length: 32

  Pattern: ^[A-F0-9]{32}$

  Optional organization identifier filter (institution identifier or vendor identifier).

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

• orgSubType(required): string
  Minimum Length: 1

  Maximum Length: 50

  Organization sub-type filter. Allowed values depend on organization type and study configuration.

  Example:

  SITE

• orgType(required): string
  Minimum Length: 1

  Maximum Length: 50

  Organization type filter. Allowed values are study-specific code-list entries, typically INSTITUTION, LAB, or DEPOT.

  Example:

  INSTITUTION

• stateId(required): string
  Minimum Length: 32

  Maximum Length: 32

  Pattern: ^[A-F0-9]{32}$

  State identifier as a 32-character uppercase hexadecimal UUID string.

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

• status(required): string
  Organization status filter. Allowed values: ACTIVE (available), NEW (newly created), RESTRICTED (limited use), DISBARRED (blocked), DECEASED (closed), RETIRED (inactive).

  Allowed Values: [ "ACTIVE", "NEW", "RESTRICTED", "DISBARRED", "DECEASED", "RETIRED" ]

  Example:

  ACTIVE

There's no request body for this operation.

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 Get Organizations V2 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