# Data Archiving Service

`IDataArchiveService` in assembly SanteDB.Core.Api version 3.0.1980.0

## Summary

Service contract for data archival and purging

### Description

The data archive service is used by various jobs throughout SanteDB iCDR (such as the [DataRetentionJob](http://santesuite.org/assets/doc/net/html/T_SanteDB_Core_Jobs_DataRetentionJob.htm)) to copy records which are past their retention rules to a secondary data storage facility. This service can be used for long-term archival of old (non-clinically relevant data) data and supports the purging of data which is no longer needed.

## Operations

| Operation | Response/Return | Input/Parameter                                                                                       | Description                                               |
| --------- | --------------- | ----------------------------------------------------------------------------------------------------- | --------------------------------------------------------- |
| Archive   | void            | <p><em>Type</em> <strong>modelType</strong><br><em>Guid\[]</em> <strong>keysToBeArchived</strong></p> | Push the specified records to the archive                 |
| Retrieve  | IdentifiedData  | <p><em>Type</em> <strong>modelType</strong><br><em>Guid</em> <strong>keyToRetrieve</strong></p>       | Retrieve a record from the archive by key and type        |
| Exists    | Boolean         | <p><em>Type</em> <strong>modelType</strong><br><em>Guid</em> <strong>keyToCheck</strong></p>          | Validates whether the specified key exists in the archive |
| Purge     | void            | <p><em>Type</em> <strong>modelType</strong><br><em>Guid\[]</em> <strong>keysToBePurged</strong></p>   | Purge the specified object from the archive               |

## Implementations

None

## Example Implementation

```csharp
/// Example Implementation
using SanteDB.Core.Services;
/// Other usings here
public class MyDataArchiveService : SanteDB.Core.Services.IDataArchiveService { 
	public String ServiceName => "My own IDataArchiveService service";
	/// <summary>
	/// Push the specified records to the archive
	/// </summary>
	public void Archive(Type modelType,Guid[] keysToBeArchived){
		throw new System.NotImplementedException();
	}
	/// <summary>
	/// Retrieve a record from the archive by key and type
	/// </summary>
	public IdentifiedData Retrieve(Type modelType,Guid keyToRetrieve){
		throw new System.NotImplementedException();
	}
	/// <summary>
	/// Validates whether the specified key exists in the archive
	/// </summary>
	public Boolean Exists(Type modelType,Guid keyToCheck){
		throw new System.NotImplementedException();
	}
	/// <summary>
	/// Purge the specified object from the archive
	/// </summary>
	public void Purge(Type modelType,Guid[] keysToBePurged){
		throw new System.NotImplementedException();
	}
}
```

## References

* [IDataArchiveService C# Documentation](http://santesuite.org/assets/doc/net/html/T_SanteDB_Core_Services_IDataArchiveService.htm)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://help.santesuite.org/developers/server-plugins/implementing-.net-features/service-definitions/data-archiving-service.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.