Sentinel VoLTE 2.7.0 :: Sentinel VoLTE Provisioning REST API

Resource Home Zone

Resource	Home Zone
Workspace	Sentinel Services
Path	/homezone

Resource

Home Zone

Workspace

Sentinel Services

Path

/homezone

Operations

Operation	Retrieve a list of sub-resources offered by this resource
Request Method	GET
Path	/homezone
Parameters
Request Body	Not used
Success Result	200 OK
Response Headers	None
Response Body	Feature

Operation

Retrieve a list of sub-resources offered by this resource

Request Method

GET

Path

/homezone

Parameters

Request Body

Not used

Success Result

200 OK

Response Headers

None

Response Body

Feature

/homezone/sqlconfig

Operation	Update an existing Home Zone SQL Config entry
Request Method	PUT
Path	/homezone/sqlconfig
Parameters	rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM) selectionKey — the Sentinel selection key scope to use
Request Body	HomeZoneSql
Success Result	204 No content
Response Headers	None
Response Body	Not used

Operation

Update an existing Home Zone SQL Config entry

Request Method

PUT

Path

/homezone/sqlconfig

Parameters

rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM)
selectionKey — the Sentinel selection key scope to use

Request Body

HomeZoneSql

Success Result

204 No content

Response Headers

None

Response Body

Not used

Operation	Delete an existing Home Zone SQL Config entry
Request Method	DELETE
Path	/homezone/sqlconfig
Parameters	rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM) selectionKey — the Sentinel selection key scope to use
Request Body	Not used
Success Result	204 No content
Response Headers	None
Response Body	Not used

Operation

Delete an existing Home Zone SQL Config entry

Request Method

DELETE

Path

/homezone/sqlconfig

Parameters

rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM)
selectionKey — the Sentinel selection key scope to use

Request Body

Not used

Success Result

204 No content

Response Headers

None

Response Body

Not used

Operation	Create a new Home Zone SQL Config entry
Request Method	POST
Path	/homezone/sqlconfig
Parameters	rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM) selectionKey — the Sentinel selection key scope to use
Request Body	HomeZoneSql
Success Result	201 Created
Response Headers	Location — contains the URL to access the created record
Response Body	Not used

Operation

Create a new Home Zone SQL Config entry

Request Method

POST

Path

/homezone/sqlconfig

Parameters

rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM)
selectionKey — the Sentinel selection key scope to use

Request Body

HomeZoneSql

Success Result

201 Created

Response Headers

Location — contains the URL to access the created record

Response Body

Not used

Operation	Retrieve an existing Home Zone SQL Config entry or a listing of Home Zone SQL Config entries
Request Method	GET
Path	/homezone/sqlconfig
Parameters	rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM) selectionKey — the Sentinel selection key scope to use page — the page to retrieve if results span multiple pages (default = 1 if not provided)
Request Body	Not used
Success Result	200 OK
Response Headers	None
Response Body	If scope is provided: HomeZoneSql Otherwise: HomeZoneSqls

Operation

Retrieve an existing Home Zone SQL Config entry or a listing of Home Zone SQL Config entries

Request Method

GET

Path

/homezone/sqlconfig

Parameters

rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM)
selectionKey — the Sentinel selection key scope to use
page — the page to retrieve if results span multiple pages (default = 1 if not provided)

Request Body

Not used

Success Result

200 OK

Response Headers

None

Response Body

If scope is provided: HomeZoneSql Otherwise: HomeZoneSqls

/homezone/config

Operation	Create a new Home Zone Config entry
Request Method	POST
Path	/homezone/config
Parameters	rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM) selectionKey — the Sentinel selection key scope to use
Request Body	HomeZoneConfig
Success Result	201 Created
Response Headers	Location — contains the URL to access the created record
Response Body	Not used

Operation

Create a new Home Zone Config entry

Request Method

POST

Path

/homezone/config

Parameters

rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM)
selectionKey — the Sentinel selection key scope to use

Request Body

HomeZoneConfig

Success Result

201 Created

Response Headers

Location — contains the URL to access the created record

Response Body

Not used

