Resource HSS Data and Data Configuration

Resource

HSS Data and Data Configuration

Workspace

VoLTE Services

Path

/hssdata

Operations

Operation

Retrieve a list of sub-resources offered by this resource

Request Method

GET

Path

/hssdata

Parameters

Request Body

Not used

Success Result

200 OK

Response Headers

None

Response Body

/hssdata/sessionstatefieldmappings

Operation

Retrieve the existing HSS subscriber data session state field mappings

Request Method

GET

Path

/hssdata/sessionstatefieldmappings

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

Operation

Update the existing HSS subscriber data session state field mappings

Request Method

PUT

Path

/hssdata/sessionstatefieldmappings

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

Success Result

204 No content

Response Headers

None

Response Body

Not used

Operation

Delete the existing HSS subscriber data session state field mappings

Request Method

DELETE

Path

/hssdata/sessionstatefieldmappings

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 HSS subscriber data field mappings set

Request Method

POST

Path

/hssdata/sessionstatefieldmappings

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

Success Result

201 Created

Response Headers

Location — contains the URL to access the created record

Response Body

Not used

/hssdata/provisioningfieldmappings

Operation

Retrieve the existing HSS subscriber data field mappings

Request Method

GET

Path

/hssdata/provisioningfieldmappings

Parameters

  • rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM)

  • networkOperator — the network operator scope to use

Request Body

Not used

Success Result

200 OK

Response Headers

None

Response Body

Operation

Update the existing HSS subscriber data field mappings

Request Method

PUT

Path

/hssdata/provisioningfieldmappings

Parameters

  • rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM)

  • networkOperator — the network operator scope to use

Request Body

Success Result

204 No content

Response Headers

None

Response Body

Not used

Operation

Delete the existing HSS subscriber data field mappings

Request Method

DELETE

Path

/hssdata/provisioningfieldmappings

Parameters

  • rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM)

  • networkOperator — the network operator scope to use

Request Body

Not used

Success Result

204 No content

Response Headers

None

Response Body

Not used

Operation

Create a new HSS subscriber data field mappings set

Request Method

POST

Path

/hssdata/provisioningfieldmappings

Parameters

  • rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM)

  • networkOperator — the network operator scope to use

Request Body

Success Result

201 Created

Response Headers

Location — contains the URL to access the created record

Response Body

Not used

/hssdata/subscriberdata

Operation

Create new subscriber data

Request Method

POST

Path

/hssdata/subscriberdata

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

Success Result

201 Created

Response Headers

Location — contains the URL to access the created record

Response Body

Not used

Operation

Retrieve an existing subscriber data record

Request Method

GET

Path

/hssdata/subscriberdata/{imsUserIdentity}

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

200 OK

Response Headers

None

Response Body

Operation

Update an existing subscriber data record

Request Method

PUT

Path

/hssdata/subscriberdata/{imsUserIdentity}

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

Success Result

204 No content

Response Headers

None

Response Body

Not used

Operation

Delete existing subscriber data

Request Method

DELETE

Path

/hssdata/subscriberdata/{imsUserIdentity}

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>

HssSubscriberDataSessionStateMappingSet

Class: com.opencloud.volte.sentinel.provisioning.hssdata.HssSubscriberDataSessionStateMappingSet

