Add

Add a new NavigationLink.

Request Format

Method

POST

URL

/navigation_links.<format>

Request Body

NavigationLink Request

Response Format

HTTP Status

Response Body

Description

201 Added

NewObjectResponse with ObjectType of NavigationLink

NavigationLink added

400 Bad Request

 

NavigationLink 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

500 Other Error

 

Unknown error

Delete

Remove a NavigationLink.

Request Format

Method

DELETE

URL

/navigation_links/<id>.<format>

Request Body

 

Response Format

HTTP Status

Response Body

Description

200 Deleted

 

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

Request Format

Method

PUT

URL

/navigation_links/<id>.<format>

Request Body

NavigationLink Request

Response Format

HTTP Status

Response Body

Description

200 OK

 

NavigationLink updated

400 Bad Request

 

NavigationLink 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

404 Identifier Unknown

 

id not found

500 Other Error

 

Unknown error

View (all)

Retrieve all existing NavigationLinks.

Request Format

Method

GET

URL

/navigation_links.<format>

Request Body

 

Response Format

HTTP Status

Response Body

Description

200 OK

NavigationLink Response

NavigationLink returned

401 Unauthorized

 

Authentication required

500 Other Error

 

Unknown error

View (one)

Retrieve an existing NavigationLink.

Request Format

Method

GET

URL

/navigation_links/<id>.<format>

Request Body

 

Response Format

HTTP Status

Response Body

Description

200 OK

NavigationLink Response

NavigationLink returned

401 Unauthorized

 

Authentication required

404 NavigationLink Unknown

 

id not found

500 Other Error

 

Unknown error

Notes

See Also