Jump to

• Request
• Response

v1.0

get

/ec-auth-svc/rest/v1.0/sites

Retrieves the sites for a specific user.

Request

There are no request parameters for this operation.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : SitesListDto

Type: object

Title: SitesListDto

DTO containing the set of site UUIDs assigned to the user in a study/mode context.

Show Source

• allSites: boolean
  Indicates if the user has access to all sites in the study.

  Example: false
• associatedSites: array associatedSites
  A list of UUIDs identifying sites assigned to the user.

{
    "title":"SitesListDto",
    "type":"object",
    "properties":{
        "allSites":{
            "type":"boolean",
            "description":"Indicates if the user has access to all sites in the study.",
            "example":false
        },
        "associatedSites":{
            "type":"array",
            "description":"A list of UUIDs identifying sites assigned to the user.",
            "example":[
                "6E697AEB85A24A22B38C70495A0A5C48",
                "4E9523BF795D4FE4AB9BF1EF8A340FAB"
            ],
            "items":{
                "type":"string",
                "description":"A list of UUIDs identifying sites assigned to the user.",
                "format":"uuid"
            }
        }
    },
    "description":"DTO containing the set of site UUIDs assigned to the user in a study/mode context."
}

Nested Schema : associatedSites

Type: array

A list of UUIDs identifying sites assigned to the user.

Show Source

• Array of: string(uuid)
  A list of UUIDs identifying sites assigned to the user.

{
    "type":"array",
    "description":"A list of UUIDs identifying sites assigned to the user.",
    "example":[
        "6E697AEB85A24A22B38C70495A0A5C48",
        "4E9523BF795D4FE4AB9BF1EF8A340FAB"
    ],
    "items":{
        "type":"string",
        "description":"A list of UUIDs identifying sites assigned to the user.",
        "format":"uuid"
    }
}

Example:

[
    "6E697AEB85A24A22B38C70495A0A5C48",
    "4E9523BF795D4FE4AB9BF1EF8A340FAB"
]

Examples

Select an example Example of returned site list

400 Response

Bad request

Body ()

Root Schema : AuthResponse

Type: object

Generic API response wrapper containing result, error data, response version and status.

Show Source

• errorData: object ErrorResponseData
  Title: ErrorResponseData

  Error Response Details Information
• result: object result
  Result data of the API response; actual type depends on the API
• status: string (none)
  Indicates request success ("success") or failure ("failure").

  Example: success
• version: integer (int32)
  Version of the response schema.

  Example: 1

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Indicates request success (\"success\") or failure (\"failure\").",
            "format":"none",
            "example":"success"
        },
        "result":{
            "type":"object",
            "description":"Result data of the API response; actual type depends on the API",
            "example":null
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "description":"Version of the response schema.",
            "format":"int32",
            "example":1
        }
    },
    "description":"Generic API response wrapper containing result, error data, response version and status."
}

Nested Schema : ErrorResponseData

Type: object

Title: ErrorResponseData

Error Response Details Information

Show Source

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

  Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Result data of the API response; actual type depends on the API

Example:

oracle.doceng.json.BetterJsonNull@65719c12

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Back to Top