Region Configurations

Creates a new region configuration record that does not already exist.

This method will auto-generate an ID and create a new region configuration. If an ID is specified for the region configuration, an error will be thrown.

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The id of the tenant being accessed.

Request Body schema: application/json

The region configuration that you would like to be saved.

name required	string (Name) The name of the region configuration
default_region_id	string (Default Region) The default region id to use
	Array of objects
notes	string (Notes) Any notes about this configuration
sys_version	number <float> (Sys Version) A number representing the version of this record in the database
sys_created_at required	string <date-time> (Sys Created At) The date/time that this record was created, expressed in ISO-8601 date format
sys_last_modified_at required	string <date-time> (Sys Last Modified At) The date/time that this record record was last modified, expressed in ISO-8601 date format
sys_created_by_id required	string (Sys Created By) The ID of the user that created this record
sys_last_modified_by_id required	string (Sys Last Modified By) The ID of the user that last modified this record
sys_external_id	string (Sys External) The ID that a record has from an external system or data import
sys_locked	boolean (Sys Locked) If set, this record is locked and cannot be changed via the API
sys_bulk_load_id	string (Sys Bulk Load) If this record was loaded via bulk, the ID of the bulk load process
sys_bulk_load_record_no	number <float> (Sys Bulk Load Record No) If this record was loaded via bulk, the record number in the source file
sys_bulk_load_source_file	string (Sys Bulk Load Source File) If this record was loaded via bulk, the source file
sys_directive	string (Sys Directive) Means for passing directive information into an object processing logic

Responses

200The region configuration was saved successfully.

400The region configuration you supplied was invalid.

401Unauthorized.

403Forbidden.

409The region configuration could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to add region configuration based on tenant limits.

500General server error.

post/regionConfigurations/{tenantId}

Request samples

application/json

{"name": "string",
"default_region_id": "string",
"zones": [{"id": "string",
"enabled": true,
"name": "string",
"type": "postal code",
"postal_code_ranges": [{"start": "string",
"end": "string"
}
],
"states": [{"state": "string"
}
],
"countries": [{"country": "string"
}
],
"region_id": "string"
}
],
"notes": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_directive": "string"
}

Response samples

application/json

{"name": "string",
"default_region_id": "string",
"zones": [{"id": "string",
"enabled": true,
"name": "string",
"type": "postal code",
"postal_code_ranges": [{"start": "string",
"end": "string"
}
],
"states": [{"state": "string"
}
],
"countries": [{"country": "string"
}
],
"region_id": "string"
}
],
"notes": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_directive": "string"
}

Returns a region configuration from the system by its ID.

This method will look up a region configuration by the specified ID and return it back.

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The id of the tenant being accessed.

query Parameters

fields	string The fields that you want to retrieve; if omitted, the entire object is returned.
consistentRead	string Indicates the API should force a consistent read on the data source.

Responses

200The region configuration was retrieved successfully.

400The request was not valid.

401Unauthorized.

403Forbidden.

404The region configuration could not be found.

429Limit exceeded... unable to retrieve region configuration based on tenant limits.

500General server error.

get/regionConfigurations/{tenantId}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://rolodex.api.756794052567.rhythmsoftware.com/regionConfigurations/:tenantId?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"name": "string",
"default_region_id": "string",
"zones": [{"id": "string",
"enabled": true,
"name": "string",
"type": "postal code",
"postal_code_ranges": [{"start": "string",
"end": "string"
}
],
"states": [{"state": "string"
}
],
"countries": [{"country": "string"
}
],
"region_id": "string"
}
],
"notes": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_directive": "string"
}

Updates a region configuration with the specified ID.

This method will update an existing region configuration with the specified ID.

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The id of the tenant being accessed.

Request Body schema: application/json

The updated region configuration that will be saved.

name required	string (Name) The name of the region configuration
default_region_id	string (Default Region) The default region id to use
	Array of objects
