API Catalog

Retrieve Region Lists By Code

25 Sep 2024
1 Minute to read

Print
Dark
Light

Retrieve Region Lists By Code

Updated on 25 Sep 2024
1 Minute to read

Print
Dark
Light

Article summary

Did you find this summary helpful?

Thank you for your feedback

Get

/sys-rest-api/rest/1/gtregion

Query Standards

Finder

Following row finders are available for data filtering and optimizing request performance.

Select by Reg Name
Select by Reg Code
By UUID

Select by Region Name

Recommended finder parameters. Refer to Query Parameters for example.

Parameters

Parameter	Description	Sample
regName	Name of the region	California

Select by Region Code

This is an optional finder for querying Regions by their Code.

Parameters

Parameter	Description	Sample
regCode	Code of the region	AL

By UUID

This is an optional finder for querying a specific Region rate by row ID.

Parameter	Description	Sample
/VUUID	The VUuid attribute is the Unique row ID	placeholder

Security

HTTP

Type basic

Basic authentication

Query parameters

finder

string

ExampleselectByRegCode; regionCode=AL

limit

integer

Example500

offset

integer

Example0

totalResults

boolean

Exampletrue

orderBy

string

ExampleorderBy=RegCode:desc

Responses

200

Headers

Content-Type

string

Exampleapplication/vnd.oracle.adf.resourcecollection+json

example-0

Successful Response - Finder - selectByRegName

{
  "items": [
    {
      "RegCode": "CA",
      "RegName": "California",
      "RegComplianceCode": null,
      "RegVUuid": "D0A47915ECFC5D7AE05316821FAC6D84",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/gtregion/D0A47915ECFC5D7AE05316821FAC6D84",
          "name": "gtregion",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/gtregion/D0A47915ECFC5D7AE05316821FAC6D84",
          "name": "gtregion",
          "kind": "item"
        }
      ]
    }
  ],
  "count": 1,
  "hasMore": false,
  "limit": 5,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/gtregion",
      "name": "gtregion",
      "kind": "collection"
    }
  ]
}

example-1

Successful Response - Finder - selectByRegCode

{
  "items": [
    {
      "RegCode": "AL",
      "RegName": "Alabama",
      "RegComplianceCode": null,
      "RegVUuid": "D0A47915ECF85D7AE05316821FAC6D84",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/gtregion/D0A47915ECF85D7AE05316821FAC6D84",
          "name": "gtregion",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/gtregion/D0A47915ECF85D7AE05316821FAC6D84",
          "name": "gtregion",
          "kind": "item"
        }
      ]
    }
  ],
  "count": 1,
  "hasMore": false,
  "limit": 5,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/gtregion",
      "name": "gtregion",
      "kind": "collection"
    }
  ]
}

object

What's Next

Delete a Specific Region

Retrieve Region Lists By Code

Query Standards

Finder

Select by Region Name

Parameters

Select by Region Code

Parameters

By UUID

What's Next

Contact Us