GET api/ContactSuffixes/search?accountNumber={accountNumber}&addEmptyItem={addEmptyItem}&emptyItemText={emptyItemText}&page={page}&itemsPerPage={itemsPerPage}

Returns a list of contact suffixes.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
accountNumber

Account number

string

Required

addEmptyItem

Indicates if an empty item be added in the list.

boolean

Default value is False

emptyItemText

Text of the empty item

string

Default value is

page

Page number requested (search results are paginated).

integer

Default value is 1

itemsPerPage

Items to return on each page. See page parameter above.

integer

Default value is 10

Body Parameters

None.

Response Information

Resource Description

Collection of ContactSuffixModel
NameDescriptionTypeAdditional information
Id

Unique ID of the suffix.

integer

None.

Name

Name of the suffix (Required).

string

None.

Active

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

boolean

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": 1,
    "Name": "sample string 2",
    "Active": true
  },
  {
    "Id": 1,
    "Name": "sample string 2",
    "Active": true
  }
]

application/xml, text/xml

Sample:
<ArrayOfContactSuffixModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models.Contacts">
  <ContactSuffixModel>
    <Active>true</Active>
    <Id>1</Id>
    <Name>sample string 2</Name>
  </ContactSuffixModel>
  <ContactSuffixModel>
    <Active>true</Active>
    <Id>1</Id>
    <Name>sample string 2</Name>
  </ContactSuffixModel>
</ArrayOfContactSuffixModel>