GET api/SecureRecipients?externalId={externalId}

Gets information about a secure recipient.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
externalId

Secure Recipient's unique ID on integrating system.

 string

Required

Body Parameters

None.

Response Information

Resource Description

SecureRecipientModel
NameDescriptionTypeAdditional information
Name

Secure recipient name.

 string

None.
NotificationsEmailAddress

Notifications email address.

 string

None.
Id

Unique ID of the model in the portal (Read only).

 globally unique identifier

None.
ExternalId

Unique ID of the model on integrating system (Required).

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "name": "sample string 1",
  "notificationsEmailAddress": "sample string 2",
  "id": "706bbae5-80ef-4bd8-b955-8574a1d0d635",
  "externalId": "sample string 4"
}

application/xml, text/xml

Sample: 
<SecureRecipientModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.SecureRecipients">
  <ExternalId xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models">sample string 4</ExternalId>
  <Id xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models">706bbae5-80ef-4bd8-b955-8574a1d0d635</Id>
  <Name>sample string 1</Name>
  <NotificationsEmailAddress>sample string 2</NotificationsEmailAddress>
</SecureRecipientModel>