Response:getResponseCode()

Get the HTTP status code from the response.

Signature

getResponseCode(): number

Returns

number - The HTTP status code (e.g., 200, 404, 500)

Description

The getResponseCode() method returns the HTTP status code from the server response. Status codes indicate whether the HTTP request was successful, failed, or requires further action.

Examples

Basic Status Code Checking

-- Make a request and check the status code
local response = Request("https://api.example.com/users"):get()
local statusCode = response:getResponseCode()

if statusCode == 200 then
    print("Request successful!")
    local data = response:getData()
    print("Response data: " .. data)
else
    print("Request failed with status: " .. statusCode)
end

Comprehensive Status Code Handling

local response = Request("https://api.example.com/data"):get()
local status = response:getResponseCode()

if status >= 200 and status < 300 then
    -- Success responses (2xx)
    print("Request successful (2xx)")
    local data = response:getData()
    print("Data: " .. data)

elseif status >= 300 and status < 400 then
    -- Redirection responses (3xx)
    print("Redirection received (3xx)")
    print("Status: " .. status)

elseif status >= 400 and status < 500 then
    -- Client error responses (4xx)
    print("Client error (4xx)")
    local errorData = response:getData()
    if errorData and errorData ~= "" then
        print("Error details: " .. errorData)
    end

elseif status >= 500 and status < 600 then
    -- Server error responses (5xx)
    print("Server error (5xx)")
    local errorData = response:getData()
    if errorData and errorData ~= "" then
        print("Server error details: " .. errorData)
    end

else
    print("Unexpected status code: " .. status)
end

Specific Status Code Handling

local response = Request("https://api.example.com/users/123"):get()
local status = response:getResponseCode()

if status == 200 then
    print("OK - Request successful")
    local userData = response:getData()
    print("User data: " .. userData)

elseif status == 201 then
    print("Created - Resource created successfully")
    local newResource = response:getData()
    print("New resource: " .. newResource)

elseif status == 204 then
    print("No Content - Request successful, no response body")

elseif status == 400 then
    print("Bad Request - Invalid request data")
    local errorInfo = response:getData()
    print("Error: " .. errorInfo)

elseif status == 401 then
    print("Unauthorized - Authentication required")

elseif status == 403 then
    print("Forbidden - Access denied")

elseif status == 404 then
    print("Not Found - Resource does not exist")

elseif status == 500 then
    print("Internal Server Error")
    local serverError = response:getData()
    print("Server error details: " .. serverError)

else
    print("Other status: " .. status)
    local otherData = response:getData()
    if otherData and otherData ~= "" then
        print("Response: " .. otherData)
    end
end

HTTP Method-Specific Status Codes

-- GET request
local getResponse = Request("https://api.example.com/data"):get()
local getStatus = getResponse:getResponseCode()

if getStatus == 200 then
    print("Data retrieved successfully")
elseif getStatus == 404 then
    print("Data not found")
end

-- POST request
local postResponse = Request("https://api.example.com/users")
    :setParameter("name", "John")
    :setParameter("email", "john@example.com")
    :post()

local postStatus = postResponse:getResponseCode()

if postStatus == 201 then
    print("User created successfully")
    local newUser = postResponse:getData()
    print("Created user: " .. newUser)
elseif postStatus == 400 then
    print("Invalid user data")
elseif postStatus == 409 then
    print("User already exists")
end

-- DELETE request
local deleteResponse = Request("https://api.example.com/users/123"):delete()
local deleteStatus = deleteResponse:getResponseCode()

if deleteStatus == 204 then
    print("User deleted successfully")
elseif deleteStatus == 404 then
    print("User not found")
end

Status Code Helper Function

function handleResponse(response)
    local status = response:getResponseCode()
    local data = response:getData()

    -- Success (2xx)
    if status >= 200 and status < 300 then
        print("✓ Request successful (" .. status .. ")")
        if data and data ~= "" then
            return data
        else
            return "Success (no content)"
        end
    end

    -- Client errors (4xx)
    if status >= 400 and status < 500 then
        print("✗ Client error (" .. status .. ")")
        if data and data ~= "" then
            print("Error details: " .. data)
        end
        return nil
    end

    -- Server errors (5xx)
    if status >= 500 and status < 600 then
        print("✗ Server error (" .. status .. ")")
        if data and data ~= "" then
            print("Server error: " .. data)
        end
        return nil
    end

    print("? Unexpected status: " .. status)
    return nil
end

-- Usage
local response = Request("https://api.example.com/data"):get()
local result = handleResponse(response)

if result then
    print("Operation successful: " .. result)
else
    print("Operation failed")
end

API Retry Logic

function makeRequestWithRetry(url, maxRetries)
    local retries = 0

    while retries < maxRetries do
        local response = Request(url):get()
        local status = response:getResponseCode()

        -- Success
        if status == 200 then
            return response:getData()
        end

        -- Don't retry on client errors (4xx)
        if status >= 400 and status < 500 then
            print("Client error (" .. status .. "), not retrying")
            return nil
        end

        -- Retry on server errors (5xx)
        if status >= 500 and status < 600 then
            retries = retries + 1
            print("Server error (" .. status .. "), retrying... (" .. retries .. "/" .. maxRetries .. ")")
            -- Wait before retrying (you might want to add a delay here)
        else
            retries = retries + 1
            print("Unexpected status (" .. status .. "), retrying... (" .. retries .. "/" .. maxRetries .. ")")
        end
    end

    print("Max retries reached, giving up")
    return nil
end

local data = makeRequestWithRetry("https://api.example.com/unstable", 3)
if data then
    print("Request succeeded: " .. data)
end

Common HTTP Status Codes

Code	Category	Meaning	Typical Usage
200	Success	OK	Request successful
201	Success	Created	Resource created
204	Success	No Content	Success, no response body
400	Client Error	Bad Request	Invalid request data
401	Client Error	Unauthorized	Authentication required
403	Client Error	Forbidden	Access denied
404	Client Error	Not Found	Resource doesn't exist
409	Client Error	Conflict	Resource conflict
500	Server Error	Internal Server Error	Server-side error
502	Server Error	Bad Gateway	Invalid upstream response
503	Server Error	Service Unavailable	Server temporarily unavailable

Notes

Always check the status code before processing response data
Status codes are standardized across HTTP/1.1 and HTTP/2
2xx codes indicate success, 3xx indicate redirection, 4xx indicate client errors, 5xx indicate server errors
Some APIs may use custom status codes or non-standard meanings
Error responses (4xx, 5xx) may contain useful information in the response body
Network errors or timeouts may prevent a response object from being created entirely

Signature​

Description​

Examples​

Basic Status Code Checking​

Comprehensive Status Code Handling​

Specific Status Code Handling​

HTTP Method-Specific Status Codes​

Status Code Helper Function​

API Retry Logic​

Common HTTP Status Codes​

Notes​