---
title: ApiResponse
summary: API reference for ApiResponse.
status: draft
owner: SAIF Doc Gen
last_reviewed: 2026-09-24
library: SAIF.SAIFCode.Core
reference_type: package
---

# ApiResponse

`ApiResponse` is a response/result DTO in the Policies / PolicyDocumentsApi area, carrying the output of a service or API call*.

## Purpose
- Carries the output returned from a Policies / PolicyDocumentsApi service or API operation*.

## Context
- Namespace: `SAIF.Core.Contracts.Policies.PolicyDocumentsApi`
- Kind: Class
- Assembly/package: `SAIF.Core` (NuGet package `SAIF.SAIFCode.Core`)

## Public members
| Member | Signature | Purpose |
| --- | --- | --- |
| `ApiResponse` | `ApiResponse()` | Initializes a new instance of this type*. |
| `IsValid` | `bool IsValid { get; set; }` | Indicates whether this ApiResponse is a valid*. |
| `ReturnCode` | `int ReturnCode { get; set; }` | Classifies the return using a coded value*. |
| `Message` | `string Message { get; set; }` | Represents the message associated with this ApiResponse*. |
| `PolicyNumber` | `long PolicyNumber { get; set; }` | Uniquely identifies the policy recorded on this ApiResponse*. |
| `PdfStream` | `Collection<byte> PdfStream { get; set; }` | Represents the pdf stream associated with this ApiResponse*. |
| `Data` | `Object Data { set; }` | Represents the data associated with this ApiResponse*. |
| `WriteByteCollection` | `Collection<byte> WriteByteCollection(Collection<byte> inBytes)` | Handles write byte collection, given `inBytes`*. |
| `Validate` | `ApiResponse Validate(int returnCode)` | Validates this item, given `returnCode`*. |
| `Validate` | `ApiResponse Validate(int returnCode, string message)` | Validates this item, given `returnCode`, `message`*. |

> **Note:** Statements marked with `*` were inferred from code structure, naming
> conventions, or contextual evidence where direct confirmation was not available
> in source artifacts. Statements marked with `**` could not be confirmed; treat
> as unknown until verified.

## Sources
- Core/SAIF.Core/Contracts/Policies/PolicyDocumentsApi/ApiResponse.cs