notes	string (Notes) Any notes about this configuration
sys_version	number <float> (Sys Version) A number representing the version of this record in the database
sys_created_at required	string <date-time> (Sys Created At) The date/time that this record was created, expressed in ISO-8601 date format
sys_last_modified_at required	string <date-time> (Sys Last Modified At) The date/time that this record record was last modified, expressed in ISO-8601 date format
sys_created_by_id required	string (Sys Created By) The ID of the user that created this record
sys_last_modified_by_id required	string (Sys Last Modified By) The ID of the user that last modified this record
sys_external_id	string (Sys External) The ID that a record has from an external system or data import
sys_locked	boolean (Sys Locked) If set, this record is locked and cannot be changed via the API
sys_bulk_load_id	string (Sys Bulk Load) If this record was loaded via bulk, the ID of the bulk load process
sys_bulk_load_record_no	number <float> (Sys Bulk Load Record No) If this record was loaded via bulk, the record number in the source file
sys_bulk_load_source_file	string (Sys Bulk Load Source File) If this record was loaded via bulk, the source file
sys_directive	string (Sys Directive) Means for passing directive information into an object processing logic

Responses

200The region configuration was updated successfully.

400The region configuration supplied was not valid.

401Unauthorized.

403Forbidden.

404The region configuration could not be found.

409The region configuration could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to retrieve region configuration based on tenant limits.

500General server error.

put/regionConfigurations/{tenantId}

Request samples

application/json

{"name": "string",
"default_region_id": "string",
"zones": [{"id": "string",
"enabled": true,
"name": "string",
"type": "postal code",
"postal_code_ranges": [{"start": "string",
"end": "string"
}
],
"states": [{"state": "string"
}
],
"countries": [{"country": "string"
}
],
"region_id": "string"
}
],
"notes": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_directive": "string"
}

Response samples

application/json

{"name": "string",
"default_region_id": "string",
"zones": [{"id": "string",
"enabled": true,
"name": "string",
"type": "postal code",
"postal_code_ranges": [{"start": "string",
"end": "string"
}
],
"states": [{"state": "string"
}
],
"countries": [{"country": "string"
}
],
"region_id": "string"
}
],
"notes": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_directive": "string"
}

Partially updates a region configuration with the specified ID.

This method will patch an existing region configuration with the specified ID, using the HTTP PATCH specification.

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The id of the tenant being accessed.

Request Body schema: application/json

The patch directives conforming to RFC 6902.

Array

op required	string (Op) The operation Enum: "add" "remove" "replace" "move" "copy" "test"
path required	string (Path) The JSON path
value	string (Value) The updated value

Responses

200The region configuration was patched successfully.

400The JSON patch directive you supplied was not valid.

401Unauthorized.

403Forbidden.

404The region configuration could not be found.

409The region configuration could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to retrieve region configuration based on tenant limits.

500General server error.

patch/regionConfigurations/{tenantId}

Request samples

application/json

[{"op": "add",
"path": "string",
"value": "string"
}
]

Response samples

application/json

{"name": "string",
"default_region_id": "string",
"zones": [{"id": "string",
"enabled": true,
"name": "string",
"type": "postal code",
"postal_code_ranges": [{"start": "string",
"end": "string"
}
],
"states": [{"state": "string"
}
],
"countries": [{"country": "string"
}
],
"region_id": "string"
}
],
"notes": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_directive": "string"
}

Returns a region configuration from the system by its ID.

This method will delete a region configuration with the specified ID.

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The id of the tenant being accessed.

Responses

200The region configuration was deleted successfully.

400The request was not valid.

401Unauthorized.

403Forbidden.

404The region configuration could not be found.

409The region configuration could not be deleted because other objects refers to/depends on this one.

429Limit exceeded... unable to delete region configuration based on tenant limits.

500General server error.

delete/regionConfigurations/{tenantId}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X DELETE \
  https://rolodex.api.756794052567.rhythmsoftware.com/regionConfigurations/:tenantId \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

"string"