| Koucc churches |
| GET /api/v3/ucc/koucc_churches |
| Param name | Description |
|---|---|
|
page optional |
Pagination setting Validations:
|
|
page[size] optional |
Page size Validations:
|
|
page[number] optional |
Page number Validations:
|
|
sort optional |
Sorting setting Validations:
|
|
sort[key] optional |
Sort by Validations:
|
|
sort[direction] optional |
Sort direction Validations:
|
|
sort[special_clause] optional |
Special Clause Validations:
|
|
linkedTo optional |
Sorting setting Validations:
|
|
linkedTo[fk] optional |
Sort by Validations:
|
|
linkedTo[fk_table] optional |
Sort direction Validations:
|
|
filter_value optional |
Filter string value Validations:
|
|
searches optional |
Hash of search queries Validations:
|
|
exclusions optional |
Hash of exclude queries Validations:
|
|
principle_resource optional |
Parent resource Validations:
|
|
principle_resource[name] optional |
Name of resource Validations:
|
|
principle_resource[identifier] optional |
ID value Validations:
|
|
related_resource optional |
Related resource Validations:
|
|
related_resource[name] optional |
Name of resource Validations:
|
|
related_resource[column] optional |
resouce column Validations:
|
|
related_resource[value] optional |
resource value Validations:
|
Unauthorized
| Param name | Description |
|---|---|
|
errors required |
Errors returned by request Validations:
|
|
errors[error] required |
Why the request failed Validations:
|
|
errors[status] required |
HTTP response code Validations:
|
Not Found
| Param name | Description |
|---|---|
|
errors required |
Errors returned by request Validations:
|
|
errors[error] required |
Why the request failed Validations:
|
|
errors[status] required |
HTTP response code Validations:
|
Unprocessable Entity
| Param name | Description |
|---|---|
|
errors required |
Errors returned by request Validations:
|
|
errors[error] required |
Why the request failed Validations:
|
|
errors[status] required |
HTTP response code Validations:
|
Internal Server Error
| Param name | Description |
|---|---|
|
errors required |
Errors returned by request Validations:
|
|
errors[error] required |
Why the request failed Validations:
|
|
errors[status] required |
HTTP response code Validations:
|
| Code | Description |
|---|---|
| 404 | Data source query failed |
| 422 | Invalid parameter(s) |
| 500 | No connection to data source |
| GET /api/v3/ucc/koucc_churches/:id |
| Param name | Description |
|---|---|
|
id required |
ID for KOUCC church Validations:
|
Specified KOUCC church record
| Param name | Description |
|---|---|
|
data required |
Single KOUCC church Validations:
|
|
data[id] required |
ID of the KOUCC church Validations:
|
|
data[type] required |
Type of the resources Validations:
|
|
data[attributes] required |
Attributes of the KOUCC church Validations:
|
|
data[attributes][name] required |
KOUCC church name Validations:
|
|
data[attributes][church_id] required |
KOUCC church id Validations:
|
|
data[attributes][address1] required |
KOUCC church address 1 Validations:
|
|
data[attributes][address2] required |
KOUCC church address 2 Validations:
|
|
data[attributes][address3] required |
KOUCC church address 3 Validations:
|
|
data[attributes][city] required |
KOUCC church city Validations:
|
|
data[attributes][state] required |
KOUCC church state Validations:
|
|
data[attributes][zip] required |
KOUCC church zip Validations:
|
|
data[attributes][phone_number] required |
KOUCC church phone number Validations:
|
|
data[attributes][email_address] required |
KOUCC church email address Validations:
|
|
data[attributes][website] required |
KOUCC church website Validations:
|
|
data[attributes][pastor_name] required |
KOUCC church pastor name Validations:
|
|
data[attributes][state] required |
KOUCC church state Validations:
|
|
data[attributes][sortorder] optional |
Order of rendering Validations:
|
Unauthorized
| Param name | Description |
|---|---|
|
errors required |
Errors returned by request Validations:
|
|
errors[error] required |
Why the request failed Validations:
|
|
errors[status] required |
HTTP response code Validations:
|
Not Found
| Param name | Description |
|---|---|
|
errors required |
Errors returned by request Validations:
|
|
errors[error] required |
Why the request failed Validations:
|
|
errors[status] required |
HTTP response code Validations:
|
Unprocessable Entity
| Param name | Description |
|---|---|
|
errors required |
Errors returned by request Validations:
|
|
errors[error] required |
Why the request failed Validations:
|
|
errors[status] required |
HTTP response code Validations:
|
Internal Server Error
| Param name | Description |
|---|---|
|
errors required |
Errors returned by request Validations:
|
|
errors[error] required |
Why the request failed Validations:
|
|
errors[status] required |
HTTP response code Validations:
|
| Code | Description |
|---|---|
| 404 | Data source query failed |
| 422 | Invalid parameter(s) |
| 500 | No connection to data source |