returncode

README

returncode

Standardised Application Return Codes for enterprise software development

Documentation

Index

• Constants

Constants

const (
	// General Error
	ERR1000 int = iota + 1000
	// Header: Trace ID Missing
	ERR1001
	// Header: Partner ID Missing
	ERR1002
	// Header: System ID Missing
	ERR1003
	// Header: User ID Missing
	ERR1004
	// Payload: Binding/Processing Failure
	ERR1005
)

Bad Request

const (
	// General Request Security Security Error
	ERR1100 int = iota + 1100
	// Signature Missing
	ERR1101
	// Signature Not Matched
	ERR1102
	// Requesting Username Security Error
	ERR1103
	// Signing Key Fetching Error
	ERR1104
	// CRC Check Error
	ERR1105
)

Security Error

const (
	// General Input Validation Error
	ERR1200 int = iota + 1200
	// Invalid input format
	ERR1201
	// Input validation error
	ERR1202
	// Missing input
	ERR1203
	// Input not allowed
	ERR1204
	// Input duplicates
	ERR1205
)

Input Validation Error

const (
	// General Response Error
	ERR1300 int = iota + 1300
	// Record not found
	ERR1301
	// Record already exists
	ERR1302
	// Record out of range
	ERR1303
	// Record incomplete
	ERR1304
)

Response Error

const (
	// General server error
	ERR2000 int = iota + 2000
	// General Data Processing Error
	ERR2001
)

Internal Server Error

const (
	// HTTP Server Error
	ERR2100 int = iota + 2100
	// Server Connectivity Error
	ERR2101
)

Internal Server Error: Web Server Engine

const (
	// MQ Server Error
	ERR2200 int = iota + 2200
	// MQ Connectivity Error
	ERR2201
)

Internal Server Error: MQ Server Engine

const (
	// Repository client (PostgreSQL) error
	ERR3000 int = iota + 3000
	// DB operation error
	ERR3001
)

Internal Server Error: DB

const (
	// Repository client (MySQL) error
	ERR3100 int = iota + 3100
	// DB operation error
	ERR3101
)

const (
	// General partner service operation Error
	ERR4000 int = iota + 4000
	// API invalid credential
	ERR4001
	// API call timeout
	ERR4002
	// API call failure
	ERR4003
	// API call response payload processing error
	ERR4004
	// API call response payload signature verification error
	ERR4005
	// API call method not allowed
	ERR4006
	// API call response resource not found
	ERR4007
	// API call request requirement not met
	ERR4008
	// API call failed with empty response
	ERR4009
)

Provider Service Error

const (
	// success OK
	OK0000 int = iota
	// OK, but with warning
	OK0001
)

Generic OK Status