Endpoint Status Codes

patch

https://app.financekey.com/OData/EndpointStatusCodes({key})

The EndpointStatusCode table in the Core package is a crucial component of a larger system designed for monitoring and tracking the status of various endpoints. This table stores information and data related to the various codes and statuses assigned to endpoints within the system. It includes columns such as endpoint name, status code, description, and timestamp for accurate tracking and reporting. The EndpointStatusCode table is essential for identifying and troubleshooting any issues with endpoints, providing valuable insights for optimizing the overall performance and functionality of the system. It serves as a key reference point for system administrators and technicians to quickly and effectively address any endpoint-related concerns, ensuring the smooth operation of the system.

Path Params

key

string

required

Body Params

endpointStatusCodeId

int32

The different response status codes for Endpoint Responses. Where possible, we follow the standards. 9xx messages are specific to FinanceKey

description

string | null

The Description field in the EndpointStatusCode table is a data type of nvarchar with a maximum length of 256 characters. This field is used to provide a brief description of the status code assigned to specific endpoints. It may include information such as the purpose of the endpoint, its functionality, or any important details about its status. This field serves as a useful reference for understanding the behavior and status of endpoints within the system. The maximum length of 256 characters ensures that the description is concise and easy to understand.

error

boolean

The Error field in the EndpointStatusCode table is a data type bit, which represents a boolean value of either true or false. This field is used to identify whether there is an error in the status code of the endpoint. If there is an error, the value will be set to true, and if there is no error, the value will be set to false. This field is crucial for tracking and troubleshooting potential issues within the endpoint, ensuring that data is being transmitted accurately and efficiently. Its inclusion in the EndpointStatusCode table allows for easy identification and resolution of any errors that may occur.

comment

string

required

length ≥ 1

Miscellaneous notes and information for the entry or record.

Response

200

Language

URL

Response

Click Try It! to start a request and see the response here!