RESTful Application Development Guide

Document Roadmap

Document Scope and Audience

Guide to This Document

Terminology

Related Documentation

Overview of Oracle Communications Services Gatekeeper

Basic Concepts

Communication Services

Traffic Types

Application-initiated Traffic

Network-triggered Traffic

Management Structures

Functional Overview

Application Testing Workflow

Interacting with the RESTful Facade

Format

URI

Header

Service Correlation

Parameter Tunneling

Body

Attachments

Methods

HTTP GET

HTTP POST

HTTP PUT

HTTP DELETE

Authentication and Security

Notifications and Publish/Subscribe

Errors and Exceptions

Session Manager

Operations

Get Session

Request

URI

HTTP Method

Response

Body

Error Response

Get Session Remaining Lifetime

Request

URI

HTTP Method

Response

Body

Error Response

Destroy a Session

Request

URI

HTTP Method

Response

Body

Error Response

Errors

Short Messaging

Operations

Send Sms

Request

URI

Request Content-Type

Body

HTTP Method

Response

Response Content-Type

Body

Header

Error Response

Send Sms Ringtone

Request

URI

Request Content-Type

Body

HTTP Method

Response

Response Content-Type

Body

Header

Error Response

Send Sms Logo

Request

URI

Request Content-Type

Body

HTTP Method

Response

Response Content-Type

Body

Header

Error Response

Get Received Sms

Request

URI

HTTP Method

Response

Response Content-Type

Body

Error Response

Get Sms Delivery Status

Request

URI

HTTP Method

Response

Response Content-Type

Body

Error Response

Start Sms Notification

Request

URI

Request Content-Type

Body

HTTP Method

Response

Header

Error Response

Stop Sms Notification

Request

URI

HTTP Method

Response

Error Response

Notifications and Receipts

Notify Sms Reception

Notify Sms Delivery Receipt

Errors

Multimedia Messaging

Operations

Send Message

Request

URI

Request Content-Type

Message Part Name

Message Part Content-Type

Message Part Content

HTTP Method

Response

Response Content-Type

Body

Header

Error Response

Get Received Messages

Request

URI

Request Content-Type

Body

HTTP Method

Response

Response Content-Type

Body

Error Response

Get Message

Request

URI

HTTP Method

Response

Response Content-Type

Body

Error Response

Get Message Delivery Status

Request

URI

HTTP Method

Response

Response Content-Type

Body

Error Response

Start MMS Notification

Request

URI

Request Context-Type

Body

HTTP Method

Response

Header

Error Response

Stop Message Notification

Request

URI

HTTP Method

Response

Error Response

Notifications and Receipts

Notify Message Reception

Notify Message Delivery Receipt

Errors

Terminal Location

Operations

Get Location

Request

URI

HTTP Method

Response

ResponseContent-Type

Body

Error Response

Get Location For Group

Request

URI

HTTP Method

Response

Response Content-Type

Body

Error Response

Get Terminal Distance

Request

URI

HTTP Method

Response

Response Context-Type

Body

Error Response

Start Geographical Notifications

Request

URI

Request Content-Type

Body

HTTP Method

Response

Header

Error Response

Start Periodic Notification

Request

URI

Request Content-Type

Body

HTTP Method

Response

Header

Error Response

End Notification

Request

URI

HTTP Method

Response

Body

Error Response

Notifications

Location End

Location Error

Location Notification

Errors

Third Party Call

Operations

Make Call

Request

URI

Request Content-Type

Body

HTTP Method

Response

Response Content-Type

Body

Header

Error Response

Get Call Information

Request

URI

Response Content-Type

Body

Error Response

Cancel Call Request

Request

URI

HTTP Method

Response

Body

Error Response

End Call

Request

URI

HTTP Method

Response

Body

Error Response

Errors

Call Notification

Operations

Start Call Notification

Request

URI

Request Content-Type

Body

HTTP Method

Response

Header

Error Response

Stop Call Notification

Request

URI

HTTP Method

Response

Body

Error Response

Start Call Direction Notification

Request

URI

Request Content-Type

Body

HTTP Method

Response

Header

Error Response

Stop Call Direction Notification

Request

URI

HTTP Method

Response

Body

Error Response

Notifications

Notify Called Number

Notify Busy

Notify No Answer

Notify Not Reachable

Handle Called Number

Handle Called Number Response

Handle Busy

HandleBusyResponse

Handle No Answer

Handle No Answer Response

Handle Not Reachable

Handle Not Reachable Response

Errors

Presence

Operations

Get Open Subscriptions

Request

URI

HTTP Method

Response

Response Content-Type

Body

Error Response

Get My Watchers

Request

URI

HTTP Method

Response

Response Content-Type

Body

Error Response

Update Subscription Authorization

Request

URI

Request Content-Type

Body

HTTP Method

Response

Body

Error Response

Subscribe Presence

Request

URI

Request Content-Type

Body

HTTP Method

Response

Body

Error Response

Block Subscription

Request

URI

HTTP Method

Response

Body

Error Response

Start Presence Notification

Request

URI

Request Content-Type

Body

HTTP Method

Response

Response Content-Type

Body

Header

Error Response

End Presence Notification

Request

URI

HTTP Method

Response

Body

Error Response

Get User Presence

Request

URI

HTTP Method

Response

Response Content-Type

Body

Error Response

Publish

Request

URI

Request Content-Type

Body

HTTP Method

Response

Body

Error Response

Notifications

Status Changed

Notify Subscription

Status End

Subscription Ended

Errors

Payment

Operations

Charge Amount

Request

URI

Request Content-Type

Body

HTTP Method

Response

Body

Error Response

Refund Amount

Request

URI

Request Content-Type

Body

HTTP Method

Response

Body

Error Response

Charge Split Amount

Request

URI

Request Content-Type

Body

HTTP Method

Response

Body

Error Response

Reserve Amount

Request

URI

Request Content-Type

Body

HTTP Method

Response

Response Content-Type

Body

Error Response

Reserve Additional Amount

Request

URI

Request Content-Type

Body

HTTP Method

Response

Body

Error Response

Charge Reservation

Request

URI

Request Content-Type

Body

HTTP Method

Response

Body

Error Response

Release Reservation

Request

URI

Request Content-Type

Body

HTTP Method

Response

Body

Error Response

Errors

Subscriber Profile

Operations

Get

Request

URI

HTTP Method

Response

Response Content-Type

Body

Error Response

Get Profile

Request

URI

HTTP Method

Response

Body

Error Response

Errors

WAP Push

Operation

Send Push Message

Request

URI

Request Content-Type

Message Part Name

Message Part Content-Type

Message Part Content

HTTP Method

Response

Response Content-Type

Body

Error Response

Notifications

Result Notification Message

Errors