Note that unlike other models that follow standard CakePHP singular/plural conventions, CoTermsAndConditions is both the singular and plural.
Support for this API was added in v1.1.0.
Add
Add a new CO Terms and Conditions record.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| NewObjectResponse with | CoTermsAndConditions created |
|
| CoTermsAndConditions 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 Terms and Conditions record.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
|
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
|
| CoTermsAndConditions deleted |
|
|
|
|
| Authentication required |
|
|
|
|
| Unknown error |
Edit
Edit an existing CO Terms and Conditions record.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
|
| CoTermsAndConditions updated |
|
| CoTermsAndConditions Request not provided in POST body |
| ErrorResponse with details in | An error in one or more provided fields |
|
| Authentication required |
|
|
|
|
| Unknown error |
View (all)
Retrieve all existing CO Terms and Conditions.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
|
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| CoTermsAndConditions returned | |
|
| Authentication required |
|
| Unknown error |
View (per CO)
Retrieve all existing CO Terms and Conditions records for a specific CO.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
|
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| CoTermsAndConditions returned | |
|
| Authentication required |
|
| id Not Found |
|
| Unknown error |
View (one)
Retrieve an existing CO Terms and Conditions record.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
|
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| CoTermsAndConditions 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
- CoTAndCAgreement API
- cm_co_t_and_c_agreements data model definition
- cm_co_terms_and_conditions data model definition