_httpPutJson

Documentation: `_httpPutJson` Function

The _httpPutJson function is designed to perform an HTTP PUT request to a specified URL, sending a payload in JSON format. The function allows for the inclusion of custom headers and handles different encoding formats. It returns the HTTP status code and the content of the response.

Function Signature:

Parameters:

url (Required):

Description: The URL to which the PUT request is sent. This should be a valid URL pointing to the resource or API endpoint that will handle the JSON payload.

Type: String

Example:

headers (Required):

Description: An object containing key-value pairs representing the headers to be included in the PUT request. These headers can be used for authorization, content type, or any other required metadata.

Type: Object

Example:

payload (Required):

Description: The data to be sent in the body of the PUT request, typically an object that will be serialized to JSON format.

Type: Object

Example:

encoding (Optional):

Description: The encoding format used to encode the request body and decode the response content. If not provided, the default encoding is utf-8. This can be useful when dealing with different character encodings.

Type: String

Default: 'utf-8'

Example:

Return Value:

Returns:

A JSON object containing the HTTP status code and the content of the response. The structure includes:

StatusCode: The HTTP status code returned by the server.

Content: The body of the response, typically a JSON object or string, depending on the response format.

Type: Object

Example:

Function Workflow:

Validate Input:

The function checks if the url is provided and is a valid string. If the url is missing or invalid, an error may be raised or the operation may be aborted.

Prepare HTTP Request:

The function creates an HTTP client and prepares the PUT request with the specified url.

It sets the request headers using the headers object. These headers often include Authorization tokens and Content-Type.

The payload is converted to a JSON string using the specified encoding (default is utf-8).

Send HTTP Request:

The function sends the PUT request with the JSON-encoded payload to the specified url.

Handle Response:

The function checks the response status code. If the response is successful (e.g., status code 200), it reads the response content.

The content is decoded using the specified encoding and parsed as JSON if applicable.

Return JSON Object:

The function constructs a JSON object containing the StatusCode and the Content of the response. This JSON object is returned to the caller.

Exception Handling:

If any exception occurs during the request (e.g., network errors, invalid JSON), the function may log the error and return an appropriate response object with an error status code.

Example Usage:

Important Considerations:

Ensure URL Validity:

The url parameter must be a valid and reachable URL. If the URL is incorrect or unreachable, the function may return an error or an unsuccessful status code.

Include Necessary Headers:

The headers object should include all necessary headers, such as authorization tokens, content types, and any other required information for the request.

Format Payload Correctly:

The payload parameter must be formatted correctly as an object. It will be serialized to JSON before being sent in the request body.

Handle Different Encodings:

If the response content or the payload uses a different encoding format, specify the correct encoding in the encoding parameter to ensure proper handling.

By using _httpPutJson, you can efficiently update data on APIs and other resources while managing custom headers and different encoding formats. The function simplifies the process of making PUT requests and handling responses in your application.

Documentation: _httpPutJson Function#

Function Signature:#

Parameters:#

Return Value:#

Function Workflow:#

Example Usage:#

Important Considerations:#

Documentation: `_httpPutJson` Function

Function Signature:

Parameters:

Return Value:

Function Workflow:

Example Usage:

Important Considerations: