Not Implemented

This API is no longer planned for implementation. Please use the Core API instead. (Registry version >= v4.3.0)

Add

Add a new CO Petition.

Request Format

Method

POST

URL

/co_petitions.<format>

Request Body

CoPetition Request

Response Format

HTTP Status

Response Body

Description

201 Added

NewObjectResponse with ObjectType of CoPetitions

CoPetitions created

400 Bad Request


CoPetition 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 CO Does Not Exist


The specified CO does not exist

500 Other Error


Unknown error


Delete

Remove a CO Petition.

Request Format

Method

DELETE

URL

/co_petitions/<id>.<format>

Request Body


Response Format

HTTP Status

Response Body

Description

200 Deleted


CoPetition deleted

400 Invalid Fields


id not provided

401 Unauthorized


Authentication required

404 CoPetition Unknown


id not found

500 Other Error


Unknown error


Edit

Edit an existing CO Petition.

Request Format

Method

PUT

URL

/co_petitions/<id>.<format>

Request Body

CoPetition Request

Response Format

HTTP Status

Response Body

Description

200 OK


CoPetition updated

400 Bad Request


CoPetition Request not provided in PUT body

400 Invalid Fields

ErrorResponse with details in InvalidFields element

An error in one or more provided fields

401 Unauthorized


Authentication required

403 CO Does Not Exist


The specified CO does not exist

404 CoPetition Unknown


id not found

500 Other Error


Unknown error


View (all)

Retrieve all existing CO Petitions.

Request Format

Method

GET

URL

/co_petitions.<format>

Request Body


Response Format

HTTP Status

Response Body

Description

200 OK

CoPetition Response

CoPetition returned

401 Unauthorized


Authentication required

500 Other Error


Unknown error


View (per CO)

Retrieve all existing CO Petitions for the specified CO.

Request Format

Method

GET

URL

/co_petitions.<format>?coid=<id>

Request Body


Response Format

HTTP Status

Response Body

Description

200 OK

CoPetition Response

CoPetition returned

401 Unauthorized


Authentication required

404 CO Unknown


id not found

500 Other Error


Unknown error


View (one)

Retrieve an existing CO Petition.

Request Format

Method

GET

URL

/co_petitions/<id>.<format>

Request Body


Response Format

HTTP Status

Response Body

Description

200 OK

CoPetition Response

CoPetition returned

401 Unauthorized


Authentication required

404 CoPetition 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