GET api/ContactSuffixes?externalId={externalId}

Gets information about a contact Suffix.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
externalId

Prifix's unique ID in integrating system.

 string

Required

Body Parameters

None.

Response Information

Resource Description

ContactSuffixModel
NameDescriptionTypeAdditional information
Name

Name of the suffix (Required).

 string

None.
Active

Indicates whether the suffix is active or not (Required).

 boolean

None.
Id

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

 string

None.
ExternalId

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

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "name": "sample string 1",
  "active": true,
  "id": "sample string 3",
  "externalId": "sample string 4"
}

application/xml, text/xml

Sample: 
<ContactSuffixModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.Contacts">
  <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">sample string 3</Id>
  <Active>true</Active>
  <Name>sample string 1</Name>
</ContactSuffixModel>