POST api/WebOrder/ServiceabilityInfo/Save?id={id}&hash={hash}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | string |
Required |
|
| hash | string |
Required |
Body Parameters
ServiceabilityInfo| Name | Description | Type | Additional information |
|---|---|---|---|
| StreetAddress | string |
None. |
|
| ApartmentUnit | string |
None. |
|
| ZipCode | string |
None. |
|
| StreetNumber | integer |
None. |
|
| StreetName | string |
None. |
|
| City | string |
None. |
|
| State | string |
None. |
|
| InterestedServices | Collection of ServiceType |
None. |
|
| CustomerType | string |
None. |
|
| OC | integer |
None. |
|
| FTA | integer |
None. |
|
| HomesPassedId | integer |
None. |
|
| DwellingCode | string |
None. |
|
| AerialUnderground | string |
None. |
|
| NodeId | string |
None. |
|
| ScheduleArea | string |
None. |
|
| IsMappedAddress | boolean |
None. |
|
| SelfInstallEligible | boolean |
None. |
|
| MarketArea | integer |
None. |
|
| IsComplete | boolean |
None. |
|
| HasErrors | boolean |
None. |
|
| Errors | Collection of string |
None. |
Request Formats
application/json, text/json
Sample:
{
"streetAddress": "sample string 1",
"apartmentUnit": "sample string 2",
"zipCode": "sample string 3",
"streetNumber": 1,
"streetName": "sample string 4",
"city": "sample string 5",
"state": "sample string 6",
"interestedServices": [
{
"name": "sample string 1",
"displayName": "sample string 2",
"isSelected": true,
"imgUrl": "sample string 4"
},
{
"name": "sample string 1",
"displayName": "sample string 2",
"isSelected": true,
"imgUrl": "sample string 4"
}
],
"customerType": "sample string 7",
"oc": 8,
"fta": 9,
"homesPassedId": 10,
"dwellingCode": "sample string 11",
"aerialUnderground": "sample string 12",
"nodeId": "sample string 13",
"scheduleArea": "sample string 14",
"isMappedAddress": true,
"selfInstallEligible": true,
"marketArea": 1,
"isComplete": true,
"hasErrors": true,
"errors": [
"sample string 1",
"sample string 2"
]
}
text/html
Sample:
{"streetAddress":"sample string 1","apartmentUnit":"sample string 2","zipCode":"sample string 3","streetNumber":1,"streetName":"sample string 4","city":"sample string 5","state":"sample string 6","interestedServices":[{"name":"sample string 1","displayName":"sample string 2","isSelected":true,"imgUrl":"sample string 4"},{"name":"sample string 1","displayName":"sample string 2","isSelected":true,"imgUrl":"sample string 4"}],"customerType":"sample string 7","oc":8,"fta":9,"homesPassedId":10,"dwellingCode":"sample string 11","aerialUnderground":"sample string 12","nodeId":"sample string 13","scheduleArea":"sample string 14","isMappedAddress":true,"selfInstallEligible":true,"marketArea":1,"isComplete":true,"hasErrors":true,"errors":["sample string 1","sample string 2"]}
application/xml, text/xml
Sample:
<ServiceabilityInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WWW.CableOne.ShoppingCartBusinessEntities">
<Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</Errors>
<HasErrors>true</HasErrors>
<IsComplete>true</IsComplete>
<AerialUnderground>sample string 12</AerialUnderground>
<ApartmentUnit>sample string 2</ApartmentUnit>
<City>sample string 5</City>
<CustomerType>sample string 7</CustomerType>
<DwellingCode>sample string 11</DwellingCode>
<FTA>9</FTA>
<HomesPassedId>10</HomesPassedId>
<InterestedServices>
<ServiceType>
<DisplayName>sample string 2</DisplayName>
<ImgUrl>sample string 4</ImgUrl>
<IsSelected>true</IsSelected>
<Name>sample string 1</Name>
</ServiceType>
<ServiceType>
<DisplayName>sample string 2</DisplayName>
<ImgUrl>sample string 4</ImgUrl>
<IsSelected>true</IsSelected>
<Name>sample string 1</Name>
</ServiceType>
</InterestedServices>
<IsMappedAddress>true</IsMappedAddress>
<MarketArea>1</MarketArea>
<NodeId>sample string 13</NodeId>
<OC>8</OC>
<ScheduleArea>sample string 14</ScheduleArea>
<SelfInstallEligible>true</SelfInstallEligible>
<State>sample string 6</State>
<StreetAddress>sample string 1</StreetAddress>
<StreetName>sample string 4</StreetName>
<StreetNumber>1</StreetNumber>
<ZipCode>sample string 3</ZipCode>
</ServiceabilityInfo>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
JsonResponseResult| Name | Description | Type | Additional 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>