PATCH api/site/{id}/freeminutes
This method adds Free Minute Plans, via the Free Minute Plan ID, to the specified site. This method has two parameters, both of them are optional, but at least one of them needs to be supplied
If the user wants to add a new Free Minute Plan they will have to do a GET to get the list of current plans, amend the new one and then do a PATCH. If the user wants to remove all Free Minute Plans assigned to a site they will have to set TakeFromPackage to false and pass a blank list of PlanIDs. However, if TakeFromPackage is still set to true only the Free Minute Plans that do not come from the Package will be removed. Note that only CPs can use this method.
Error messages
- 404/NotFound:Site with id = X not found
- 404/NotFound: validateText
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | The unique identifer for the Site. | integer |
Required |
Body Parameters
SiteFreeMinutes| Name | Description | Type | Additional information |
|---|---|---|---|
| PlanIds | This is a list of Free Minute Plan IDs for this site. It should only be supplied if TakeFromPackage is False. | Collection of integer |
None. |
| TakeFromPackage | This is a Boolean field that indicates whether the Free Minute Plans for this site should be taken from the Package assigned to the site. | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"PlanIds": [
1,
2
],
"TakeFromPackage": true
}
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
None.