Skip to end of metadata
Go to start of metadata

Add

Add a new CoNsfDemographic.

Request Format

Method

POST

URL

/co_nsf_demographics.<format>

Request Body

CoNsfDemographic Request

Response Format

HTTP Status

Response Body

Description

201 Added

NewObjectResponse with ObjectType of CoNsfDemographic

CoNsfDemographic added

400 Bad Request

 

CoNsfDemographic Request not provided in POST body

400 Invalid Fields

ErrorResponse with details in InvalidFields element

An error in one or more provided fields

401 Unauthorized

 

Authentication required

403 CoPerson Does Not Exist

 

The specified CoPerson does not exist

403 CoNsfDemographic Data Already Exists

 

The specified CoPerson's CoNsfDemographic data has already been added

500 Other Error

 

Unknown error


Delete

Remove a CoNsfDemographic.

Request Format

Method

DELETE

URL

/co_nsf_demographics/<id>.<format>

Request Body

 

Response Format

HTTP Status

Response Body

Description

200 Deleted

 

CoNsfDemographic deleted

400 Invalid Fields

 

id not provided

401 Unauthorized

 

Authentication required

404 Identifier Unknown

 

id not found

500 Other Error

 

Unknown error


Edit

Edit an existing CoNsfDemographic.

Request Format

Method

PUT

URL

/co_nsf_demographics/<id>.<format>

Request Body

CoNsfDemographic Request

Response Format

HTTP Status

Response Body

Description

200 OK

 

CoNsfDemographic updated

400 Bad Request

 

CoNsfDemographic Request not provided in POST body

400 Invalid Fields

ErrorResponse with details in InvalidFields element

An error in one or more provided fields

401 Unauthorized

 

Authentication required

403 CoPerson Does Not Exist

 

The specified CoPerson does not exist

403 CoNsfDemographic Data Already Exists

 

The specified CoPerson id already has a CoNsfDemographic

404 Identifier Unknown

 

id not found

500 Other Error

 

Unknown error


View (all)

Retrieve all existing CoNsfDemographic.

Request Format

Method

GET

URL

/co_nsf_demographics.<format>

Request Body

 

Response Format

HTTP Status

Response Body

Description

200 OK

CoNsfDemographic Response

CoNsfDemographic returned

401 Unauthorized

 

Authentication required

500 Other Error

 

Unknown error


View (per CoGroup)

Retrieve CoNsfDemographic attached to a CoGroup.

Request Format

Method

GET

URL

/co_nsf_demographics.<format>?cogroupid=<id>

Request Body

 

Response Format

HTTP Status

Response Body

Description

200 OK

CoNsfDemographic Response

CoNsfDemographic returned

401 Unauthorized

 

Authentication required

404 CoGroup Unknown

 

id not found

500 Other Error

 

Unknown error


View (one)

Retrieve an existing CoNsfDemographic.

Request Format

Method

GET

URL

/co_nsf_demographics/<id>.<format>

Request Body

 

Response Format

HTTP Status

Response Body

Description

200 OK

CoNsfDemographic Response

CoNsfDemographic returned

401 Unauthorized

 

Authentication required

404 CoNsfDemographic Unknown

 

id not found

500 Other Error

 

Unknown error


Notes

  • Response format requested is ignored where response is only via HTTP status, but must still be provided.

See Also

  • No labels