node package manager
Don’t reinvent the wheel. Reuse code within your team. Create a free org »


Standard API Response

Build Status

This is a generic API response object for consistent API output across services. it is mostly meant for internal InterNACHI use, but anyone is welcome to use it.

Basic Usage'/users', function(req, res) {
    // Handle provided data and build new user object 
    // ... 
    // Create API response object 
    var apires = new OkResponse(user,, 'User successfully created.');
    // Send to client 

Response Format

HTTP/1.1 201 OK
Content-Type: application/json
    "ok": true,
    "message": "User successfully created.",
    "data": { ... },
    "httpCode": 201, // Same as HTTP response code
    "error": { ... } // Only present if "ok" == false