You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Next »

Add

Add a new CoGroup.

Request Format

Method

POST

URL

/co_groups.<format>

Request Body

CoGroup Request

Response Format

HTTP Status

Response Body

Description

201 Added

NewObjectResponse with ObjectType of CoGroup

CoGroup added

400 Bad Request

 

CoGroup 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

403 Name In Use

 

A group already exists with the specified name in the specified CO

403 Name Reserved

 

A group may not be created with the specified name (currently, the prefix 'admin:' is reserved)*

500 Other Error

 

Unknown error

*This applies only to non-admin users. However, all API operations are currently admin-level.

Delete

Remove a CoGroup.

Request Format

Method

DELETE

URL

/co_groups/<id>.<format>

Request Body

 

Response Format

HTTP Status

Response Body

Description

200 Deleted

 

CoGroup 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 CoGroup.

Request Format

Method

PUT

URL

/co_groups/<id>.<format>

Request Body

CoGroup Request

Response Format

HTTP Status

Response Body

Description

200 OK

 

CoGroup updated

400 Bad Request

 

CoGroup 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

403 Name In Use

 

A group already exists with the specified name in the specified CO

403 Name Reserved

 

A group may not be created with the specified name (currently, the prefix 'admin:' is reserved)*

404 Identifier Unknown

 

id not found

500 Other Error

 

Unknown error

*This applies only to non-admin users. However, all API operations are currently admin-level.

View (all)

Retrieve all existing CoGroups.

Request Format

Method

GET

URL

/co_groups.<format>

Request Body

 

Response Format

HTTP Status

Response Body

Description

200 OK

CoGroup Response

CoGroup returned

401 Unauthorized

 

Authentication required

500 Other Error

 

Unknown error

View (per CO)

Retrieve CoGroups attached to a CO.

Request Format

Method

GET

URL

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

Request Body

 

Response Format

HTTP Status

Response Body

Description

200 OK

CoGroup Response

CoGroup returned

401 Unauthorized

 

Authentication required

404 CO Unknown

 

id not found

500 Other Error

 

Unknown error

View (per CO Person)

Retrieve Groups attached to a CO Person.

Request Format

Method

GET

URL

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

Request Body

 

Response Format

HTTP Status

Response Body

Description

200 OK

CoGroup Response

CoGroups returned

204 CO Person Role Has No Groups

 

The requested CO Person was found, but has no groups attached

401 Unauthorized

 

Authentication required

404 CO Person Unknown

 

id not found for CO Person

500 Other Error

 

Unknown error

View (one)

Retrieve an existing CoGroup.

Request Format

Method

GET

URL

/co_groups/<id>.<format>

Request Body

 

Response Format

HTTP Status

Response Body

Description

200 OK

CoGroup Response

CoGroup returned

401 Unauthorized

 

Authentication required

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