Struct VtigerResponse

pub struct VtigerResponse {
    pub success: bool,
    pub result: Option<IndexMap<String, Value>>,
    pub error: Option<ApiError>,
}

Response wrapper for all Vtiger REST API calls.

This struct represents the standard response format returned by the Vtiger API. All API responses follow this structure, containing a success flag, optional result data, and optional error information.

Fields

• success - Indicates whether the API call was successful
• result - Contains the response data when the call succeeds
• error - Contains error details when the call fails

Examples

use vtiger_client::{ApiError, VtigerResponse};
use indexmap::IndexMap;

// Successful response
let success_response = VtigerResponse {
    success: true,
    result: Some(IndexMap::new()),
    error: None,
};

// Error response
let error_response = VtigerResponse {
    success: false,
    result: None,
    error: Some(ApiError {
        code: "404".to_string(),
        message: "Not Found".to_string(),
    }),
};

Fields

success: bool

Indicates whether the API call was successful

result: Option<IndexMap<String, Value>>

Contains the response data when success is true

error: Option<ApiError>

Contains error details when success is false

Trait Implementations

impl Debug for VtigerResponse

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for VtigerResponse

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for VtigerResponse

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.