Sentinel VoLTE 3.0.0 :: Sentinel VoLTE Provisioning REST API

Resource SIP Service Configuration

Resource	SIP Service Configuration
Workspace	Sentinel Services
Path	/sipserviceconfiguration

Resource

SIP Service Configuration

Workspace

Sentinel Services

Path

/sipserviceconfiguration

Operations

Operation	Retrieve a list of sub-resources offered by this resource
Request Method	GET
Path	/sipserviceconfiguration
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

/sipserviceconfiguration

Parameters

Request Body

Not used

Success Result

200 OK

Response Headers

None

Response Body

Feature

/sipserviceconfiguration/plmnids

Operation	Retrieve a listing of SIP Service Configuration PLMN IDs entries
Request Method	GET
Path	/sipserviceconfiguration/plmnids
Parameters	rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM) 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	SIPServiceConfigurationPlmnIdss

Operation

Retrieve a listing of SIP Service Configuration PLMN IDs entries

Request Method

GET

Path

/sipserviceconfiguration/plmnids

Parameters

rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM)
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

SIPServiceConfigurationPlmnIdss

Operation	Create a new SIP Service Configuration PLMN IDs entry
Request Method	POST
Path	/sipserviceconfiguration/plmnids
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	SIPServiceConfigurationPlmnIds
Success Result	201 Created
Response Headers	Location — contains the URL to access the created record
Response Body	Not used

Operation

Create a new SIP Service Configuration PLMN IDs entry

Request Method

POST

Path

/sipserviceconfiguration/plmnids

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

SIPServiceConfigurationPlmnIds

Success Result

201 Created

Response Headers

Location — contains the URL to access the created record

Response Body

Not used

Operation	Retrieve an existing SIP Service Configuration PLMN IDs entry
Request Method	GET
Path	/sipserviceconfiguration/plmnids/{mCC}
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	SIPServiceConfigurationPlmnIds

Operation

Retrieve an existing SIP Service Configuration PLMN IDs entry

Request Method

GET

Path

/sipserviceconfiguration/plmnids/{mCC}

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

SIPServiceConfigurationPlmnIds

Operation	Update an existing SIP Service Configuration PLMN IDs entry
Request Method	PUT
Path	/sipserviceconfiguration/plmnids/{mCC}
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	SIPServiceConfigurationPlmnIds
Success Result	204 No content
Response Headers	None
Response Body	Not used

Operation

Update an existing SIP Service Configuration PLMN IDs entry

Request Method

PUT

Path

/sipserviceconfiguration/plmnids/{mCC}

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

SIPServiceConfigurationPlmnIds

Success Result

204 No content

Response Headers

None

Response Body

Not used

Operation	Delete an existing SIP Service Configuration PLMN IDs entry
Request Method	DELETE
Path	/sipserviceconfiguration/plmnids/{mCC}
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 SIP Service Configuration PLMN IDs entry

Request Method

DELETE

Path

/sipserviceconfiguration/plmnids/{mCC}

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

/sipserviceconfiguration/config

Operation	Create a new SIP Service Configuration Config entry
Request Method	POST
Path	/sipserviceconfiguration/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	SIPServiceConfigurationConfig
Success Result	201 Created
Response Headers	Location — contains the URL to access the created record
Response Body	Not used

Operation

Create a new SIP Service Configuration Config entry

Request Method

POST

Path

/sipserviceconfiguration/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

SIPServiceConfigurationConfig

Success Result

201 Created

Response Headers

Location — contains the URL to access the created record

Response Body

Not used

Operation	Retrieve an existing SIP Service Configuration Config entry or a listing of SIP Service Configuration Config entries
Request Method	GET
Path	/sipserviceconfiguration/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: SIPServiceConfigurationConfig Otherwise: SIPServiceConfigurationConfigs

Operation

Retrieve an existing SIP Service Configuration Config entry or a listing of SIP Service Configuration Config entries

Request Method

GET

Path

/sipserviceconfiguration/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: SIPServiceConfigurationConfig Otherwise: SIPServiceConfigurationConfigs

Operation	Update an existing SIP Service Configuration Config entry
Request Method	PUT
Path	/sipserviceconfiguration/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	SIPServiceConfigurationConfig
Success Result	204 No content
Response Headers	None
Response Body	Not used

