POST api/PageEngageService
Request Information
URI Parameters
None.
Body Parameters
PageEngageServiceProvisioningModelName | Description | Type | Additional information |
---|---|---|---|
agentId | integer |
None. |
|
userSchedule | UserScheduleModel |
None. |
|
businessPages | Collection of FacebookPageModel |
None. |
|
agentPostTagFilters | Collection of integer |
None. |
|
hasInstagramPageEngage | boolean |
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": "2024-09-08T02:13:29.443073+00:00", "canceled": "2024-09-08T02:13:29.443073+00:00", "postToBusinessPage": true, "facebookPageId": "sample string 3", "postToProfile": true, "postingDays": [ true, true ], "featuredListings": true, "includeOfficeListings": true, "productId": 1 }, "businessPages": [ { "id": "sample string 1", "name": "sample string 2", "hasSweepstakesTab": true, "agentDirectory": true, "propertySearch": true, "homeValue": true, "isBusinessClaimed": true, "adTermsChecked": true, "sweepstakesDate": "2024-09-08T02:13:29.443073+00:00", "agentProfileAddDate": "2024-09-08T02:13:29.443073+00:00", "propertySearchAddDate": "2024-09-08T02:13:29.443073+00:00", "homeValueDate": "2024-09-08T02:13:29.443073+00:00", "agentProfilePost": true, "igUserId": "sample string 6", "instagramAccountName": "sample string 7", "instagramUserName": "sample string 8", "leadMagnetAdded": true }, { "id": "sample string 1", "name": "sample string 2", "hasSweepstakesTab": true, "agentDirectory": true, "propertySearch": true, "homeValue": true, "isBusinessClaimed": true, "adTermsChecked": true, "sweepstakesDate": "2024-09-08T02:13:29.443073+00:00", "agentProfileAddDate": "2024-09-08T02:13:29.443073+00:00", "propertySearchAddDate": "2024-09-08T02:13:29.443073+00:00", "homeValueDate": "2024-09-08T02:13:29.443073+00:00", "agentProfilePost": true, "igUserId": "sample string 6", "instagramAccountName": "sample string 7", "instagramUserName": "sample string 8", "leadMagnetAdded": true } ], "agentPostTagFilters": [ 1, 2 ], "hasInstagramPageEngage": true, "serviceType": 0, "setupDate": "2024-09-08T02:13:29.443073+00:00", "mlsSetupRequired": true, "mlsSetupCompleted": true }
text/html
Sample:
{"agentId":1,"userSchedule":{"enabled":true,"subscribed":"2024-09-08T02:13:29.443073+00:00","canceled":"2024-09-08T02:13:29.443073+00:00","postToBusinessPage":true,"facebookPageId":"sample string 3","postToProfile":true,"postingDays":[true,true],"featuredListings":true,"includeOfficeListings":true,"productId":1},"businessPages":[{"id":"sample string 1","name":"sample string 2","hasSweepstakesTab":true,"agentDirectory":true,"propertySearch":true,"homeValue":true,"isBusinessClaimed":true,"adTermsChecked":true,"sweepstakesDate":"2024-09-08T02:13:29.443073+00:00","agentProfileAddDate":"2024-09-08T02:13:29.443073+00:00","propertySearchAddDate":"2024-09-08T02:13:29.443073+00:00","homeValueDate":"2024-09-08T02:13:29.443073+00:00","agentProfilePost":true,"igUserId":"sample string 6","instagramAccountName":"sample string 7","instagramUserName":"sample string 8","leadMagnetAdded":true},{"id":"sample string 1","name":"sample string 2","hasSweepstakesTab":true,"agentDirectory":true,"propertySearch":true,"homeValue":true,"isBusinessClaimed":true,"adTermsChecked":true,"sweepstakesDate":"2024-09-08T02:13:29.443073+00:00","agentProfileAddDate":"2024-09-08T02:13:29.443073+00:00","propertySearchAddDate":"2024-09-08T02:13:29.443073+00:00","homeValueDate":"2024-09-08T02:13:29.443073+00:00","agentProfilePost":true,"igUserId":"sample string 6","instagramAccountName":"sample string 7","instagramUserName":"sample string 8","leadMagnetAdded":true}],"agentPostTagFilters":[1,2],"hasInstagramPageEngage":true,"serviceType":0,"setupDate":"2024-09-08T02:13:29.443073+00:00","mlsSetupRequired":true,"mlsSetupCompleted":true}
application/xml, text/xml
Sample:
<PageEngageServiceProvisioningModel 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>2024-09-08T02:13:29.443073+00:00</SetupDate> <AgentId>1</AgentId> <AgentPostTagFilters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:int>1</d2p1:int> <d2p1:int>2</d2p1:int> </AgentPostTagFilters> <BusinessPages> <FacebookPageModel> <AdTermsChecked>true</AdTermsChecked> <AgentDirectory>true</AgentDirectory> <AgentProfileAddDate>2024-09-08T02:13:29.443073+00:00</AgentProfileAddDate> <AgentProfilePost>true</AgentProfilePost> <HasSweepstakesTab>true</HasSweepstakesTab> <HomeValue>true</HomeValue> <HomeValueDate>2024-09-08T02:13:29.443073+00:00</HomeValueDate> <IGUserId>sample string 6</IGUserId> <Id>sample string 1</Id> <InstagramAccountName>sample string 7</InstagramAccountName> <InstagramUserName>sample string 8</InstagramUserName> <IsBusinessClaimed>true</IsBusinessClaimed> <LeadMagnetAdded>true</LeadMagnetAdded> <Name>sample string 2</Name> <PropertySearch>true</PropertySearch> <PropertySearchAddDate>2024-09-08T02:13:29.443073+00:00</PropertySearchAddDate> <SweepstakesDate>2024-09-08T02:13:29.443073+00:00</SweepstakesDate> </FacebookPageModel> <FacebookPageModel> <AdTermsChecked>true</AdTermsChecked> <AgentDirectory>true</AgentDirectory> <AgentProfileAddDate>2024-09-08T02:13:29.443073+00:00</AgentProfileAddDate> <AgentProfilePost>true</AgentProfilePost> <HasSweepstakesTab>true</HasSweepstakesTab> <HomeValue>true</HomeValue> <HomeValueDate>2024-09-08T02:13:29.443073+00:00</HomeValueDate> <IGUserId>sample string 6</IGUserId> <Id>sample string 1</Id> <InstagramAccountName>sample string 7</InstagramAccountName> <InstagramUserName>sample string 8</InstagramUserName> <IsBusinessClaimed>true</IsBusinessClaimed> <LeadMagnetAdded>true</LeadMagnetAdded> <Name>sample string 2</Name> <PropertySearch>true</PropertySearch> <PropertySearchAddDate>2024-09-08T02:13:29.443073+00:00</PropertySearchAddDate> <SweepstakesDate>2024-09-08T02:13:29.443073+00:00</SweepstakesDate> </FacebookPageModel> </BusinessPages> <HasInstagramPageEngage>true</HasInstagramPageEngage> <UserSchedule> <Canceled>2024-09-08T02:13:29.443073+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> <ProductId>1</ProductId> <Subscribed>2024-09-08T02:13:29.443073+00:00</Subscribed> </UserSchedule> </PageEngageServiceProvisioningModel>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, text/html, application/xml, text/xml
Sample:
Sample not available.