Add
Add a new CoNsfDemographic.
Request Format
Method | |
---|---|
URL | |
Request Body |
Response Format
HTTP Status | Response Body | Description |
---|---|---|
| NewObjectResponse with | CoNsfDemographic added |
|
| CoNsfDemographic Request not provided in POST body |
| ErrorResponse with details in | An error in one or more provided fields |
|
| Authentication required |
|
| The specified CoPerson does not exist |
|
| The specified CoPerson's CoNsfDemographic data has already been added |
|
| Unknown error |
Delete
Remove a CoNsfDemographic.
Request Format
Method | |
---|---|
URL | |
Request Body |
|
Response Format
HTTP Status | Response Body | Description |
---|---|---|
|
| CoNsfDemographic deleted |
|
| |
|
| Authentication required |
|
| |
|
| Unknown error |
Edit
Edit an existing CoNsfDemographic.
Request Format
Method | |
---|---|
URL | |
Request Body |
Response Format
HTTP Status | Response Body | Description |
---|---|---|
|
| CoNsfDemographic updated |
|
| CoNsfDemographic Request not provided in POST body |
| ErrorResponse with details in | An error in one or more provided fields |
|
| Authentication required |
|
| The specified CoPerson does not exist |
|
| The specified CoPerson id already has a CoNsfDemographic |
|
| |
|
| Unknown error |
View (all)
Retrieve all existing CoNsfDemographic.
Request Format
Method | |
---|---|
URL | |
Request Body |
|
Response Format
HTTP Status | Response Body | Description |
---|---|---|
| CoNsfDemographic returned | |
|
| Authentication required |
|
| Unknown error |
View (per CoGroup)
Retrieve CoNsfDemographic attached to a CoGroup.
Request Format
Method | |
---|---|
URL | |
Request Body |
|
Response Format
HTTP Status | Response Body | Description |
---|---|---|
| CoNsfDemographic returned | |
|
| Authentication required |
|
| |
|
| Unknown error |
View (one)
Retrieve an existing CoNsfDemographic.
Request Format
Method | |
---|---|
URL | |
Request Body |
|
Response Format
HTTP Status | Response Body | Description |
---|---|---|
| CoNsfDemographic returned | |
|
| Authentication required |
|
| |
|
| Unknown error |
Notes
- Response format requested is ignored where response is only via HTTP status, but must still be provided.
See Also
- cm_co_nsf_demographics data model definition
- CoNsfDemographics API