GET api/SmartTransfer/Partners/{smartTransferPartnerId}

Gets a specific smart transfer partner by the identifier.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
smartTransferPartnerId

The smart transfer partner identifier.

 integer

Required

Body Parameters

None.

Response Information

Resource Description

The smart transfer partner.

ESignSystems.SmartSAFE.Models.SmartTransfer.SmartTransferPartnerModel
NameDescriptionTypeAdditional information
SmartTransferPartnerId

Gets or sets the smart trasnfer partner identifier.

 integer

None.
ClientId

Gets or sets the client identifier.

 integer

None.
Name

Gets or sets the name.

 string

Required

Max length: 256
Url

Gets or sets the url.

 string

Required

Max length: 512
Active

Gets or sets a value indicating whether the partner is active.

 boolean

None.
PublicKey

Gets or sets the public key.

 string

Required

Max length: 4096
UpdatedBy

Gets or sets the name of the user that updated the model.

 string

None.
UpdatedDate

Gets or sets the date an time that the model was updated.

 date

None.

Response Formats

application/json, text/json

Sample: 
{
  "SmartTransferPartnerId": 1,
  "ClientId": 1,
  "Name": "sample string 1",
  "Url": "sample string 2",
  "Active": true,
  "PublicKey": "sample string 4",
  "UpdatedBy": "sample string 5",
  "UpdatedDate": "2024-11-26T17:19:13.502423-05:00"
}

application/xml, text/xml

Sample: 
<SmartTransferPartnerModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SmartTransfer">
  <UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">sample string 5</UpdatedBy>
  <UpdatedDate xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">2024-11-26T17:19:13.502423-05:00</UpdatedDate>
  <Active>true</Active>
  <ClientId>1</ClientId>
  <Name>sample string 1</Name>
  <PublicKey>sample string 4</PublicKey>
  <SmartTransferPartnerId>1</SmartTransferPartnerId>
  <Url>sample string 2</Url>
</SmartTransferPartnerModel>