Get Serialized Model
    • PDF

    Get Serialized Model

    • PDF

    Article summary

    Overview

    The API is used to retrieve all the data from the process's Model.

    URL Path 

    player/api/model-storing/get-serialized-model

    Method

    GET

    Authentication Using apiKeyField

    The apiKey enables EasySend to use a simple authentication mechanism that authenticates the client against the server. The apiKey must be passed with every API call.

    Request Content

    Table 1 describes the required request content parameters.

    Table 1: Request Content

    ParameterTypeOptional/Required Discerption
    apiKeystringRequiredThe API key for the provided environment 
    customerIdstringRequiredAs given by EasySend
    masterIdstringRequiredThe master resource identifier for the model.

    Example Request

    curl -X GET "https://api.example.com/player/api/model-storing/get-serialized-model?masterRid=ABC123&customerId=customer1" -H "apiKey: your-api-key-here"

    Success Response (200 OK)

    {
    
      "field1": "value1",
    
      "field2": "value2",
    
      "nested_object": {
    
        "nested_field": "nested_value"
    
      }
    
    }

    Error Responses

    400 Bad Request: Missing required parameters

    {
    
      "error": "Missing required parameter: masterRid"
    
    }

    401 Unauthorized: Invalid API key or customer ID

    {
    
      "error": "Unauthorized"
    
    }

    500 Internal Server Error: Server error (e.g., missing process ID or model fetch failure)

    {
    
      "error": "Failed to retrieve model"
    
    }

    Was this article helpful?