Add

Add a new CoNavigationLink.

Request Format

Method

POST

URL

/co_navigation_links.<format>

Request Body

CoNavigationLink Request

Response Format

HTTP Status

Response Body

Description

201 Added

NewObjectResponse with ObjectType of CoNavigationLink

CoNavigationLink added

400 Bad Request

 

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

Request Format

Method

DELETE

URL

/co_navigation_links/<id>.<format>

Request Body

 

Response Format

HTTP Status

Response Body

Description

200 Deleted

 

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

Request Format

Method

PUT

URL

/co_navigation_links/<id>.<format>

Request Body

CoNavigationLink Request

Response Format

HTTP Status

Response Body

Description

200 OK

 

CoNavigationLink updated

400 Bad Request

 

CoNavigationLink 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

404 Identifier Unknown

 

id not found

500 Other Error

 

Unknown error

View (all)

Retrieve all existing CoNavigationLinks.

Request Format

Method

GET

URL

/co_navigation_links.<format>

Request Body

 

Response Format

HTTP Status

Response Body

Description

200 OK

CoNavigationLink Response

CoNavigationLink returned

401 Unauthorized

 

Authentication required

500 Other Error

 

Unknown error

View (per CO)

Retrieve CoNavigationLink attached to a CO.

Request Format

Method

GET

URL

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

Request Body

 

Response Format

HTTP Status

Response Body

Description

200 OK

CoNavigationLink Response

CoNavigationLink returned

401 Unauthorized

 

Authentication required

404 CO Unknown

 

id not found

500 Other Error

 

Unknown error

View (one)

Retrieve an existing CoNavigationLink.

Request Format

Method

GET

URL

/co_navigation_links/<id>.<format>

Request Body

 

Response Format

HTTP Status

Response Body

Description

200 OK

CoNavigationLink Response

CoNavigationLink returned

401 Unauthorized

 

Authentication required

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