REST API - PUT Modify Region
This operation updates an existing zone or adds a new zone for a specific region.
Note: The city and state name must match the zone that you want to update. If they do not match, then a new zone is created in the same region.
Request
Syntax
Send the request using either XML or JSON:
- XML
PUT <webservice>/Regions/{regionId}
Accept: {application/xml | application/json}
Authtoken: <authentication token>
Content-type: application/xml
<update_region_template.xml> - JSON
PUT <webservice>/Regions/{regionId}
Accept: {application/xml | application/json}
Authtoken: <authentication token>
Content-type: application/json
<update_region_template.json>
where <webservice> is the root path used to route the API requests to the Web Server.
For more information, see Available Web Services for REST API.
Request Headers
Name |
Description |
Accept |
The format of the response. Valid values are: application/xml or application/json. |
Authtoken |
The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication. |
Content-type |
The media type contained in the request body. |
Request Body
Download the XML or JSON file required for this request: update_region_template.xml or update_region_template.json. The following table displays the parameters for the request body.
Parameter |
Description |
Element |
regionName |
Name of the new region. |
regionEntity |
continent |
Continent of the new region. |
zone |
country |
Country of the new region. |
zone |
state |
State of the new region. |
zone |
city |
City of the new region. |
zone |
latitude |
Latitude of the new region. |
zone |
longitude |
Longitude of the new region. |
zone |
zoneName |
Zone name of the new region. |
zoneEntity |
Response
Response Parameters
Parameter |
Description |
Element |
regionId |
The ID of the new region. |
regionEntity |
regionName |
The name of the new region. |
regionEntity |
errorCode |
The possible error codes. Valid values are:
|
Api_GenericResp |
errorMessage |
The description of the error code. Not all error codes have an error message. |
Api_GenericResp |
Examples
Example Request
PUT <webservice>/Regions/{regionId}
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Content-type: application/xml
<root>
<regionEntity>
<regionName>regionTemp</regionName>
</regionEntity>
<zones>
<zone>
<continent></continent>
<country>usa</country>
<state>FL</state>
<city>Orlando</city>
<latitude>28.53</latitude>
<longitude>81.37</longitude>
<zoneEntity>
<zoneName>Orlando_FL_usa</zoneName>
</zoneEntity>
</zone>
</zones>
</root>
Example Response
<Api_RegionResp>
<regions>
<regionEntity regionId="74" regionName="regionTemp" />
</regions>
<error errorMessage="" errorCode="0" />
</Api_RegionResp>
Last modified: 9/1/2020 8:38:29 PM