Operation	Retrieve an existing Home Zone Config entry or a listing of Home Zone Config entries
Request Method	GET
Path	/homezone/config
Parameters	rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM) selectionKey — the Sentinel selection key scope to use page — the page to retrieve if results span multiple pages (default = 1 if not provided)
Request Body	Not used
Success Result	200 OK
Response Headers	None
Response Body	If scope is provided: HomeZoneConfig Otherwise: HomeZoneConfigs

Operation

Retrieve an existing Home Zone Config entry or a listing of Home Zone Config entries

Request Method

GET

Path

/homezone/config

Parameters

rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM)
selectionKey — the Sentinel selection key scope to use
page — the page to retrieve if results span multiple pages (default = 1 if not provided)

Request Body

Not used

Success Result

200 OK

Response Headers

None

Response Body

If scope is provided: HomeZoneConfig Otherwise: HomeZoneConfigs

Operation	Update an existing Home Zone Config entry
Request Method	PUT
Path	/homezone/config
Parameters	rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM) selectionKey — the Sentinel selection key scope to use
Request Body	HomeZoneConfig
Success Result	204 No content
Response Headers	None
Response Body	Not used

Operation

Update an existing Home Zone Config entry

Request Method

PUT

Path

/homezone/config

Parameters

rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM)
selectionKey — the Sentinel selection key scope to use

Request Body

HomeZoneConfig

Success Result

204 No content

Response Headers

None

Response Body

Not used

Operation	Delete an existing Home Zone Config entry
Request Method	DELETE
Path	/homezone/config
Parameters	rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM) selectionKey — the Sentinel selection key scope to use
Request Body	Not used
Success Result	204 No content
Response Headers	None
Response Body	Not used

Operation

Delete an existing Home Zone Config entry

Request Method

DELETE

Path

/homezone/config

Parameters

rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM)
selectionKey — the Sentinel selection key scope to use

Request Body

Not used

Success Result

204 No content

Response Headers

None

Response Body

Not used

/homezone/zones

Operation	Retrieve a listing of home zone zones
Request Method	GET
Path	/homezone/zones
Parameters	rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM) selectionKey — the Sentinel selection key scope to use page — the page to retrieve if results span multiple pages (default = 1 if not provided)
Request Body	Not used
Success Result	200 OK
Response Headers	None
Response Body	HomeZoneZones

Operation

Retrieve a listing of home zone zones

Request Method

GET

Path

/homezone/zones

Parameters

rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM)
selectionKey — the Sentinel selection key scope to use
page — the page to retrieve if results span multiple pages (default = 1 if not provided)

Request Body

Not used

Success Result

200 OK

Response Headers

None

Response Body

HomeZoneZones

Operation	Create a new home zone zone
Request Method	POST
Path	/homezone/zones
Parameters	rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM) selectionKey — the Sentinel selection key scope to use
Request Body	HomeZoneZone
Success Result	201 Created
Response Headers	Location — contains the URL to access the created record
Response Body	Not used

Operation

Create a new home zone zone

Request Method

POST

Path

/homezone/zones

Parameters

rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM)
selectionKey — the Sentinel selection key scope to use

Request Body

HomeZoneZone

Success Result

201 Created

Response Headers

Location — contains the URL to access the created record

Response Body

Not used

Operation	Retrieve an existing home zone zone config
Request Method	GET
Path	/homezone/zones/{name}
Parameters	rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM) selectionKey — the Sentinel selection key scope to use page — the page to retrieve if results span multiple pages (default = 1 if not provided)
Request Body	Not used
Success Result	200 OK
Response Headers	None
Response Body	HomeZoneZone

Operation

Retrieve an existing home zone zone config

Request Method

GET

Path

/homezone/zones/{name}

Parameters

rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM)
selectionKey — the Sentinel selection key scope to use
page — the page to retrieve if results span multiple pages (default = 1 if not provided)

Request Body

Not used

Success Result

200 OK

Response Headers

None

Response Body

HomeZoneZone

