POST api/service/featuredlistings/{id}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

string

None.

Body Parameters

FeaturedListingsServiceProvisioningModel
NameDescriptionTypeAdditional information
agentId

integer

None.

userSchedule

UserScheduleModel

None.

businessPages

Collection of FacebookPageModel

None.

isMlsLive

boolean

None.

mlsId

string

None.

mlsOfficeId

string

None.

mlsAgentId

string

None.

serviceType

ServiceType

None.

setupDate

date

None.

mlsSetupRequired

boolean

None.

mlsSetupCompleted

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "agentId": 1,
  "userSchedule": {
    "enabled": true,
    "subscribed": "2021-08-01T04:03:07.0938863+00:00",
    "canceled": "2021-08-01T04:03:07.0938863+00:00",
    "postToBusinessPage": true,
    "facebookPageId": "sample string 3",
    "postToProfile": true,
    "postingDays": [
      true,
      true
    ],
    "featuredListings": true,
    "includeOfficeListings": true
  },
  "businessPages": [
    {
      "id": "sample string 1",
      "name": "sample string 2",
      "hasSweepstakesTab": true,
      "agentDirectory": true,
      "propertySearch": true,
      "homeValue": true,
      "isBusinessClaimed": true,
      "adTermsChecked": true,
      "sweepstakesDate": "2021-08-01T04:03:07.0938863+00:00",
      "agentProfileAddDate": "2021-08-01T04:03:07.0938863+00:00",
      "propertySearchAddDate": "2021-08-01T04:03:07.0938863+00:00",
      "homeValueDate": "2021-08-01T04:03:07.0938863+00:00",
      "agentProfilePost": true
    },
    {
      "id": "sample string 1",
      "name": "sample string 2",
      "hasSweepstakesTab": true,
      "agentDirectory": true,
      "propertySearch": true,
      "homeValue": true,
      "isBusinessClaimed": true,
      "adTermsChecked": true,
      "sweepstakesDate": "2021-08-01T04:03:07.0938863+00:00",
      "agentProfileAddDate": "2021-08-01T04:03:07.0938863+00:00",
      "propertySearchAddDate": "2021-08-01T04:03:07.0938863+00:00",
      "homeValueDate": "2021-08-01T04:03:07.0938863+00:00",
      "agentProfilePost": true
    }
  ],
  "isMlsLive": true,
  "mlsId": "sample string 3",
  "mlsOfficeId": "sample string 4",
  "mlsAgentId": "sample string 5",
  "serviceType": 0,
  "setupDate": "2021-08-01T04:03:07.0938863+00:00",
  "mlsSetupRequired": true,
  "mlsSetupCompleted": true
}

text/html

Sample:
{"agentId":1,"userSchedule":{"enabled":true,"subscribed":"2021-08-01T04:03:07.0938863+00:00","canceled":"2021-08-01T04:03:07.0938863+00:00","postToBusinessPage":true,"facebookPageId":"sample string 3","postToProfile":true,"postingDays":[true,true],"featuredListings":true,"includeOfficeListings":true},"businessPages":[{"id":"sample string 1","name":"sample string 2","hasSweepstakesTab":true,"agentDirectory":true,"propertySearch":true,"homeValue":true,"isBusinessClaimed":true,"adTermsChecked":true,"sweepstakesDate":"2021-08-01T04:03:07.0938863+00:00","agentProfileAddDate":"2021-08-01T04:03:07.0938863+00:00","propertySearchAddDate":"2021-08-01T04:03:07.0938863+00:00","homeValueDate":"2021-08-01T04:03:07.0938863+00:00","agentProfilePost":true},{"id":"sample string 1","name":"sample string 2","hasSweepstakesTab":true,"agentDirectory":true,"propertySearch":true,"homeValue":true,"isBusinessClaimed":true,"adTermsChecked":true,"sweepstakesDate":"2021-08-01T04:03:07.0938863+00:00","agentProfileAddDate":"2021-08-01T04:03:07.0938863+00:00","propertySearchAddDate":"2021-08-01T04:03:07.0938863+00:00","homeValueDate":"2021-08-01T04:03:07.0938863+00:00","agentProfilePost":true}],"isMlsLive":true,"mlsId":"sample string 3","mlsOfficeId":"sample string 4","mlsAgentId":"sample string 5","serviceType":0,"setupDate":"2021-08-01T04:03:07.0938863+00:00","mlsSetupRequired":true,"mlsSetupCompleted":true}

