| GET /api/v2/doc/ministers |
| Header name | Description |
|---|---|
|
Cookie required |
Login session cookie |
|
Provision required |
Web/Mobile/API Provision UUID |
List of ministers
| Param name | Description |
|---|---|
|
id required |
ID Validations:
|
|
last_name required |
Last name Validations:
|
|
first_name required |
First name Validations:
|
|
middle_name required |
Middle name Validations:
|
|
title required |
Title Validations:
|
|
suffix_name required |
Suffix Validations:
|
|
greeting required |
Greeting Validations:
|
|
order_of_ministry_id required |
Order of Ministry ID Validations:
|
|
order_of_ministry_desc required |
Order of Ministry description Validations:
|
|
professional_code_id required |
Professional Code ID Validations:
|
|
professional_code_desc required |
Professional Code description Validations:
|
|
region_id required |
Region ID Validations:
|
|
region_desc required |
Region description Validations:
|
|
address1 required |
Address line 1 Validations:
|
|
address2 required |
Address line 2 Validations:
|
|
address3 required |
Address line 3 Validations:
|
|
city required |
City Validations:
|
|
state required |
State Validations:
|
|
zip required |
ZIP/Postal Code Validations:
|
|
country required |
Country Code Validations:
|
|
has_standing required |
Minister has standing Validations:
|
|
phones required |
Minister Phone numbers Validations:
|
|
phones[phones] optional |
List of Phone numbers Validations:
|
|
phones[phones][type] optional |
Phone number type Validations:
|
|
phones[phones][phone] optional |
Phone number Validations:
|
|
emails required |
Minister Emails Validations:
|
|
emails[emails] optional |
List of Email addresses Validations:
|
|
emails[emails][type] optional |
Email address type Validations:
|
|
emails[emails][email] optional |
Email address Validations:
|
|
positions required |
Minister Positions Validations:
|
|
positions[positions] optional |
List of Positions Validations:
|
|
positions[positions][position] optional |
Position description Validations:
|
|
positions[positions][pin] optional |
Position PIN Validations:
|
|
positions[positions][historical] optional |
Historical Position status Validations:
|
|
positions[positions][begin_date] optional |
Position begin date Validations:
|
|
positions[positions][end_date] optional |
Position end date Validations:
|
|
ethnic_codes required |
Minister Ethnic Codes Validations:
|
|
ethnic_codes[ethnic_codes] optional |
List of Ethnic Codes Validations:
|
|
ethnic_codes[ethnic_codes][id] optional |
Ethnic Code ID Validations:
|
|
ethnic_codes[ethnic_codes][description] optional |
Ethnic Code description 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) |
| 422 | Provision header missing |
| 422 | Invalid provision |
| 422 | Under maintenance |
| 422 | Incorrect host for provision |
| 422 | Establishing session failed |
| 422 | Privilege to perform the action was not found |
| 422 | Not logged in |
| 422 | Provision does not match logged in provision |
| 422 | Invalid custom version |
| 500 | No connection to data source |
GET /api/v2/doc/ministers
422
{
"errors": [
{
"error": "You do not have permission to perform this action.",
"status": 422
}
]
}
GET /api/v2/doc/ministers
200
[
{
"id": "2826",
"last_name": "Styles",
"first_name": "Allen",
"middle_name": "James",
"title": "Champion",
"suffix_name": "Jr.",
"greeting": "Hello AJ!",
"order_of_ministry_id": "361",
"order_of_ministry_desc": "Current Status",
"professional_code_id": "128",
"professional_code_desc": "Prospective",
"region_id": "0",
"region_desc": "",
"address1": "Test",
"address2": "Address 2",
"address3": "",
"city": "Versailles",
"state": "KY",
"zip": "40383",
"country": "US",
"has_standing": true,
"phones": {
"phones": [
{
"type": "Mobile phone",
"phone": "0123456789"
},
{
"type": "Mobile phone",
"phone": "9876543210"
}
]
},
"emails": {
"emails": [
{
"type": "E-mail address",
"email": "aj@test.com"
},
{
"type": "E-mail address",
"email": "secondaj@gmail.com"
}
]
},
"positions": null,
"ethnic_codes": {
"ethnic_codes": []
}
}
]