GET /api/v3/ucc/psec_groups/by_group_name
Get PSEC group member records filtered by group

Learn how to use Suran API on the Suran Help Center.

Params

Param name Description
group_name
required

Name of the PSEC group to filter by

Validations:

  • Must be a String

Returns

Code: 200

Description:

List of PSEC group member records matching the specified group

Param name Description
data
required

Single PSEC group member

Validations:

  • Must be a Hash
data[id]
required

ID of the PSEC group member

Validations:

  • Must be a number.
data[type]
required

Type of the resources

Validations:

  • Must be a String
data[attributes]
required

Attributes of the PSEC group member

Validations:

  • Must be a Hash
data[attributes][group_type_description]
required

PSEC group type description

Validations:

  • Must be a String
data[attributes][group_name]
required

PSEC group name

Validations:

  • Must be a String
data[attributes][position]
required

PSEC position name

Validations:

  • Must be a String
data[attributes][name]
required

PSEC group member name

Validations:

  • Must be a String
data[attributes][association_name]
required

PSEC group member association name

Validations:

  • Must be a String
data[attributes][email]
required

PSEC group member email

Validations:

  • Must be a String
data[attributes][sortorder]
optional

Order of rendering

Validations:

  • Must be a number.

Code: 401

Description:

Unauthorized

Param name Description
errors
required

Errors returned by request

Validations:

  • Must be an Array of nested elements
errors[error]
required

Why the request failed

Validations:

  • Must be a String
errors[status]
required

HTTP response code

Validations:

  • Must be a Integer

Code: 404

Description:

Not Found

Param name Description
errors
required

Errors returned by request

Validations:

  • Must be an Array of nested elements
errors[error]
required

Why the request failed

Validations:

  • Must be a String
errors[status]
required

HTTP response code

Validations:

  • Must be a Integer

Code: 422

Description:

Unprocessable Entity

Param name Description
errors
required

Errors returned by request

Validations:

  • Must be an Array of nested elements
errors[error]
required

Why the request failed

Validations:

  • Must be a String
errors[status]
required

HTTP response code

Validations:

  • Must be a Integer

Code: 500

Description:

Internal Server Error

Param name Description
errors
required

Errors returned by request

Validations:

  • Must be an Array of nested elements
errors[error]
required

Why the request failed

Validations:

  • Must be a String
errors[status]
required

HTTP response code

Validations:

  • Must be a Integer

Errors

Code Description
404 Data source query failed
422 Invalid parameter(s)
500 No connection to data source