PATCH v1/ProfilePersons/{id}/ProfilePhones/{name}

Update Profile Person Phone

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

name

string

Required

Body Parameters

PatchPhoneInput
NameDescriptionTypeAdditional information
countryCode

string

None.

areaCode

string

None.

phone

string

None.

phoneExtension

string

None.

Request Formats

application/json, text/json

Sample:
{
  "countryCode": "sample string 1",
  "areaCode": "sample string 2",
  "phone": "sample string 3",
  "phoneExtension": "sample string 4"
}

text/html

Sample:
{"countryCode":"sample string 1","areaCode":"sample string 2","phone":"sample string 3","phoneExtension":"sample string 4"}

application/xml, text/xml

Sample:
<v1_ProfilePersons_ProfilePersonEndpointController.PatchPhoneInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aptify.Services.Generated.v1_ProfilePersons_ProfilePersonEndpoint">
  <areaCode>sample string 2</areaCode>
  <countryCode>sample string 1</countryCode>
  <phone>sample string 3</phone>
  <phoneExtension>sample string 4</phoneExtension>
</v1_ProfilePersons_ProfilePersonEndpointController.PatchPhoneInput>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'PatchPhoneInput'.

Response Information

Resource Description

PersonProfilePhone
NameDescriptionTypeAdditional information
id

The id of this phone

integer

None.

name

The name of this phone

string

None.

countryCode

The country code of this phone

string

None.

areaCode

The area code of this phone

string

None.

phone

The phone

string

None.

formattedPhone

The formatted value of this phone

string

None.

phoneExtension

The extension of this phone

string

None.

isPreferredPhone

The value indicate if profile phone is preferred phone

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "id": 1,
  "name": "sample string 2",
  "countryCode": "sample string 3",
  "areaCode": "sample string 4",
  "phone": "sample string 5",
  "formattedPhone": "sample string 6",
  "phoneExtension": "sample string 7",
  "isPreferredPhone": true
}

text/html

Sample:
{"id":1,"name":"sample string 2","countryCode":"sample string 3","areaCode":"sample string 4","phone":"sample string 5","formattedPhone":"sample string 6","phoneExtension":"sample string 7","isPreferredPhone":true}

application/xml, text/xml

Sample:
<v1_ProfilePersons_ProfilePersonEndpointController.PersonProfilePhone xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aptify.Services.Generated.v1_ProfilePersons_ProfilePersonEndpoint">
  <areaCode>sample string 4</areaCode>
  <countryCode>sample string 3</countryCode>
  <formattedPhone>sample string 6</formattedPhone>
  <id>1</id>
  <isPreferredPhone>true</isPreferredPhone>
  <name>sample string 2</name>
  <phone>sample string 5</phone>
  <phoneExtension>sample string 7</phoneExtension>
</v1_ProfilePersons_ProfilePersonEndpointController.PersonProfilePhone>