JSON
{
  "type" : "object",
  "properties" : {
    "mappingGroups" : {
      "type" : "array",
      "items" : {
        "type" : "object",
        "properties" : {
          "serviceIndication" : {
            "type" : "string"
          },
          "serviceDataCodecClass" : {
            "type" : "string"
          },
          "fieldMappings" : {
            "type" : "array",
            "items" : {
              "type" : "object",
              "properties" : {
                "sessionStateFieldName" : {
                  "type" : "string"
                },
                "xPath" : {
                  "type" : "string"
                },
                "rootElementName" : {
                  "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="hssSubscriberDataSessionStateFieldMapping" type="HssSubscriberDataSessionStateFieldMappingType"/>

  <xs:element name="hssSubscriberDataSessionStateMappingGroup" type="HssSubscriberDataSessionStateMappingGroupType"/>

  <xs:element name="hssSubscriberDataSessionStateMappingSet" type="HssSubscriberDataSessionStateMappingSetType"/>

  <xs:complexType name="HssSubscriberDataSessionStateMappingSetType">
    <xs:sequence>
      <xs:element name="mappingGroups" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element ref="hssSubscriberDataSessionStateMappingGroup" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="HssSubscriberDataSessionStateMappingGroupType">
    <xs:sequence>
      <xs:element name="serviceIndication" type="xs:string"/>
      <xs:element name="serviceDataCodecClass" type="xs:string" nillable="true" minOccurs="0"/>
      <xs:element name="fieldMappings" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element ref="hssSubscriberDataSessionStateFieldMapping" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="HssSubscriberDataSessionStateFieldMappingType">
    <xs:sequence>
      <xs:element name="sessionStateFieldName" type="xs:string"/>
      <xs:element name="xPath" type="xs:string"/>
      <xs:element name="rootElementName" type="xs:string"/>
    </xs:sequence>
  </xs:complexType>
</xs:schema>

SubscriberDataFieldSetDto

Class: com.opencloud.volte.sentinel.provisioning.hssdata.SubscriberDataFieldSetDto

JSON
{
  "type" : "object",
  "properties" : {
    "fieldGroups" : {
      "type" : "array",
      "items" : {
        "type" : "object",
        "properties" : {
          "serviceIndication" : {
            "type" : "string"
          },
          "serviceDataClass" : {
            "type" : "string"
          },
          "serviceDataCodecClass" : {
            "type" : "string"
          },
          "jxpathFactoryClass" : {
            "type" : "string"
          },
          "fieldMappings" : {
            "type" : "array",
            "items" : {
              "type" : "object",
              "properties" : {
                "name" : {
                  "type" : "string"
                },
                "type" : {
                  "type" : "string"
                },
                "description" : {
                  "type" : "string"
                },
                "xPath" : {
                  "type" : "string"
                },
                "required" : {
                  "type" : "boolean",
                  "required" : true
                }
              }
            }
          }
        }
      }
    }
  }
}
XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">

  <xs:element name="fieldMapping" type="SubscriberDataFieldMappingType"/>

  <xs:element name="subscriberDataFieldGroup" type="SubscriberDataFieldGroupType"/>

  <xs:element name="subscriberDataFieldSet" type="SubscriberDataFieldSetType"/>

  <xs:complexType name="SubscriberDataFieldSetType">
    <xs:sequence>
      <xs:element name="fieldGroups" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element ref="subscriberDataFieldGroup" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="SubscriberDataFieldGroupType">
    <xs:sequence>
      <xs:element name="serviceIndication" type="xs:string"/>
      <xs:element name="serviceDataClass" type="xs:string"/>
      <xs:element name="serviceDataCodecClass" type="xs:string" nillable="true" minOccurs="0"/>
      <xs:element name="jxpathFactoryClass" type="xs:string" nillable="true" minOccurs="0"/>
      <xs:element name="fieldMappings" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element ref="fieldMapping" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="SubscriberDataFieldMappingType">
    <xs:sequence>
      <xs:element name="name" type="xs:string"/>
      <xs:element name="type" type="xs:string"/>
      <xs:element name="description" type="xs:string" nillable="true" minOccurs="0"/>
      <xs:element name="xPath" type="xs:string"/>
      <xs:element name="required" type="xs:boolean"/>
    </xs:sequence>
  </xs:complexType>
</xs:schema>

HssSubscriberData

Class: com.opencloud.volte.sentinel.provisioning.hssdata.HssSubscriberData

JSON
{
  "type" : "object",
  "properties" : {
    "identity" : {
      "type" : "string"
    },
    "fieldGroups" : {
      "type" : "array",
      "items" : {
        "type" : "object",
        "properties" : {
          "serviceIndication" : {
            "type" : "string"
          },
          "fields" : {
            "type" : "array",
            "items" : {
              "type" : "object",
              "properties" : {
                "name" : {
                  "type" : "string"
                },
                "value" : {
                  "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="field" type="HssSubscriberDataFieldType"/>

  <xs:element name="fieldGroup" type="HssSubscriberDataFieldGroupType"/>

  <xs:element name="hssSubscriberData" type="HssSubscriberDataType"/>

  <xs:complexType name="HssSubscriberDataType">
    <xs:sequence>
      <xs:element name="identity" type="xs:string"/>
      <xs:element name="fieldGroups" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element ref="fieldGroup" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="HssSubscriberDataFieldGroupType">
    <xs:sequence>
      <xs:element name="serviceIndication" type="xs:string"/>
      <xs:element name="fields" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element ref="field" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="HssSubscriberDataFieldType">
    <xs:sequence>
      <xs:element name="name" type="xs:string"/>
      <xs:element name="value" type="xs:string" nillable="true" minOccurs="0"/>
    </xs:sequence>
  </xs:complexType>
</xs:schema>
Previous page Next page