Jump to

• Request
• Response

Get organizations details

get

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

Retrieves organizations details, organization addresses with studyUsage

Request

Query Parameters

• countryId: string
  Country ID.
• entitiesOption: string
  entitiesOption is optional. Allowed values are all, associated, notAssociated. Default is all.
• entityId: string
  entityId is optional. Id of the contact or organisation. This value passed in query parameter is considered only if entitiesOption is passed.
• limit: integer(int32)
  Number of rows to return.
• modeId: string
  Get organizations based on mode.
• name: string
  Get organizations based on name.
• offset: integer(int32)
  Row number to start from.
• order: string
  The Order in which the sites are returned.
• orgId: string
  organization identifier either institution identifier or vendor identifier.
• orgSubType: string
  Get organizations based on sub type.
• orgType: string
  Get organizations based on type.
• stateId: string
  State ID.
• status: string
  Get organizations based on status.

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

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

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