Operation	Update an existing home zone zone config
Request Method	PUT
Path	/homezone/zones/{name}
Parameters	rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM) selectionKey — the Sentinel selection key scope to use
Request Body	HomeZoneZone
Success Result	204 No content
Response Headers	None
Response Body	Not used

Operation

Update an existing home zone zone config

Request Method

PUT

Path

/homezone/zones/{name}

Parameters

rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM)
selectionKey — the Sentinel selection key scope to use

Request Body

HomeZoneZone

Success Result

204 No content

Response Headers

None

Response Body

Not used

Operation	Delete an existing home zone zone
Request Method	DELETE
Path	/homezone/zones/{name}
Parameters	rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM) selectionKey — the Sentinel selection key scope to use
Request Body	Not used
Success Result	204 No content
Response Headers	None
Response Body	Not used

Operation

Delete an existing home zone zone

Request Method

DELETE

Path

/homezone/zones/{name}

Parameters

rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM)
selectionKey — the Sentinel selection key scope to use

Request Body

Not used

Success Result

204 No content

Response Headers

None

Response Body

Not used

Schemas

Feature

Class: com.opencloud.sentinel.rest.common.Feature

JSON

{
  "type" : "object",
  "properties" : {
    "name" : {
      "type" : "string"
    },
    "resources" : {
      "type" : "array",
      "items" : {
        "type" : "object",
        "properties" : {
          "rel" : {
            "type" : "string"
          },
          "href" : {
            "type" : "string"
          },
          "title" : {
            "type" : "string"
          }
        }
      }
    }
  }
}

XML

<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">

  <xs:element name="feature" type="FeatureType"/>

  <xs:element name="link" type="LinkType"/>

  <xs:complexType name="FeatureType">
    <xs:sequence>
      <xs:element name="name" type="xs:string" minOccurs="0"/>
      <xs:element name="resources" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element ref="link" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="LinkType">
    <xs:sequence/>
    <xs:attribute name="rel" type="xs:string"/>
    <xs:attribute name="href" type="xs:string"/>
    <xs:attribute name="title" type="xs:string"/>
  </xs:complexType>
</xs:schema>

HomeZoneSql

Class: com.opencloud.sentinel.provisioning.homezone.HomeZoneSql

JSON

{
  "type" : "object",
  "properties" : {
    "zoneLookupSQL" : {
      "type" : "string"
    },
    "zoneInsertSQL" : {
      "type" : "string"
    },
    "zoneUpdateSQL" : {
      "type" : "string"
    },
    "zoneDeleteSQL" : {
      "type" : "string"
    },
    "zoneListingSQL" : {
      "type" : "string"
    }
  }
}

XML

<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">

  <xs:element name="homeZoneSql" type="HomeZoneSqlType"/>

  <xs:complexType name="HomeZoneSqlType">
    <xs:sequence>
      <xs:element name="zoneLookupSQL" type="xs:string" minOccurs="0"/>
      <xs:element name="zoneInsertSQL" type="xs:string" minOccurs="0"/>
      <xs:element name="zoneUpdateSQL" type="xs:string" minOccurs="0"/>
      <xs:element name="zoneDeleteSQL" type="xs:string" minOccurs="0"/>
      <xs:element name="zoneListingSQL" type="xs:string" minOccurs="0"/>
    </xs:sequence>
  </xs:complexType>
</xs:schema>

HomeZoneSqls

Class: com.opencloud.sentinel.rest.server.resources.homezone.HomeZoneSqlResource$HomeZoneSqls

JSON

{
  "type" : "object",
  "properties" : {
    "entries" : {
      "type" : "array",
      "items" : {
        "type" : "object",
        "properties" : {
          "name" : {
            "type" : "string"
          },
          "resources" : {
            "type" : "array",
            "items" : {
              "type" : "object",
              "properties" : {
                "rel" : {
                  "type" : "string"
                },
                "href" : {
                  "type" : "string"
                },
                "title" : {
                  "type" : "string"
                }
              }
            }
          },
          "selectionKey" : {
            "type" : "string"
          }
        }
      }
    },
    "next" : {
      "type" : "string"
    },
    "prev" : {
      "type" : "string"
    }
  }
}

XML

