Internal API-Guide

GET api/Vendors/{vendorId}/PhoneNumbers

Request Information

URI Parameters

NameDescriptionTypeAdditional information
vendorId

integer

Required

Body Parameters

None

Response Information

Resource Description

Collection of Phone
NameDescriptionTypeAdditional information
PhoneType

PhoneType None.
CountryCode

string None.
CityCode

string None.
AreaCode

string None.
ExchangeAndNumber

string None.
Extension

string None.
Id

integer None.
CommunicationId

integer None.
ContactId

integer None.
LanguageId

integer None.
IsPrimary

boolean None.
FullPhone

string None.
Attributes

Collection of IEntityAttribute None.
CreateDateTime

date None.
CreateUser

string None.
DeactivateDateTime

date None.
DeactivateUser

string None.
PreviousRecordID

integer None.
IsDirty

boolean None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "phoneType": 1,
    "countryCode": "sample string 1",
    "cityCode": "sample string 2",
    "areaCode": "sample string 3",
    "exchangeAndNumber": "sample string 4",
    "extension": "sample string 5",
    "id": 6,
    "communicationId": 1,
    "contactId": 1,
    "languageId": 7,
    "isPrimary": true,
    "fullPhone": "sample string 1 sample string 3-sam-ple string 4 sample string 5",
    "attributes": null,
    "createDateTime": "2026-08-18T15:52:48.5344138Z",
    "createUser": "sample string 10",
    "deactivateDateTime": "2026-08-18T15:52:48.5344138Z",
    "deactivateUser": "sample string 11",
    "previousRecordID": 1,
    "isDirty": true
  },
  {
    "phoneType": 1,
    "countryCode": "sample string 1",
    "cityCode": "sample string 2",
    "areaCode": "sample string 3",
    "exchangeAndNumber": "sample string 4",
    "extension": "sample string 5",
    "id": 6,
    "communicationId": 1,
    "contactId": 1,
    "languageId": 7,
    "isPrimary": true,
    "fullPhone": "sample string 1 sample string 3-sam-ple string 4 sample string 5",
    "attributes": null,
    "createDateTime": "2026-08-18T15:52:48.5344138Z",
    "createUser": "sample string 10",
    "deactivateDateTime": "2026-08-18T15:52:48.5344138Z",
    "deactivateUser": "sample string 11",
    "previousRecordID": 1,
    "isDirty": true
  }
]

application/xml, text/xml

Sample: 
<ArrayOfPhone xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ControlESI.FMPilot.Core.BE.Entities.Communication">
  <Phone>
    <AreaCode>sample string 3</AreaCode>
    <Attributes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
    <CityCode>sample string 2</CityCode>
    <CommunicationId>1</CommunicationId>
    <ContactId>1</ContactId>
    <CountryCode>sample string 1</CountryCode>
    <CreateDateTime>2026-08-18T15:52:48.5344138+00:00</CreateDateTime>
    <CreateUser>sample string 10</CreateUser>
    <DeactivateDateTime>2026-08-18T15:52:48.5344138+00:00</DeactivateDateTime>
    <DeactivateUser>sample string 11</DeactivateUser>
    <ExchangeAndNumber>sample string 4</ExchangeAndNumber>
    <Extension>sample string 5</Extension>
    <Id>6</Id>
    <IsDirty>true</IsDirty>
    <IsPrimary>true</IsPrimary>
    <LanguageId>7</LanguageId>
    <PhoneType>Office</PhoneType>
    <PreviousRecordID>1</PreviousRecordID>
  </Phone>
  <Phone>
    <AreaCode>sample string 3</AreaCode>
    <Attributes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
    <CityCode>sample string 2</CityCode>
    <CommunicationId>1</CommunicationId>
    <ContactId>1</ContactId>
    <CountryCode>sample string 1</CountryCode>
    <CreateDateTime>2026-08-18T15:52:48.5344138+00:00</CreateDateTime>
    <CreateUser>sample string 10</CreateUser>
    <DeactivateDateTime>2026-08-18T15:52:48.5344138+00:00</DeactivateDateTime>
    <DeactivateUser>sample string 11</DeactivateUser>
    <ExchangeAndNumber>sample string 4</ExchangeAndNumber>
    <Extension>sample string 5</Extension>
    <Id>6</Id>
    <IsDirty>true</IsDirty>
    <IsPrimary>true</IsPrimary>
    <LanguageId>7</LanguageId>
    <PhoneType>Office</PhoneType>
    <PreviousRecordID>1</PreviousRecordID>
  </Phone>
</ArrayOfPhone>