MaritalStatus
A martial status represents a member's current status, e.g. married, single, etc.
Example Object
{
"type": "MaritalStatus",
"id": "1",
"attributes": {
"value": "string"
},
"relationships": {}
}
Attributes
| Name |
Type |
Description |
id |
primary_key |
|
value |
string |
|
Order By
| Parameter |
Value |
Type |
Description |
| order |
sequence |
string |
prefix with a hyphen (-sequence) to reverse the order |
| order |
value |
string |
prefix with a hyphen (-value) to reverse the order |
Query By
| Name |
Parameter |
Type |
Description |
Example |
| value |
where[value] |
string |
Query on a specific value |
?where[value]=string |
Pagination
| Name |
Parameter |
Type |
Description |
| per_page |
per_page |
integer |
how many records to return per page (min=1, max=100, default=25) |
| offset |
offset |
integer |
get results from given offset |
Endpoints
Listing
| HTTP Method |
Endpoint |
| GET |
/people/v2/marital_statuses |
Reading
| HTTP Method |
Endpoint |
| GET |
/people/v2/marital_statuses/{id} |
Creating
| HTTP Method |
Endpoint |
Assignable Attributes |
| POST |
/people/v2/marital_statuses |
|
Updating
| HTTP Method |
Endpoint |
Assignable Attributes |
| PATCH |
/people/v2/marital_statuses/{id} |
|
Deleting
| HTTP Method |
Endpoint |
| DELETE |
/people/v2/marital_statuses/{id} |
Belongs To
| HTTP Method |
Endpoint |
Association |
Details |
Filter By |
| GET |
https://api.planningcenteronline.com/people/v2/marital_statuses |
Organization
|
|
|
| GET |
https://api.planningcenteronline.com/people/v2/people/{person_id}/marital_status |
Person
|
|
|