<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">

  <xs:element name="homeZoneSql" type="HomeZoneSqlsEntryType"/>

  <xs:element name="homeZoneSqls" type="HomeZoneSqlsType"/>

  <xs:element name="link" type="LinkType"/>

  <xs:complexType name="HomeZoneSqlsType">
    <xs:sequence>
      <xs:element ref="homeZoneSql" minOccurs="0" maxOccurs="unbounded"/>
    </xs:sequence>
    <xs:attribute name="next" type="xs:string"/>
    <xs:attribute name="prev" type="xs:string"/>
  </xs:complexType>

  <xs:complexType name="HomeZoneSqlsEntryType">
    <xs:complexContent>
      <xs:extension base="simpleEntry">
        <xs:sequence>
          <xs:element name="selectionKey" type="xs:string" minOccurs="0"/>
        </xs:sequence>
      </xs:extension>
    </xs:complexContent>
  </xs:complexType>

  <xs:complexType name="simpleEntry" abstract="true">
    <xs:sequence>
      <xs:element name="name" type="xs:string" minOccurs="0"/>
      <xs:element name="resources" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element ref="link" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="LinkType">
    <xs:sequence/>
    <xs:attribute name="rel" type="xs:string"/>
    <xs:attribute name="href" type="xs:string"/>
    <xs:attribute name="title" type="xs:string"/>
  </xs:complexType>
</xs:schema>

HomeZoneConfig

Class: com.opencloud.sentinel.provisioning.homezone.HomeZoneConfig

JSON

{
  "type" : "object",
  "properties" : {
    "lookupType" : {
      "type" : "string"
    }
  }
}

XML

<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">

  <xs:element name="homeZoneConfig" type="HomeZoneConfigType"/>

  <xs:complexType name="HomeZoneConfigType">
    <xs:sequence>
      <xs:element name="lookupType" type="xs:string" minOccurs="0"/>
    </xs:sequence>
  </xs:complexType>
</xs:schema>

HomeZoneConfigs

Class: com.opencloud.sentinel.rest.server.resources.homezone.HomeZoneConfigResource$HomeZoneConfigs

JSON

{
  "type" : "object",
  "properties" : {
    "entries" : {
      "type" : "array",
      "items" : {
        "type" : "object",
        "properties" : {
          "name" : {
            "type" : "string"
          },
          "resources" : {
            "type" : "array",
            "items" : {
              "type" : "object",
              "properties" : {
                "rel" : {
                  "type" : "string"
                },
                "href" : {
                  "type" : "string"
                },
                "title" : {
                  "type" : "string"
                }
              }
            }
          },
          "selectionKey" : {
            "type" : "string"
          }
        }
      }
    },
    "next" : {
      "type" : "string"
    },
    "prev" : {
      "type" : "string"
    }
  }
}

XML

<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">

  <xs:element name="homeZoneConfig" type="HomeZoneConfigsEntryType"/>

  <xs:element name="homeZoneConfigs" type="HomeZoneConfigsType"/>

  <xs:element name="link" type="LinkType"/>

  <xs:complexType name="HomeZoneConfigsType">
    <xs:sequence>
      <xs:element ref="homeZoneConfig" minOccurs="0" maxOccurs="unbounded"/>
    </xs:sequence>
    <xs:attribute name="next" type="xs:string"/>
    <xs:attribute name="prev" type="xs:string"/>
  </xs:complexType>

  <xs:complexType name="HomeZoneConfigsEntryType">
    <xs:complexContent>
      <xs:extension base="simpleEntry">
        <xs:sequence>
          <xs:element name="selectionKey" type="xs:string" minOccurs="0"/>
        </xs:sequence>
      </xs:extension>
    </xs:complexContent>
  </xs:complexType>

  <xs:complexType name="simpleEntry" abstract="true">
    <xs:sequence>
      <xs:element name="name" type="xs:string" minOccurs="0"/>
      <xs:element name="resources" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element ref="link" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="LinkType">
    <xs:sequence/>
    <xs:attribute name="rel" type="xs:string"/>
    <xs:attribute name="href" type="xs:string"/>
    <xs:attribute name="title" type="xs:string"/>
  </xs:complexType>
