Technical documentation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
===== bop_error.json conf =====

While processing BOP service orders, NetYCE sends status and error codes back to BOP, depending on its process. In the configuration file /opt/yce/etc/bop_error.json these error codes can be modified. It consists out of a key, followed by the http code that it should return, and the bop code. In the table below, you can find the keys for the messages that you are able to send, along with their default values:

|Key|Http code|Bop code|Explanation|
|notify_no_module|500|0101|If the NetYCE TMF module cannot be loading while sending a notification|
|notify_bad_request|400|0102|If the request to send a notification cannot be read|
|create_no_module|500|1002|If the NetYCE TMF module cannot be loading while creating a service order|
|create_bad_request|400|1002|If the request to create a service order cannot be read|
|create_decode_error|500|1003|If the body of a request to  contains invalid JSON|
|create_conflict|409|1100|If the request to create a service order contains a service order id that already exists|
|create_failed|400|1100|If the request to create a service order failed|
|create_missing|200|1200|If the service order create request has succeeded, but the service order is missing afterwards|
|list_no_module|500|2001|If the NetYCE TMF module cannot be loading while retrieving all service orders|
|get_no_module|500|3001|If the NetYCE TMF module cannot be loading while retrieving a service order|
|get_no_id|400|3002|If the request to retrieve a service order doesn't contain a service order id|
|renew_no_module|500|4001|If the NetYCE TMF module cannot be loading while renewing a service order|
|renew_no_id|400|4002|If the request to renew a service order doesn't contain a service order id|
|renew_bad_request|400|4003|If the request to renew a service order cannot be read|
|renew_decode_error|400|4004|If the body of a request to create a service order contains invalid JSON|
|renew_not_found|400|4100|If the id of the service order to renew is not found|
|renew_wrong_state|409|4100|If the state of a service order to renew is not 'acknowledged' or 'rejected'|
|renew_conflict|409|4100|If the service order to renew also has received other actions that conflict with it ('add' or 'delete')|
|renew_failed|400|4100|If the request to renew a service order failed|
|renew_missing|201|4200|If the request to renew a service order has succeeded, but the service order is missing afterwards|
|update_no_module|500|5001|If the NetYCE TMF module cannot be loading while updating a service order|
|update_no_id|400|5002|If the request to update a service order doesn't contain a service order id|
|update_bad_request|400|5003|If the request to update a service order cannot be read|
|update_decode_error|400|5004|If the body of a request to update a service order contains invalid JSON|
|update_not_found|400|5100|If the service order with the id to update could not be found|
|update_wrong_state|409|5100|If the state of the service order to update is not 'acknowledged' or 'rejected'|
|update_failed|400|5100|If the request to update a service order failed|
|update_missing|201|5200|If the request to update a service order succeeded, but the service order is missing afterwards|
|drop_no_module|500|6001|If the NetYCE TMF module cannot be loading while dropping a service order|
|drop_no_id|400|6002|If the request to drop a service order doesn't contain a service order id|
|drop_not_found|400|6100|If the id of the service order to drop could not be found|
|drop_wrong_state|409|6100|If the state of the service order to drop is not 'acknowledged' or 'rejected'|
|cancel_no_module|500|7001|If the NetYCE TMF module cannot be loading while cancelling a service order|
|cancel_bad_request|400|7002|If the request to cancel a service order cannot be read|
|cancel_decode_error|400|7003|If the body of a request to cancel a service order contains invalid JSON|
|submit_no_id|400|7100|If the request to submit a service order doesn't contain a service order id|
|submit_not_found|404|7100|If the id of the service order to be submitted could not be found|
|submit_wrong_state|409|7100|If the state of the service order to submit is not 'acknowledged' or 'rejected'|
|notify_create_no_module|500|8001|If the NetYCE TMF module cannot be loading while creating a notification|
|notify_list_no_module|500|8001|If the NetYCE TMF module cannot be loading while retrieving all notifications|
|notify_create_bad_request|400|8002|If the request to create a notification cannot be read|
|notify_no_callback|400|8100|If the notification registry does not contain a 'callback'|
|notify_bad_callback|400|8100|If the 'callback' for the notification registry is wrong|
|notify_drop_no_module|500|8001|If the NetYCE TMF module cannot be loading while deleting a notification|
|notify_drop_no_id|400|8001|If the id of the notification to drop is not present|
|notify_unregister_no_id|400|9100|If the id of the notification to unregister is not present|
|update_order_state_not_found|400|9500|If the id of the service order whose state needs to be updated is not present|
|update_order_state_wrong_state|409|9500|If the state of the service order whose state needs to be updated is 'deleted' or 'rejected'|
|update_order_state_wrong_attribute|400|9500|If the request to update the service order state contains a wrong attribute|
|update_item_state_not_found|400|9500|If the id of the service order item whose state needs to be updated is not present|
|update_item_state_wrong_state|409|9500|If the state of the service order item whose state needs to be updated is 'deleted' or 'rejected'|
|update_item_state_wrong_attribute|400|9500|If the request to update the service order item state contains a wrong attribute|
|update_order_no_module|500|9501|If the NetYCE TMF module cannot be loading while updating a service order state|
|update_item_no_module|500|9501|If the NetYCE TMF module cannot be loading while updating a service order item state|
|update_order_no_id|400|9502|If the request to update a service order state doesn't contain a service order id|
|update_item_no_id|400|9502|If the request to service order item state doesn't contain a service order id or item id|
|update_order_bad_request|400|9503|If the request to update a service order state cannot be read|
|update_item_bad_request|400|9503|If the request to update a service order item state cannot be read|
|update_order_decode_error|400|9504|If the body of a request to update a service order state contains invalid JSON|
|update_item_decode_error|400|9504|If the body of a request to service order item state contains invalid JSON|