Add
Add a new CO Petition.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
Response Format
HTTP Status |
Response Body |
Description |
|---|---|---|
|
NewObjectResponse with |
CoPetitions created |
|
|
CoPetition Request not provided in POST body |
|
ErrorResponse with details in |
An error in one or more provided fields |
|
|
Authentication required |
|
|
The specified CO does not exist |
|
|
Unknown error |
Delete
Remove a CO Petition.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
|
Response Format
HTTP Status |
Response Body |
Description |
|---|---|---|
|
|
CoPetition deleted |
|
|
|
|
|
Authentication required |
|
|
|
|
|
Unknown error |
Edit
Edit an existing CO Petition.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
Response Format
HTTP Status |
Response Body |
Description |
|---|---|---|
|
|
CoPetition updated |
|
|
CoPetition Request not provided in PUT body |
|
ErrorResponse with details in |
An error in one or more provided fields |
|
|
Authentication required |
|
|
The specified CO does not exist |
|
|
|
|
|
Unknown error |
View (all)
Retrieve all existing CO Petitions.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
|
Response Format
HTTP Status |
Response Body |
Description |
|---|---|---|
|
CoPetition returned |
|
|
|
Authentication required |
|
|
Unknown error |
View (per CO)
Retrieve all existing CO Petitions for the specified CO.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
|
Response Format
HTTP Status |
Response Body |
Description |
|---|---|---|
|
CoPetition returned |
|
|
|
Authentication required |
|
|
|
|
|
Unknown error |
View (one)
Retrieve an existing CO Petition.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
|
Response Format
HTTP Status |
Response Body |
Description |
|---|---|---|
|
CoPetition returned |
|
|
|
Authentication required |
|
|
|
|
|
Unknown error |
Notes
- Response format requested is ignored where response is only via HTTP status, but must still be provided.