Support for this API was added in v1.1.0.

Add

Record a new CO Terms and Conditions Agreement.

Request Format

Method

POST

URL

/co_t_and_c_agreements.<format>

Request Body

CoTAndCAgreement Request

Response Format

HTTP Status

Response Body

Description

201 Added

NewObjectResponse with ObjectType of CoTAndCAgreement

CoTAndCAgreement created

400 Bad Request

 

CoTAndCAgreement 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

View (all)

Retrieve all existing CO Terms and Conditions Agreements.

Request Format

Method

GET

URL

/co_t_and_c_agreements.<format>

Request Body

 

Response Format

HTTP Status

Response Body

Description

200 OK

CoTAndCAgreement Response

CoTAndCAgreement returned

401 Unauthorized

 

Authentication required

500 Other Error

 

Unknown error

View (per CO)

Retrieve all existing CO Terms and Conditions Agreement records for a specific CO.

Request Format

Method

GET

URL

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

Request Body

 

Response Format

HTTP Status

Response Body

Description

200 OK

CoTAndCAgreement Response 

CoTAndCAgreement returned

401 Unauthorized

 

Authentication required

404 CO Unknown

 

id Not Found

500 Other Error

 

Unknown error

View (per CO Person)

Retrieve all existing CO Terms and Conditions Agreement records for a specific CO Person.

Request Format

Method

GET

URL

/co_t_and_c_agreements.<format>?copersonid=<id>

Request Body

 

Response Format

HTTP Status

Response Body

Description

200 OK

CoTAndCAgreement Response 

CoTAndCAgreement returned

401 Unauthorized

 

Authentication required

404 CO Person Unknown

 

id Not Found

500 Other Error

 

Unknown error

 

View (one)

Retrieve an existing CO Terms and Conditions Agreements record.

Request Format

Method

GET

URL

/co_t_and_c_agreements/<id>.<format>

Request Body

 

Response Format

HTTP Status

Response Body

Description

200 OK

CoTAndCAgreement Response 

CoTAndCAgreement returned

401 Unauthorized

 

Authentication required

404 CoTAndCAgreement 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.
  • The Agreement will be recorded as executed by the authenticated REST user on behalf of the specified CO Person.
  • Once created, an Agreement can not be edited or deleted.

See Also

  • No labels