</xs:schema>

HomeZoneZones

Class: com.opencloud.sentinel.rest.server.resources.homezone.HomeZoneZonesResource$HomeZoneZones

JSON

{
  "type" : "object",
  "properties" : {
    "entries" : {
      "type" : "array",
      "items" : {
        "type" : "object",
        "properties" : {
          "name" : {
            "type" : "string"
          },
          "resources" : {
            "type" : "array",
            "items" : {
              "type" : "object",
              "properties" : {
                "rel" : {
                  "type" : "string"
                },
                "href" : {
                  "type" : "string"
                },
                "title" : {
                  "type" : "string"
                }
              }
            }
          }
        }
      }
    },
    "next" : {
      "type" : "string"
    },
    "prev" : {
      "type" : "string"
    }
  }
}

XML

<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">

  <xs:element name="homeZoneZone" type="HomeZoneZonesEntryType"/>

  <xs:element name="homeZoneZones" type="HomeZoneZonesType"/>

  <xs:element name="link" type="LinkType"/>

  <xs:complexType name="HomeZoneZonesType">
    <xs:sequence>
      <xs:element ref="homeZoneZone" minOccurs="0" maxOccurs="unbounded"/>
    </xs:sequence>
    <xs:attribute name="next" type="xs:string"/>
    <xs:attribute name="prev" type="xs:string"/>
  </xs:complexType>

  <xs:complexType name="HomeZoneZonesEntryType">
    <xs:complexContent>
      <xs:extension base="simpleEntry">
        <xs:sequence/>
      </xs:extension>
    </xs:complexContent>
  </xs:complexType>

  <xs:complexType name="simpleEntry" abstract="true">
    <xs:sequence>
      <xs:element name="name" type="xs:string" minOccurs="0"/>
      <xs:element name="resources" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element ref="link" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="LinkType">
    <xs:sequence/>
    <xs:attribute name="rel" type="xs:string"/>
    <xs:attribute name="href" type="xs:string"/>
    <xs:attribute name="title" type="xs:string"/>
  </xs:complexType>
</xs:schema>

HomeZoneZone

Class: com.opencloud.sentinel.provisioning.homezone.HomeZoneZone

JSON

{
  "type" : "object",
  "properties" : {
    "name" : {
      "type" : "string"
    },
    "locationTypes" : {
      "type" : "array",
      "items" : {
        "type" : "string"
      }
    },
    "mCC" : {
      "type" : "array",
      "items" : {
        "type" : "string"
      }
    },
    "mNC" : {
      "type" : "array",
      "items" : {
        "type" : "string"
      }
    },
    "lAC" : {
      "type" : "array",
      "items" : {
        "type" : "integer"
      }
    },
    "cIOrSAC" : {
      "type" : "array",
      "items" : {
        "type" : "integer"
      }
    },
    "locationDescriptions" : {
      "type" : "array",
      "items" : {
        "type" : "string"
      }
    }
  }
}

XML

<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">

  <xs:element name="homeZoneZone" type="HomeZoneZoneType"/>

  <xs:complexType name="HomeZoneZoneType">
    <xs:sequence>
      <xs:element name="name" type="xs:string" minOccurs="0"/>
      <xs:element name="locationTypes" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="value" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>
      <xs:element name="mCC" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="value" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>
      <xs:element name="mNC" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="value" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>
      <xs:element name="lAC" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="value" type="xs:int" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>
      <xs:element name="cIOrSAC" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="value" type="xs:int" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>
      <xs:element name="locationDescriptions" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="value" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>
    </xs:sequence>
  </xs:complexType>
</xs:schema>

Previous page Next page

Home Zone REST API

Resource Home Zone

Operations

/homezone/sqlconfig

/homezone/config

/homezone/zones

Schemas

Feature

JSON

XML

HomeZoneSql

JSON

XML

HomeZoneSqls

JSON

XML

HomeZoneConfig

JSON

XML

HomeZoneConfigs

JSON

XML

HomeZoneZones

JSON

XML

HomeZoneZone

JSON

XML