Platform | Region
Service to manage entities of type 'Region'.
Overview
URL | api/{tenantKey}/{orgKey}/corePatterns/regions |
Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
- GET:
- POST:
- PUT:
- DELETE:
All Resources
This service uses the following resources:
All Enumerations
This service uses the following enumerations:
GET Regions (odata)
Returns a page of the list of all the entity records available.
The following elements are optional:
opts | (ODataQueryOptions) OData query option. |
Response:
When successful, the response body contains the list of records available. See RegionResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET Region by identifier
Returns the entity record that matches the specified identifier.
The following elements are required:
id | (string) The record identifier. |
Response:
When successful, the response body contains the entity record. See RegionResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
GET Region by key
Returns the entity record that matches the specified key.
The following elements are required:
regionKey | (string) The region’s key. |
Response:
When successful, the response body contains the entity record. See RegionResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
POST Regions
Creates a new entity record.
The following elements are required:
regionResource | (ApiRegionResource) The request body should contain the entity record that should be created. See ApiRegionResource. |
Response:
When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiRegionResource. |
Response status codes:
201 | Created. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Country Region
Updates the value of attribute 'Country' in the specified entity record.
The following elements are required:
regionKey | (string) The region’s key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Culture Region
Updates the value of attribute 'Culture' in the specified entity record.
The following elements are required:
regionKey | (string) The region’s key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set IsActive Region
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
regionKey | (string) The region’s key. |
value | (bool) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
PUT Set Name Region
Updates the value of attribute 'Name' in the specified entity record.
The following elements are required:
regionKey | (string) The region’s key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set RegionKey Region
Updates the value of attribute 'RegionKey' in the specified entity record.
The following elements are required:
regionKey | (string) The region’s key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set TimeZones Region
Updates the value of attribute 'TimeZones' in the specified entity record.
The following elements are required:
regionKey | (string) The region’s key. |
value | (enum UTCTimeZone) The request body should contain the new value for the attribute. See UTCTimeZone. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
DELETE Region by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
id | (string) The record identifier. |
Response:
When successful, the response body is empty. |
Response status codes:
204 | Deleted. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
DELETE Region by key
Deletes the entity record that matches the specified key.
The following elements are required:
regionKey | (string) The region’s key. |
Response:
When successful, the response body is empty. |
Response status codes:
204 | Deleted. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
Resources
ApiRegionResource
The following elements are required:
regionKey | (string) The region’s key. |
name | (string) The region’s name. |
country | (string) The region’s country. |
The following elements are optional:
culture | (string) The region’s culture. |
timeZones | (enum UTCTimeZone) The region’s time zones.
See UTCTimeZone. |
RegionResource
The following elements are required:
regionKey | (string) The region’s key. |
name | (string) The region’s name. |
country | (string) The region’s country.
(fk) Allowed value: the natural key of a record of type Country. These records are accessibly through the Countries service. |
The following elements are optional:
culture | (string) The region’s culture.
(fk) Allowed value: the natural key of a record of type Culture. These records are accessibly through the Cultures service. |
timeZones | (enum UTCTimeZone) The region’s time zones.
See UTCTimeZone. |
Enumerations
UTCTimeZone
1 | UTC12L | UTC-12. |
2 | UTC11L | UTC-11. |
3 | UTC10L | UTC-10. |
4 | UTC9L | UTC-9. |
5 | UTC8L | UTC-8. |
6 | UTC7L | UTC-7. |
7 | UTC6L | UTC-6. |
8 | UTC5L | UTC-5. |
10 | UTC430L | UTC-4:30. |
11 | UTC4L | UTC-4. |
12 | UTC330L | UTC-3:30. |
13 | UTC3L | UTC-3. |
14 | UTC2L | UTC-2. |
15 | UTC1L | UTC-1. |
16 | UTC0 | GMT. |
17 | UTC1M | UTC+1. |
18 | UTC2M | UTC+2. |
19 | UTC3M | UTC+3. |
20 | UTC330M | UTC+3:30. |
21 | UTC4M | UTC+4. |
22 | UTC430M | UTC+4:30. |
23 | UTC5M | UTC+5. |
24 | UTC530M | UTC+5:30. |
25 | UTC545M | UTC+5:45. |
26 | UTC6M | UTC+6. |
27 | UTC630M | UTC+6:30. |
28 | UTC7M | UTC+7. |
29 | UTC8M | UTC+8. |
30 | UTC9M | UTC+9. |
31 | UTC930M | UTC+9:30. |
32 | UTC10M | UTC+10. |
33 | UTC11M | UTC+11. |
34 | UTC12M | UTC+12. |
35 | UTC1245M | UTC+12:45. |
36 | UTC13M | UTC+13. |
37 | UTC14M | UTC+14. |