application/xml, text/xml

Sample:
<FeaturedListingsServiceProvisioningModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NPlay.Common.Models.Services">
  <MlsSetupCompleted>true</MlsSetupCompleted>
  <MlsSetupRequired>true</MlsSetupRequired>
  <ServiceType>AgentDirectory</ServiceType>
  <SetupDate>2021-08-01T04:03:07.0938863+00:00</SetupDate>
  <AgentId>1</AgentId>
  <BusinessPages>
    <FacebookPageModel>
      <AdTermsChecked>true</AdTermsChecked>
      <AgentDirectory>true</AgentDirectory>
      <AgentProfileAddDate>2021-08-01T04:03:07.0938863+00:00</AgentProfileAddDate>
      <AgentProfilePost>true</AgentProfilePost>
      <HasSweepstakesTab>true</HasSweepstakesTab>
      <HomeValue>true</HomeValue>
      <HomeValueDate>2021-08-01T04:03:07.0938863+00:00</HomeValueDate>
      <Id>sample string 1</Id>
      <IsBusinessClaimed>true</IsBusinessClaimed>
      <Name>sample string 2</Name>
      <PropertySearch>true</PropertySearch>
      <PropertySearchAddDate>2021-08-01T04:03:07.0938863+00:00</PropertySearchAddDate>
      <SweepstakesDate>2021-08-01T04:03:07.0938863+00:00</SweepstakesDate>
    </FacebookPageModel>
    <FacebookPageModel>
      <AdTermsChecked>true</AdTermsChecked>
      <AgentDirectory>true</AgentDirectory>
      <AgentProfileAddDate>2021-08-01T04:03:07.0938863+00:00</AgentProfileAddDate>
      <AgentProfilePost>true</AgentProfilePost>
      <HasSweepstakesTab>true</HasSweepstakesTab>
      <HomeValue>true</HomeValue>
      <HomeValueDate>2021-08-01T04:03:07.0938863+00:00</HomeValueDate>
      <Id>sample string 1</Id>
      <IsBusinessClaimed>true</IsBusinessClaimed>
      <Name>sample string 2</Name>
      <PropertySearch>true</PropertySearch>
      <PropertySearchAddDate>2021-08-01T04:03:07.0938863+00:00</PropertySearchAddDate>
      <SweepstakesDate>2021-08-01T04:03:07.0938863+00:00</SweepstakesDate>
    </FacebookPageModel>
  </BusinessPages>
  <IsMlsLive>true</IsMlsLive>
  <MlsAgentId>sample string 5</MlsAgentId>
  <MlsId>sample string 3</MlsId>
  <MlsOfficeId>sample string 4</MlsOfficeId>
  <UserSchedule>
    <Canceled>2021-08-01T04:03:07.0938863+00:00</Canceled>
    <Enabled>true</Enabled>
    <FacebookPageId>sample string 3</FacebookPageId>
    <FeaturedListings>true</FeaturedListings>
    <IncludeOfficeListings>true</IncludeOfficeListings>
    <PostToBusinessPage>true</PostToBusinessPage>
    <PostToProfile>true</PostToProfile>
    <PostingDays xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:boolean>true</d3p1:boolean>
      <d3p1:boolean>true</d3p1:boolean>
    </PostingDays>
    <Subscribed>2021-08-01T04:03:07.0938863+00:00</Subscribed>
  </UserSchedule>
</FeaturedListingsServiceProvisioningModel>

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 'FeaturedListingsServiceProvisioningModel'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, text/html, application/xml, text/xml

Sample:

Sample not available.