POST api/SmartTransfer/TransferPackage?transferTo={transferTo}
Transfers the incoming package to the specified transferTo client.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| transferTo |
The SmartTransfer identifier for the target client. |
string |
Required |
Body Parameters
The package with the transfer documents for the intended transfer to client.
ESignSystems.SmartTransfer.Services.Models.TransferPackage| Name | Description | Type | Additional information |
|---|---|---|---|
| MessageId | string |
None. |
|
| From | string |
None. |
|
| To | string |
None. |
|
| ContractPackageList | ESignSystems.SmartTransfer.Services.Models.ContractPackageList |
None. |
Request Formats
application/json, text/json
Sample:
{
"MessageId": "sample string 1",
"From": "sample string 2",
"To": "sample string 3",
"ContractPackageList": {
"Packages": 1,
"ContractPackages": [
{
"PackageId": "sample string 1",
"Documents": [
{
"DocumentId": "sample string 1",
"Type": "sample string 2",
"DocumentType": "sample string 3",
"AuditTrail": {
"Events": [
{
"EventId": "sample string 1",
"EventDate": "sample string 2",
"Name": "sample string 3",
"UserName": "sample string 4",
"UserOrganization": "sample string 5"
},
{
"EventId": "sample string 1",
"EventDate": "sample string 2",
"Name": "sample string 3",
"UserName": "sample string 4",
"UserOrganization": "sample string 5"
}
]
},
"Hash": "sample string 4",
"File": "sample string 5",
"UDF1": "sample string 6",
"UDF2": "sample string 7",
"UDF3": "sample string 8"
},
{
"DocumentId": "sample string 1",
"Type": "sample string 2",
"DocumentType": "sample string 3",
"AuditTrail": {
"Events": [
{
"EventId": "sample string 1",
"EventDate": "sample string 2",
"Name": "sample string 3",
"UserName": "sample string 4",
"UserOrganization": "sample string 5"
},
{
"EventId": "sample string 1",
"EventDate": "sample string 2",
"Name": "sample string 3",
"UserName": "sample string 4",
"UserOrganization": "sample string 5"
}
]
},
"Hash": "sample string 4",
"File": "sample string 5",
"UDF1": "sample string 6",
"UDF2": "sample string 7",
"UDF3": "sample string 8"
}
]
},
{
"PackageId": "sample string 1",
"Documents": [
{
"DocumentId": "sample string 1",
"Type": "sample string 2",
"DocumentType": "sample string 3",
"AuditTrail": {
"Events": [
{
"EventId": "sample string 1",
"EventDate": "sample string 2",
"Name": "sample string 3",
"UserName": "sample string 4",
"UserOrganization": "sample string 5"
},
{
"EventId": "sample string 1",
"EventDate": "sample string 2",
"Name": "sample string 3",
"UserName": "sample string 4",
"UserOrganization": "sample string 5"
}
]
},
"Hash": "sample string 4",
"File": "sample string 5",
"UDF1": "sample string 6",
"UDF2": "sample string 7",
"UDF3": "sample string 8"
},
{
"DocumentId": "sample string 1",
"Type": "sample string 2",
"DocumentType": "sample string 3",
"AuditTrail": {
"Events": [
{
"EventId": "sample string 1",
"EventDate": "sample string 2",
"Name": "sample string 3",
"UserName": "sample string 4",
"UserOrganization": "sample string 5"
},
{
"EventId": "sample string 1",
"EventDate": "sample string 2",
"Name": "sample string 3",
"UserName": "sample string 4",
"UserOrganization": "sample string 5"
}
]
},
"Hash": "sample string 4",
"File": "sample string 5",
"UDF1": "sample string 6",
"UDF2": "sample string 7",
"UDF3": "sample string 8"
}
]
}
]
}
}
application/xml, text/xml
Sample:
<TransferPackage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartTransfer.Services.Models">
<ContractPackageList>
<ContractPackages>
<ContractPackage>
<Documents>
<TransferDocument>
<AuditTrail>
<Events>
<AuditEvent>
<EventDate>sample string 2</EventDate>
<EventId>sample string 1</EventId>
<Name>sample string 3</Name>
<UserName>sample string 4</UserName>
<UserOrganization>sample string 5</UserOrganization>
</AuditEvent>
<AuditEvent>
<EventDate>sample string 2</EventDate>
<EventId>sample string 1</EventId>
<Name>sample string 3</Name>
<UserName>sample string 4</UserName>
<UserOrganization>sample string 5</UserOrganization>
</AuditEvent>
</Events>
</AuditTrail>
<DocumentId>sample string 1</DocumentId>
<DocumentType>sample string 3</DocumentType>
<File>sample string 5</File>
<Hash>sample string 4</Hash>
<Type>sample string 2</Type>
<UDF1>sample string 6</UDF1>
<UDF2>sample string 7</UDF2>
<UDF3>sample string 8</UDF3>
</TransferDocument>
<TransferDocument>
<AuditTrail>
<Events>
<AuditEvent>
<EventDate>sample string 2</EventDate>
<EventId>sample string 1</EventId>
<Name>sample string 3</Name>
<UserName>sample string 4</UserName>
<UserOrganization>sample string 5</UserOrganization>
</AuditEvent>
<AuditEvent>
<EventDate>sample string 2</EventDate>
<EventId>sample string 1</EventId>
<Name>sample string 3</Name>
<UserName>sample string 4</UserName>
<UserOrganization>sample string 5</UserOrganization>
</AuditEvent>
</Events>
</AuditTrail>
<DocumentId>sample string 1</DocumentId>
<DocumentType>sample string 3</DocumentType>
<File>sample string 5</File>
<Hash>sample string 4</Hash>
<Type>sample string 2</Type>
<UDF1>sample string 6</UDF1>
<UDF2>sample string 7</UDF2>
<UDF3>sample string 8</UDF3>
</TransferDocument>
</Documents>
<PackageId>sample string 1</PackageId>
</ContractPackage>
<ContractPackage>
<Documents>
<TransferDocument>
<AuditTrail>
<Events>
<AuditEvent>
<EventDate>sample string 2</EventDate>
<EventId>sample string 1</EventId>
<Name>sample string 3</Name>
<UserName>sample string 4</UserName>
<UserOrganization>sample string 5</UserOrganization>
</AuditEvent>
<AuditEvent>
<EventDate>sample string 2</EventDate>
<EventId>sample string 1</EventId>
<Name>sample string 3</Name>
<UserName>sample string 4</UserName>
<UserOrganization>sample string 5</UserOrganization>
</AuditEvent>
</Events>
</AuditTrail>
<DocumentId>sample string 1</DocumentId>
<DocumentType>sample string 3</DocumentType>
<File>sample string 5</File>
<Hash>sample string 4</Hash>
<Type>sample string 2</Type>
<UDF1>sample string 6</UDF1>
<UDF2>sample string 7</UDF2>
<UDF3>sample string 8</UDF3>
</TransferDocument>
<TransferDocument>
<AuditTrail>
<Events>
<AuditEvent>
<EventDate>sample string 2</EventDate>
<EventId>sample string 1</EventId>
<Name>sample string 3</Name>
<UserName>sample string 4</UserName>
<UserOrganization>sample string 5</UserOrganization>
</AuditEvent>
<AuditEvent>
<EventDate>sample string 2</EventDate>
<EventId>sample string 1</EventId>
<Name>sample string 3</Name>
<UserName>sample string 4</UserName>
<UserOrganization>sample string 5</UserOrganization>
</AuditEvent>
</Events>
</AuditTrail>
<DocumentId>sample string 1</DocumentId>
<DocumentType>sample string 3</DocumentType>
<File>sample string 5</File>
<Hash>sample string 4</Hash>
<Type>sample string 2</Type>
<UDF1>sample string 6</UDF1>
<UDF2>sample string 7</UDF2>
<UDF3>sample string 8</UDF3>
</TransferDocument>
</Documents>
<PackageId>sample string 1</PackageId>
</ContractPackage>
</ContractPackages>
<Packages>1</Packages>
</ContractPackageList>
<From>sample string 2</From>
<MessageId>sample string 1</MessageId>
<To>sample string 3</To>
</TransferPackage>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
The results of the transfer.
ESignSystems.SmartTransfer.Models.TransferResponseModel| Name | Description | Type | Additional information |
|---|---|---|---|
| MessageId | string |
None. |
|
| To | string |
None. |
|
| Succeeded | boolean |
None. |
|
| ErrorMessage | string |
None. |
|
| ContractResponses | Collection of ESignSystems.SmartTransfer.Models.ContractPackageResponseModel |
None. |
Response Formats
application/json, text/json
Sample:
{
"MessageId": "sample string 1",
"To": "sample string 2",
"Succeeded": true,
"ErrorMessage": "sample string 4",
"ContractResponses": []
}
application/xml, text/xml
Sample:
<TransferResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartTransfer.Models"> <ContractResponses /> <ErrorMessage>sample string 4</ErrorMessage> <MessageId>sample string 1</MessageId> <Succeeded>true</Succeeded> <To>sample string 2</To> </TransferResponseModel>