Resource SIP Play Announcement

Resource

SIP Play Announcement

Workspace

Sentinel Services

Path

/sipplayannouncement

Operations

Operation

Retrieve a list of sub-resources offered by this resource

Request Method

GET

Path

/sipplayannouncement

Parameters

Request Body

Not used

Success Result

200 OK

Response Headers

None

Response Body

/sipplayannouncement/sipannouncements/config

Operation

Retrieve a listing of SIP Play Announcement Announcement Config entries

Request Method

GET

Path

/sipplayannouncement/sipannouncements/config

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

Operation

Create a new SIP Play Announcement Announcement Config entry

Request Method

POST

Path

/sipplayannouncement/sipannouncements/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

Success Result

201 Created

Response Headers

Location — contains the URL to access the created record

Response Body

Not used

Operation

Retrieve an existing SIP Play Announcement Announcement Config entry

Request Method

GET

Path

/sipplayannouncement/sipannouncements/config/{id}

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 an existing SIP Play Announcement Announcement Config entry

Request Method

PUT

Path

/sipplayannouncement/sipannouncements/config/{id}

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 an existing SIP Play Announcement Announcement Config entry

Request Method

DELETE

Path

/sipplayannouncement/sipannouncements/config/{id}

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

/sipplayannouncement/resources

Operation

Retrieve a listing of SIP Play Announcement Resource Config entries

Request Method

GET

Path

/sipplayannouncement/resources

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

Operation

Create a new SIP Play Announcement Resource Config entry

Request Method

POST

Path

/sipplayannouncement/resources

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 SIP Play Announcement Resource Config entry

Request Method

GET

Path

/sipplayannouncement/resources/{resourceId}

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 an existing SIP Play Announcement Resource Config entry

Request Method

PUT

Path

/sipplayannouncement/resources/{resourceId}

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 an existing SIP Play Announcement Resource Config entry

Request Method

DELETE

Path

/sipplayannouncement/resources/{resourceId}

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>

SipPlayAnnouncementSipAnnouncements

Class: com.opencloud.sentinel.rest.server.resources.sipplayannouncement.SipPlayAnnouncementSipAnnouncementResource$SipPlayAnnouncementSipAnnouncements

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="sipPlayAnnouncementSipAnnouncement" type="SipPlayAnnouncementSipAnnouncementsEntryType"/>

  <xs:element name="sipPlayAnnouncementSipAnnouncements" type="SipPlayAnnouncementSipAnnouncementsType"/>

  <xs:complexType name="SipPlayAnnouncementSipAnnouncementsType">
    <xs:sequence>
      <xs:element ref="sipPlayAnnouncementSipAnnouncement" 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="SipPlayAnnouncementSipAnnouncementsEntryType">
    <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>

SipPlayAnnouncementSipAnnouncement

Class: com.opencloud.sentinel.provisioning.sipplayannouncement.SipPlayAnnouncementSipAnnouncement

JSON
{
  "type" : "object",
  "properties" : {
    "id" : {
      "type" : "integer"
    },
    "description" : {
      "type" : "string"
    },
    "announcementURL" : {
      "type" : "string"
    },
    "delay" : {
      "type" : "integer"
    },
    "duration" : {
      "type" : "integer"
    },
    "locale" : {
      "type" : "string"
    },
    "mimeType" : {
      "type" : "string"
    },
    "repeat" : {
      "type" : "integer"
    },
    "resourceConfig" : {
      "type" : "string"
    },
    "interruptable" : {
      "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="sipPlayAnnouncementSipAnnouncement" type="SipPlayAnnouncementSipAnnouncementType"/>

  <xs:complexType name="SipPlayAnnouncementSipAnnouncementType">
    <xs:sequence>
      <xs:element name="id" type="xs:int"/>
      <xs:element name="description" type="xs:string" nillable="true" minOccurs="0"/>
      <xs:element name="announcementURL" type="xs:string" nillable="true" minOccurs="0"/>
      <xs:element name="delay" type="xs:int"/>
      <xs:element name="duration" type="xs:int"/>
      <xs:element name="locale" type="xs:string" nillable="true" minOccurs="0"/>
      <xs:element name="mimeType" type="xs:string" nillable="true" minOccurs="0"/>
      <xs:element name="repeat" type="xs:int"/>
      <xs:element name="resourceConfig" type="xs:string" nillable="true" minOccurs="0"/>
      <xs:element name="interruptable" type="xs:boolean"/>
    </xs:sequence>
  </xs:complexType>
</xs:schema>

SipPlayAnnouncementResourceConfigs

Class: com.opencloud.sentinel.rest.server.resources.sipplayannouncement.SipPlayAnnouncementResourceConfigResource$SipPlayAnnouncementResourceConfigs

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="sipPlayAnnouncementResourceConfig" type="SipPlayAnnouncementResourceConfigsEntryType"/>

  <xs:element name="sipPlayAnnouncementResourceConfigs" type="SipPlayAnnouncementResourceConfigsType"/>

  <xs:complexType name="SipPlayAnnouncementResourceConfigsType">
    <xs:sequence>
      <xs:element ref="sipPlayAnnouncementResourceConfig" 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="SipPlayAnnouncementResourceConfigsEntryType">
    <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>

SipPlayAnnouncementResourceConfig

Class: com.opencloud.sentinel.provisioning.sipplayannouncement.SipPlayAnnouncementResourceConfig

JSON
{
  "type" : "object",
  "properties" : {
    "resourceId" : {
      "type" : "string"
    },
    "mediaServerURI" : {
      "type" : "string"
    },
    "routeDirectToResource" : {
      "type" : "boolean",
      "required" : true
    },
    "serviceParameterType" : {
      "type" : "string"
    },
    "noResponseTimeout" : {
      "type" : "number"
    },
    "iCSCFURI" : {
      "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="sipPlayAnnouncementResourceConfig" type="SipPlayAnnouncementResourceConfigType"/>

  <xs:complexType name="SipPlayAnnouncementResourceConfigType">
    <xs:sequence>
      <xs:element name="resourceId" type="xs:string" minOccurs="0"/>
      <xs:element name="mediaServerURI" type="xs:string" minOccurs="0"/>
      <xs:element name="routeDirectToResource" type="xs:boolean"/>
      <xs:element name="serviceParameterType" type="xs:string" nillable="true" minOccurs="0"/>
      <xs:element name="noResponseTimeout" type="xs:long"/>
      <xs:element name="iCSCFURI" type="xs:string" nillable="true" minOccurs="0"/>
    </xs:sequence>
  </xs:complexType>
</xs:schema>
Previous page Next page