Operation

Update an existing SIP Service Configuration Config entry

Request Method

PUT

Path

/sipserviceconfiguration/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

SIPServiceConfigurationConfig

Success Result

204 No content

Response Headers

None

Response Body

Not used

Operation	Delete an existing SIP Service Configuration Config entry
Request Method	DELETE
Path	/sipserviceconfiguration/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 SIP Service Configuration Config entry

Request Method

DELETE

Path

/sipserviceconfiguration/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

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>

SIPServiceConfigurationPlmnIdss

Class: com.opencloud.sentinel.rest.server.resources.sipserviceconfiguration.SIPServiceConfigurationPlmnIdsResource$SIPServiceConfigurationPlmnIdss

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="link" type="LinkType"/>

  <xs:element name="sIPServiceConfigurationPlmnIds" type="SIPServiceConfigurationPlmnIdssEntryType"/>

  <xs:element name="sIPServiceConfigurationPlmnIdss" type="SIPServiceConfigurationPlmnIdssType"/>

  <xs:complexType name="SIPServiceConfigurationPlmnIdssType">
    <xs:sequence>
      <xs:element ref="sIPServiceConfigurationPlmnIds" 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="SIPServiceConfigurationPlmnIdssEntryType">
    <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>

SIPServiceConfigurationPlmnIds

Class: com.opencloud.sentinel.provisioning.sipserviceconfiguration.SIPServiceConfigurationPlmnIds

JSON

{
  "type" : "object",
  "properties" : {
    "mCC" : {
      "type" : "string"
    },
    "mNCs" : {
      "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="sIPServiceConfigurationPlmnIds" type="SIPServiceConfigurationPlmnIdsType"/>

  <xs:complexType name="SIPServiceConfigurationPlmnIdsType">
    <xs:sequence>
      <xs:element name="mCC" type="xs:string" minOccurs="0"/>
      <xs:element name="mNCs" nillable="true" 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>

SIPServiceConfigurationConfig

Class: com.opencloud.sentinel.provisioning.sipserviceconfiguration.SIPServiceConfigurationConfig

JSON

{
  "type" : "object",
  "properties" : {
    "homeNetworkIDs" : {
      "type" : "array",
      "items" : {
        "type" : "string"
      }
    },
    "maxEventDeliveryCycles" : {
      "type" : "integer"
    },
    "icscfUri" : {
      "type" : "string"
    },
    "iSOCode" : {
      "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="sIPServiceConfigurationConfig" type="SIPServiceConfigurationConfigType"/>

  <xs:complexType name="SIPServiceConfigurationConfigType">
    <xs:sequence>
      <xs:element name="homeNetworkIDs" 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="maxEventDeliveryCycles" type="xs:int"/>
      <xs:element name="icscfUri" type="xs:string" nillable="true" minOccurs="0"/>
      <xs:element name="iSOCode" type="xs:string" minOccurs="0"/>
    </xs:sequence>
  </xs:complexType>
</xs:schema>

SIPServiceConfigurationConfigs

Class: com.opencloud.sentinel.rest.server.resources.sipserviceconfiguration.SIPServiceConfigurationConfigResource$SIPServiceConfigurationConfigs

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="link" type="LinkType"/>

  <xs:element name="sIPServiceConfigurationConfig" type="SIPServiceConfigurationConfigsEntryType"/>

  <xs:element name="sIPServiceConfigurationConfigs" type="SIPServiceConfigurationConfigsType"/>

  <xs:complexType name="SIPServiceConfigurationConfigsType">
    <xs:sequence>
      <xs:element ref="sIPServiceConfigurationConfig" 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="SIPServiceConfigurationConfigsEntryType">
    <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>

Previous page Next page

SIP Service Configuration REST API

Resource SIP Service Configuration

Operations

/sipserviceconfiguration/plmnids

/sipserviceconfiguration/config

Schemas

Feature

JSON

XML

SIPServiceConfigurationPlmnIdss

JSON

XML

SIPServiceConfigurationPlmnIds

JSON

XML

SIPServiceConfigurationConfig

JSON

XML

SIPServiceConfigurationConfigs

JSON

XML