POST API/Customer/Subscription?action={action}
Manage Subscription Details Required parameter(s) for Action(s): "Cancel" : objSubscription{SubscriptionId, StartDate, EndDate} "AssignDeliveryBoy" : objSubscription{SubscriptionId, SubscriptionsXML} "Vacation" : objSubscription{SubscriptionId, StartDate, EndDate} "CancelVacation" : objSubscription{SubscriptionId, Comments}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| action |
Cancel/AssignDeliveryBoy/Vacation/CancelVacation |
string |
Required |
Body Parameters
Subscription| Name | Description | Type | Additional information |
|---|---|---|---|
| SubscriptionId | integer |
None. |
|
| StartDate | string |
None. |
|
| EndDate | string |
None. |
|
| Comments | string |
None. |
|
| SubscriptionDetailList | Collection of SubscriptionDetails |
None. |
Request Formats
application/json, text/json
Sample:
{
"subscriptionId": 1,
"startDate": "sample string 1",
"endDate": "sample string 2",
"comments": "sample string 3",
"subscriptionDetailList": [
{
"subscriptionId": 1,
"deliveryBoyId": 1
},
{
"subscriptionId": 1,
"deliveryBoyId": 1
}
]
}
application/xml, text/xml
Sample:
<Subscription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BrownCow.Customer.EntityLayer">
<Comments>sample string 3</Comments>
<EndDate>sample string 2</EndDate>
<StartDate>sample string 1</StartDate>
<SubscriptionDetailList>
<SubscriptionDetails>
<DeliveryBoyId>1</DeliveryBoyId>
<SubscriptionId>1</SubscriptionId>
</SubscriptionDetails>
<SubscriptionDetails>
<DeliveryBoyId>1</DeliveryBoyId>
<SubscriptionId>1</SubscriptionId>
</SubscriptionDetails>
</SubscriptionDetailList>
<SubscriptionId>1</SubscriptionId>
</Subscription>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.