POST api/Contracts/CreateContract

Request Information

URI Parameters

None.

Body Parameters

ContractInfo
NameDescriptionTypeAdditional information
web_order_id

string

None.

web_token_number

string

None.

operating_center

string

None.

franchise_tax_area

string

None.

top_level_offer_name

string

None.

hsd_product

string

None.

video_product

string

None.

phone_product

string

None.

contract_code

string

None.

contract_name

string

None.

contract_fee

decimal number

None.

regular_fee

decimal number

None.

contract_month

integer

None.

early_termination_fee

decimal number

None.

etf_reduced_by_fee_monthly

decimal number

None.

company

string

None.

customer_type

string

None.

contract_template

string

None.

enable_bundle_discount

boolean

None.

sales_reason

string

None.

hsd_promotion_code

string

None.

hsd_promotion

string

None.

phone_promotion_code

string

None.

phone_promotion

string

None.

video_promotion_code

string

None.

video_promotion

string

None.

contract_status

string

None.

Request Formats

application/json, text/json

Sample:
{
  "web_order_id": "sample string 1",
  "web_token_number": "sample string 2",
  "operating_center": "sample string 3",
  "franchise_tax_area": "sample string 4",
  "top_level_offer_name": "sample string 5",
  "hsd_product": "sample string 6",
  "video_product": "sample string 7",
  "phone_product": "sample string 8",
  "contract_code": "sample string 9",
  "contract_name": "sample string 10",
  "contract_fee": 11.1,
  "regular_fee": 12.1,
  "contract_month": 13,
  "early_termination_fee": 14.1,
  "etf_reduced_by_fee_monthly": 15.1,
  "company": "sample string 16",
  "customer_type": "sample string 17",
  "contract_template": "sample string 18",
  "enable_bundle_discount": true,
  "sales_reason": "sample string 20",
  "hsd_promotion_code": "sample string 21",
  "hsd_promotion": "sample string 22",
  "phone_promotion_code": "sample string 23",
  "phone_promotion": "sample string 24",
  "video_promotion_code": "sample string 25",
  "video_promotion": "sample string 26",
  "contract_status": "sample string 27"
}

text/html

Sample:
{"web_order_id":"sample string 1","web_token_number":"sample string 2","operating_center":"sample string 3","franchise_tax_area":"sample string 4","top_level_offer_name":"sample string 5","hsd_product":"sample string 6","video_product":"sample string 7","phone_product":"sample string 8","contract_code":"sample string 9","contract_name":"sample string 10","contract_fee":11.1,"regular_fee":12.1,"contract_month":13,"early_termination_fee":14.1,"etf_reduced_by_fee_monthly":15.1,"company":"sample string 16","customer_type":"sample string 17","contract_template":"sample string 18","enable_bundle_discount":true,"sales_reason":"sample string 20","hsd_promotion_code":"sample string 21","hsd_promotion":"sample string 22","phone_promotion_code":"sample string 23","phone_promotion":"sample string 24","video_promotion_code":"sample string 25","video_promotion":"sample string 26","contract_status":"sample string 27"}

application/xml, text/xml

Sample:
<ContractInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WWW.CableOne.ShoppingCartBusinessEntities.BussinessEntities.Contracts">
  <company>sample string 16</company>
  <contract_code>sample string 9</contract_code>
  <contract_fee>11.1</contract_fee>
  <contract_month>13</contract_month>
  <contract_name>sample string 10</contract_name>
  <contract_status>sample string 27</contract_status>
  <contract_template>sample string 18</contract_template>
  <customer_type>sample string 17</customer_type>
  <early_termination_fee>14.1</early_termination_fee>
  <enable_bundle_discount>true</enable_bundle_discount>
  <etf_reduced_by_fee_monthly>15.1</etf_reduced_by_fee_monthly>
  <franchise_tax_area>sample string 4</franchise_tax_area>
  <hsd_product>sample string 6</hsd_product>
  <hsd_promotion>sample string 22</hsd_promotion>
  <hsd_promotion_code>sample string 21</hsd_promotion_code>
  <operating_center>sample string 3</operating_center>
  <phone_product>sample string 8</phone_product>
  <phone_promotion>sample string 24</phone_promotion>
  <phone_promotion_code>sample string 23</phone_promotion_code>
  <regular_fee>12.1</regular_fee>
  <sales_reason>sample string 20</sales_reason>
  <top_level_offer_name>sample string 5</top_level_offer_name>
  <video_product>sample string 7</video_product>
  <video_promotion>sample string 26</video_promotion>
  <video_promotion_code>sample string 25</video_promotion_code>
  <web_order_id>sample string 1</web_order_id>
  <web_token_number>sample string 2</web_token_number>
</ContractInfo>

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

Response Information

Resource Description

JsonResponseResult
NameDescriptionTypeAdditional information
Success

boolean

None.

Message

string

None.

ContentEncoding

Encoding

None.

ContentType

string

None.

Data

Object

None.

JsonRequestBehavior

JsonRequestBehavior

None.

MaxJsonLength

integer

None.

RecursionLimit

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "success": true,
  "message": "sample string 2",
  "contentEncoding": null,
  "contentType": "sample string 3",
  "data": {},
  "jsonRequestBehavior": 0,
  "maxJsonLength": 1,
  "recursionLimit": 1
}

text/html

Sample:
{"success":true,"message":"sample string 2","contentEncoding":null,"contentType":"sample string 3","data":{},"jsonRequestBehavior":0,"maxJsonLength":1,"recursionLimit":1}

application/xml, text/xml

Sample:
<JsonResponseResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WWW.CableOne.ShoppingCartUtilities">
  <ContentEncoding xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.Text" i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/System.Web.Mvc" />
  <ContentType xmlns="http://schemas.datacontract.org/2004/07/System.Web.Mvc">sample string 3</ContentType>
  <Data xmlns="http://schemas.datacontract.org/2004/07/System.Web.Mvc" />
  <JsonRequestBehavior xmlns="http://schemas.datacontract.org/2004/07/System.Web.Mvc">AllowGet</JsonRequestBehavior>
  <MaxJsonLength xmlns="http://schemas.datacontract.org/2004/07/System.Web.Mvc">1</MaxJsonLength>
  <RecursionLimit xmlns="http://schemas.datacontract.org/2004/07/System.Web.Mvc">1</RecursionLimit>
  <Message>sample string 2</Message>
  <Success>true</Success>
</JsonResponseResult>