POST api/WebOrder/Serviceability/Session/Update

Request Information

URI Parameters

None.

Body Parameters

ServiceabilitySession
NameDescriptionTypeAdditional information
SessionID

string

None.

Address

string

None.

Apt

string

None.

Zipcode

string

None.

HasError

boolean

None.

IsExistingCustomer

boolean

None.

IsZipServiceable

boolean

None.

IsNotServiceable

boolean

None.

HasMultipleAddressMatches

boolean

None.

ConvertedToWebOrder

boolean

None.

C1OrderID

string

None.

IsExactMatch

boolean

None.

IsManualAddress

boolean

None.

StandardizedAddress

string

None.

HasApartmentUnits

boolean

None.

IsZipMappedToHomesPassed

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "sessionID": "sample string 1",
  "address": "sample string 2",
  "apt": "sample string 3",
  "zipcode": "sample string 4",
  "hasError": true,
  "isExistingCustomer": true,
  "isZipServiceable": true,
  "isNotServiceable": true,
  "hasMultipleAddressMatches": true,
  "convertedToWebOrder": true,
  "c1OrderID": "sample string 5",
  "isExactMatch": true,
  "isManualAddress": true,
  "standardizedAddress": "sample string 6",
  "hasApartmentUnits": true,
  "isZipMappedToHomesPassed": true
}

text/html

Sample:
{"sessionID":"sample string 1","address":"sample string 2","apt":"sample string 3","zipcode":"sample string 4","hasError":true,"isExistingCustomer":true,"isZipServiceable":true,"isNotServiceable":true,"hasMultipleAddressMatches":true,"convertedToWebOrder":true,"c1OrderID":"sample string 5","isExactMatch":true,"isManualAddress":true,"standardizedAddress":"sample string 6","hasApartmentUnits":true,"isZipMappedToHomesPassed":true}

application/xml, text/xml

Sample:
<ServiceabilitySession xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WWW.CableOne.ShoppingCartBusinessEntities">
  <Address>sample string 2</Address>
  <Apt>sample string 3</Apt>
  <C1OrderID>sample string 5</C1OrderID>
  <ConvertedToWebOrder>true</ConvertedToWebOrder>
  <HasApartmentUnits>true</HasApartmentUnits>
  <HasError>true</HasError>
  <HasMultipleAddressMatches>true</HasMultipleAddressMatches>
  <IsExactMatch>true</IsExactMatch>
  <IsExistingCustomer>true</IsExistingCustomer>
  <IsManualAddress>true</IsManualAddress>
  <IsNotServiceable>true</IsNotServiceable>
  <IsZipMappedToHomesPassed>true</IsZipMappedToHomesPassed>
  <IsZipServiceable>true</IsZipServiceable>
  <SessionID>sample string 1</SessionID>
  <StandardizedAddress>sample string 6</StandardizedAddress>
  <Zipcode>sample string 4</Zipcode>
</ServiceabilitySession>

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

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>