Koucc groups

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

>>>

GET /api/v3/ucc/koucc_groups
Get all KOUCC group member records

Params

Param name Description
page
optional

Pagination setting

Validations:

  • Must be a Hash
page[size]
optional

Page size

Validations:

  • Must be a number.
page[number]
optional

Page number

Validations:

  • Must be a number.
sort
optional

Sorting setting

Validations:

  • Must be a Hash
sort[key]
optional

Sort by

Validations:

  • Must be a String
sort[direction]
optional

Sort direction

Validations:

  • Must be a String
sort[special_clause]
optional

Special Clause

Validations:

  • Must be a String
linkedTo
optional

Sorting setting

Validations:

  • Must be a Hash
linkedTo[fk]
optional

Sort by

Validations:

  • Must be a String
linkedTo[fk_table]
optional

Sort direction

Validations:

  • Must be a String
filter_value
optional

Filter string value

Validations:

  • Must be a String
searches
optional

Hash of search queries

Validations:

  • Must be a Hash
exclusions
optional

Hash of exclude queries

Validations:

  • Must be a Hash
principle_resource
optional

Parent resource

Validations:

  • Must be a Hash
principle_resource[name]
optional

Name of resource

Validations:

  • Must be a String
principle_resource[identifier]
optional

ID value

Validations:

  • Must be a number.
related_resource
optional

Related resource

Validations:

  • Must be a Hash
related_resource[name]
optional

Name of resource

Validations:

  • Must be a String
related_resource[column]
optional

resouce column

Validations:

  • Must be a String
related_resource[value]
optional

resource value

Validations:

  • Must be a number.

Returns

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
>>>

GET /api/v3/ucc/koucc_groups/:id
Get a KOUCC group member record specified by its ID

Params

Param name Description
id
required

ID for KOUCC group member

Validations:

  • Must be a number.

Returns

Code: 200

Description:

Specified KOUCC group member record

Param name Description
data
required

Single KOUCC group member

Validations:

  • Must be a Hash
data[id]
required

ID of the KOUCC 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 KOUCC group member

Validations:

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

KOUCC group name

Validations:

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

KOUCC position name

Validations:

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

KOUCC group member name

Validations:

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

KOUCC group member personal phone

Validations:

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

KOUCC group member personal cell phone

Validations:

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

KOUCC group member work phone

Validations:

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

KOUCC 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
>>>

GET /api/v3/ucc/koucc_groups/by_group_name
Get KOUCC group member records filtered by group

Params

Param name Description
group_name
required

Name of the KOUCC group to filter by

Validations:

  • Must be a String

Returns

Code: 200

Description:

List of KOUCC group member records matching the specified group

Param name Description
data
required

Single KOUCC group member

Validations:

  • Must be a Hash
data[id]
required

ID of the KOUCC 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 KOUCC group member

Validations:

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

KOUCC group name

Validations:

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

KOUCC position name

Validations:

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

KOUCC group member name

Validations:

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

KOUCC group member personal phone

Validations:

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

KOUCC group member personal cell phone

Validations:

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

KOUCC group member work phone

Validations:

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

KOUCC 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