POST api/facebookads/createCatalog

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
agentId	integer	None.
geoLocations	GeoLocations	None.
price	decimal number	None.
percentageCut	integer	None.
pageId	string	None.
adType	AdType	None.
inputId	string	None.
description	string	None.
message	string	None.
name	string	None.
creativeType	string	None.
productSetId	integer	None.
endDate	date	None.
charge_id	string	None.
subscriptionId	string	None.
subscriptionPeriodStart	date	None.
subscriptionPeriodEnd	date	None.
adAccountId	string	None.
filter	string	None.
catalogId	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "agentId": 1,
  "geoLocations": {
    "custom_locations": [
      {
        "latitude": 1.1,
        "longitude": 2.1,
        "radius": 3,
        "distance_unit": "sample string 4",
        "address_string": "sample string 5"
      },
      {
        "latitude": 1.1,
        "longitude": 2.1,
        "radius": 3,
        "distance_unit": "sample string 4",
        "address_string": "sample string 5"
      }
    ]
  },
  "price": 2.0,
  "percentageCut": 3,
  "pageId": "sample string 4",
  "adType": 1,
  "inputId": "sample string 5",
  "description": "sample string 6",
  "message": "sample string 7",
  "name": "sample string 8",
  "creativeType": "sample string 9",
  "productSetId": 10,
  "endDate": "2024-04-20T04:55:46.9919031+00:00",
  "charge_id": "sample string 12",
  "subscriptionId": "sample string 13",
  "subscriptionPeriodStart": "2024-04-20T04:55:46.9919031+00:00",
  "subscriptionPeriodEnd": "2024-04-20T04:55:46.9919031+00:00",
  "adAccountId": "sample string 14",
  "filter": "sample string 15",
  "catalogId": 16
}

text/html

Sample:

{"agentId":1,"geoLocations":{"custom_locations":[{"latitude":1.1,"longitude":2.1,"radius":3,"distance_unit":"sample string 4","address_string":"sample string 5"},{"latitude":1.1,"longitude":2.1,"radius":3,"distance_unit":"sample string 4","address_string":"sample string 5"}]},"price":2.0,"percentageCut":3,"pageId":"sample string 4","adType":1,"inputId":"sample string 5","description":"sample string 6","message":"sample string 7","name":"sample string 8","creativeType":"sample string 9","productSetId":10,"endDate":"2024-04-20T04:55:46.9919031+00:00","charge_id":"sample string 12","subscriptionId":"sample string 13","subscriptionPeriodStart":"2024-04-20T04:55:46.9919031+00:00","subscriptionPeriodEnd":"2024-04-20T04:55:46.9919031+00:00","adAccountId":"sample string 14","filter":"sample string 15","catalogId":16}

application/xml, text/xml

Sample:

<DynamicAdPurchaseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NPlay.Common.Models.Services">
  <AdAccountId>sample string 14</AdAccountId>
  <AdType>Post</AdType>
  <AgentId>1</AgentId>
  <CatalogId>16</CatalogId>
  <Charge_id>sample string 12</Charge_id>
  <CreativeDescription>sample string 6</CreativeDescription>
  <CreativeMessage>sample string 7</CreativeMessage>
  <CreativeName>sample string 8</CreativeName>
  <CreativeType>sample string 9</CreativeType>
  <EndDate>2024-04-20T04:55:46.9919031+00:00</EndDate>
  <Filter>sample string 15</Filter>
  <GeoLocations xmlns:d2p1="http://schemas.datacontract.org/2004/07/NPlay.Common.Models">
    <d2p1:custom_locations>
      <d2p1:CustomLocation>
        <d2p1:address_string>sample string 5</d2p1:address_string>
        <d2p1:distance_unit>sample string 4</d2p1:distance_unit>
        <d2p1:latitude>1.1</d2p1:latitude>
        <d2p1:longitude>2.1</d2p1:longitude>
        <d2p1:radius>3</d2p1:radius>
      </d2p1:CustomLocation>
      <d2p1:CustomLocation>
        <d2p1:address_string>sample string 5</d2p1:address_string>
        <d2p1:distance_unit>sample string 4</d2p1:distance_unit>
        <d2p1:latitude>1.1</d2p1:latitude>
        <d2p1:longitude>2.1</d2p1:longitude>
        <d2p1:radius>3</d2p1:radius>
      </d2p1:CustomLocation>
    </d2p1:custom_locations>
  </GeoLocations>
  <InputId>sample string 5</InputId>
  <PageId>sample string 4</PageId>
  <PercentageCut>3</PercentageCut>
  <Price>2</Price>
  <ProductSetId>10</ProductSetId>
  <SubscriptionId>sample string 13</SubscriptionId>
  <SubscriptionPeriodEnd>2024-04-20T04:55:46.9919031+00:00</SubscriptionPeriodEnd>
  <SubscriptionPeriodStart>2024-04-20T04:55:46.9919031+00:00</SubscriptionPeriodStart>
</DynamicAdPurchaseModel>

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

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.