Serialized Form


Package org.gsm.oneapi.foundation

Class org.gsm.oneapi.foundation.InvalidDateException extends java.lang.Exception implements Serializable

serialVersionUID: 1120070112L


Package org.gsm.oneapi.responsebean

Class org.gsm.oneapi.responsebean.PolicyException extends java.lang.Object implements Serializable

serialVersionUID: -6032985525466832920L

Serialized Fields

messageId

java.lang.String messageId
the distinctive error message identifier


text

java.lang.String text
the textual representation of the error


variables

java.lang.String[] variables
any instance specific error variables

Class org.gsm.oneapi.responsebean.RequestError extends java.lang.Object implements Serializable

serialVersionUID: -4594109872052136844L

Serialized Fields

serviceException

ServiceException serviceException
instance of a ServiceException


policyException

PolicyException policyException
instance of a PolicyException


exceptionType

int exceptionType
the type of exception being stored

Class org.gsm.oneapi.responsebean.RequestErrorWrapper extends java.lang.Object implements Serializable

serialVersionUID: 9071303924345690265L

Serialized Fields

requestError

RequestError requestError
in case of a server error contains the error detail

Class org.gsm.oneapi.responsebean.ResourceReference extends java.lang.Object implements Serializable

serialVersionUID: 3221150938986856655L

Serialized Fields

resourceURL

java.lang.String resourceURL
contains a URL uniquely identifying a successful request to the OneAPI server

Class org.gsm.oneapi.responsebean.ServiceException extends java.lang.Object implements Serializable

serialVersionUID: -5777229181193910571L

Serialized Fields

messageId

java.lang.String messageId
the distinctive error message identifier


text

java.lang.String text
the textual representation of the error


variables

java.lang.String[] variables
any instance specific error variables


Package org.gsm.oneapi.responsebean.location

Class org.gsm.oneapi.responsebean.location.LocationResponse extends java.lang.Object implements Serializable

serialVersionUID: 7757756298813071945L

Serialized Fields

httpResponseCode

int httpResponseCode
contains the HTTP response code returned from the server


contentType

java.lang.String contentType
contains the HTTP Content-Type returned from the server if available


requestError

RequestError requestError
in the case the server has returned an error contains the error response.

See Also:
RequestError

location

java.lang.String location
the contents of the HTTP 'Location' header response if available


terminalLocationList

LocationResponse.TerminalLocationList terminalLocationList
the terminalLocationList contains the actual location responses

Class org.gsm.oneapi.responsebean.location.TerminalLocation extends java.lang.Object implements Serializable

serialVersionUID: 4670687042831841089L

Serialized Fields

address

java.lang.String address
the MSISDN of the mobile terminal


locationRetrievalStatus

java.lang.String locationRetrievalStatus
the status of the location retrieval request - with possible values: "Retrieved" (success), "NotRetrieved" (unable to retrieve), "Error" (error retrieving location)


currentLocation

TerminalLocation.CurrentLocation currentLocation
in case the terminal was successfully located currentLocation contains the location details


errorInformation

TerminalLocation.RequestError errorInformation
in case the terminal was not successfully located contains the errorInformation


Package org.gsm.oneapi.responsebean.mms

Class org.gsm.oneapi.responsebean.mms.DeliveryInfoList extends java.lang.Object implements Serializable

serialVersionUID: 9214265875910218116L

Serialized Fields

deliveryInfo

DeliveryInfoList.DeliveryInfo[] deliveryInfo
the deliveryInfoList object contains the delivery information for each address that you asked to send the message to, in a deliveryInfo array.


resourceURL

java.lang.String resourceURL
resourceURL contains a URL uniquely identifying this DeliveryInfoList request

Class org.gsm.oneapi.responsebean.mms.DeliveryReceiptSubscription extends java.lang.Object implements Serializable

serialVersionUID: -6686234696893939061L

Serialized Fields

callbackReference

DeliveryReceiptSubscription.CallbackReference callbackReference
reference to the inner callbackReference class - the notification URL and user supplied callback data


resourceURL

java.lang.String resourceURL
resourceURL contains a URL uniquely identifying this MMS delivery receipt subscription

Class org.gsm.oneapi.responsebean.mms.InboundMessage extends java.lang.Object implements Serializable

serialVersionUID: -5772672709791289909L

Serialized Fields

dateTime

java.util.Date dateTime
the date/time that the MMS message was sent


destinationAddress

java.lang.String destinationAddress
the recipient MSISDN or other identifying number


messageId

java.lang.String messageId
unique messageId for the message


inboundMMSMessage

InboundMMSMessage inboundMMSMessage
detail of the MMS message - including subject and message body


resourceURL

java.lang.String resourceURL
resourceURL contains a URL uniquely identifying this MMS message


senderAddress

java.lang.String senderAddress
the sender MSISDN or other identifying number

Class org.gsm.oneapi.responsebean.mms.InboundMessageList extends java.lang.Object implements Serializable

serialVersionUID: -1816167056547318579L

Serialized Fields

inboundMessage

InboundMessage[] inboundMessage
The inboundMessageList object contains an inboundMessage array detailing: the dateTime that the message was received, destinationAddress is the number associated with your service (for example an agreed short code, see ÔWhat do I need?Õ above), messageId is a server-generated message identifier, inboundMMSMessage object contains a pair showing the subject of the message, resourceURL is a link to the message. Use these to retrieve the entire message including attachments, senderAddress is the MSISDN or Anonymous Customer Reference of the sender.


numberOfMessagesInThisBatch

java.lang.Integer numberOfMessagesInThisBatch
the number of messages returned for this batch


resourceURL

java.lang.String resourceURL
resourceURL containing a URL uniquely identifying this MMS message list


totalNumberOfPendingMessages

java.lang.Integer totalNumberOfPendingMessages
the totalNumberOfPendingMessages awaiting retrieval from gateway storage

Class org.gsm.oneapi.responsebean.mms.InboundMessageWrapper extends java.lang.Object implements Serializable

serialVersionUID: 2883226244346160536L

Serialized Fields

inboundMessage

InboundMessage inboundMessage
the actual inboundMessage to/from JSON

Class org.gsm.oneapi.responsebean.mms.InboundMMSMessage extends java.lang.Object implements Serializable

serialVersionUID: -5404991946052297352L

Serialized Fields

subject

java.lang.String subject
the subject field for the MMS message


message

java.lang.String message
the MMS message body

Class org.gsm.oneapi.responsebean.mms.MMSDeliveryReceiptSubscriptionResponse extends java.lang.Object implements Serializable

serialVersionUID: -6897641669461218524L

Serialized Fields

httpResponseCode

int httpResponseCode
contains the HTTP response code returned from the server


contentType

java.lang.String contentType
contains the HTTP Content-Type returned from the server if available


requestError

RequestError requestError
in the case the server has returned an error contains the error response.

See Also:
RequestError

location

java.lang.String location
the contents of the HTTP 'Location' header response if available


deliveryReceiptSubscription

DeliveryReceiptSubscription deliveryReceiptSubscription
the deliveryReceiptSubscription response contains a URL identifying the subscription along with callback information (notification URL and callback data)

Class org.gsm.oneapi.responsebean.mms.MMSMessageReceiptSubscriptionResponse extends java.lang.Object implements Serializable

serialVersionUID: -1075057031677539254L

Serialized Fields

httpResponseCode

int httpResponseCode
contains the HTTP response code returned from the server


contentType

java.lang.String contentType
contains the HTTP Content-Type returned from the server if available


requestError

RequestError requestError
in the case the server has returned an error contains the error response.

See Also:
RequestError

location

java.lang.String location
the contents of the HTTP 'Location' header response if available


resourceReference

ResourceReference resourceReference
resourceReference contains a URL uniquely identifying a successful request to create the MMS message receipt subscription

Class org.gsm.oneapi.responsebean.mms.MMSSendDeliveryStatusResponse extends java.lang.Object implements Serializable

serialVersionUID: -4865805357649574546L

Serialized Fields

httpResponseCode

int httpResponseCode
contains the HTTP response code returned from the server


contentType

java.lang.String contentType
contains the HTTP Content-Type returned from the server if available


requestError

RequestError requestError
in the case the server has returned an error contains the error response.

See Also:
RequestError

location

java.lang.String location
the contents of the HTTP 'Location' header response if available


deliveryInfoList

DeliveryInfoList deliveryInfoList
contains a list of one or more message delivery status according to the number of recipients for the MMS message

Class org.gsm.oneapi.responsebean.mms.MMSSendResponse extends java.lang.Object implements Serializable

serialVersionUID: 1746683143328583536L

Serialized Fields

httpResponseCode

int httpResponseCode
contains the HTTP response code returned from the server


contentType

java.lang.String contentType
contains the HTTP Content-Type returned from the server if available


requestError

RequestError requestError
in the case the server has returned an error contains the error response.

See Also:
RequestError

location

java.lang.String location
the contents of the HTTP 'Location' header response if available


resourceReference

ResourceReference resourceReference
resourceReference contains a URL uniquely identifying a successful request to send an MMS message

Class org.gsm.oneapi.responsebean.mms.RetrieveMMSMessageResponse extends java.lang.Object implements Serializable

serialVersionUID: 5555314302096622836L

Serialized Fields

httpResponseCode

int httpResponseCode
contains the HTTP response code returned from the server


contentType

java.lang.String contentType
contains the HTTP Content-Type returned from the server if available


requestError

RequestError requestError
in the case the server has returned an error contains the error response.

See Also:
RequestError

location

java.lang.String location
the contents of the HTTP 'Location' header response if available


inboundMessage

InboundMessage inboundMessage
inboundMessage contains the detail of the MMS message


attachments

java.util.ArrayList<E> attachments
a list of attachments to the MMS message

Class org.gsm.oneapi.responsebean.mms.RetrieveMMSResponse extends java.lang.Object implements Serializable

serialVersionUID: 8629657387805466843L

Serialized Fields

httpResponseCode

int httpResponseCode
contains the HTTP response code returned from the server


contentType

java.lang.String contentType
contains the HTTP Content-Type returned from the server if available


requestError

RequestError requestError
in the case the server has returned an error contains the error response.

See Also:
RequestError

location

java.lang.String location
the contents of the HTTP 'Location' header response if available


inboundMessageList

InboundMessageList inboundMessageList
inboundMessageList contains a count of the number of available MMS messages, and an array of MMS message (headers)


Package org.gsm.oneapi.responsebean.payment

Class org.gsm.oneapi.responsebean.payment.AmountReservationTransaction extends java.lang.Object implements Serializable

serialVersionUID: -8018179657702827920L

Serialized Fields

clientCorrelator

java.lang.String clientCorrelator
the clientCorrelator ensures the same payment request is only applied once


endUserId

java.lang.String endUserId
the MSISDN or Anonymous Caller Reference of the user being charged


referenceCode

java.lang.String referenceCode
is your reference for reconciliation purposes. The operator should include it in reports so that you can match their view of what has been sold with yours by matching the referenceCodes.


referenceSequence

java.lang.Integer referenceSequence
confirms the sequence number for the reservation charging functions. This allows the server to distinguish easily between new and repeated requests in the case of a communication failure.


resourceURL

java.lang.String resourceURL
a server allocated reference URL for this payment request


serverReferenceCode

java.lang.String serverReferenceCode
the server's reference code for this payment request - it must be used in any related payment requests


transactionOperationStatus

java.lang.String transactionOperationStatus
confirmation of the charging operation


paymentAmount

AmountReservationTransaction.PaymentAmount paymentAmount
the detail of the payment/ charge

Class org.gsm.oneapi.responsebean.payment.AmountTransaction extends java.lang.Object implements Serializable

serialVersionUID: -8018179657702827920L

Serialized Fields

clientCorrelator

java.lang.String clientCorrelator
the clientCorrelator ensures the same payment request is only applied once


endUserId

java.lang.String endUserId
the MSISDN or Anonymous Caller Reference of the user being charged


referenceCode

java.lang.String referenceCode
is your reference for reconciliation purposes. The operator should include it in reports so that you can match their view of what has been sold with yours by matching the referenceCodes.


serverReferenceCode

java.lang.String serverReferenceCode
the server's reference code for this payment request - it must be used in any related payment requests


resourceURL

java.lang.String resourceURL
a server allocated reference URL for this payment request


transactionOperationStatus

java.lang.String transactionOperationStatus
confirmation of the charging operation


paymentAmount

AmountTransaction.PaymentAmount paymentAmount
the detail of the payment/ charge

Class org.gsm.oneapi.responsebean.payment.PaymentResponse extends java.lang.Object implements Serializable

serialVersionUID: 1746683143328583536L

Serialized Fields

httpResponseCode

int httpResponseCode
contains the HTTP response code returned from the server


contentType

java.lang.String contentType
contains the HTTP Content-Type returned from the server if available


requestError

RequestError requestError
in the case the server has returned an error contains the error response.

See Also:
RequestError

location

java.lang.String location
the contents of the HTTP 'Location' header response if available


amountTransaction

AmountTransaction amountTransaction
amountTransaction is the response obtained from 'Charge' and 'Refund' payment APIs

See Also:
AmountTransaction, Charge

amountReservationTransaction

AmountReservationTransaction amountReservationTransaction
amountReservationTransaction is the response obtained from 'Reservation' payment APIs

See Also:
AmountReservationTransaction, Reservation

Package org.gsm.oneapi.responsebean.sms

Class org.gsm.oneapi.responsebean.sms.DeliveryInfoList extends java.lang.Object implements Serializable

serialVersionUID: -916640634071165842L

Serialized Fields

deliveryInfo

DeliveryInfoList.DeliveryInfo[] deliveryInfo
the deliveryInfoList object contains the delivery information for each address that you asked to send the message to, in a deliveryInfo array.


resourceURL

java.lang.String resourceURL
resourceURL contains a URL uniquely identifying this DeliveryInfoList request

Class org.gsm.oneapi.responsebean.sms.DeliveryReceiptSubscription extends java.lang.Object implements Serializable

serialVersionUID: 7647416372355131397L

Serialized Fields

callbackReference

DeliveryReceiptSubscription.CallbackReference callbackReference
reference to the inner callbackReference class - the notification URL and user supplied callback data


resourceURL

java.lang.String resourceURL
resourceURL contains a URL uniquely identifying this SMS delivery receipt subscription

Class org.gsm.oneapi.responsebean.sms.InboundSMSMessage extends java.lang.Object implements Serializable

serialVersionUID: -5772672709791289909L

Serialized Fields

dateTime

java.util.Date dateTime
the date/time that the SMS message was sent


destinationAddress

java.lang.String destinationAddress
the recipient MSISDN or other identifying number


messageId

java.lang.String messageId
unique messageId for the message


message

java.lang.String message
content of the SMS message body


resourceURL

java.lang.String resourceURL
resourceReference contains a URL uniquely identifying this SMS message


senderAddress

java.lang.String senderAddress
the sender MSISDN or other identifying number

Class org.gsm.oneapi.responsebean.sms.InboundSMSMessageList extends java.lang.Object implements Serializable

serialVersionUID: -1816167056547318579L

Serialized Fields

inboundSMSMessage

InboundSMSMessage[] inboundSMSMessage
The inboundSMSMessageList object contains an inboundSMSMessage array detailing: the dateTime that the message was received, destinationAddress is the number associated with your service (for example an agreed short code, see ÔWhat do I need?Õ above), messageId is a server-generated message identifier, the message body, resourceURL is a link to the message, senderAddress is the MSISDN or Anonymous Customer Reference of the sender.


numberOfMessagesInThisBatch

java.lang.Integer numberOfMessagesInThisBatch
the number of messages returned for this batch


resourceURL

java.lang.String resourceURL
resourceURL containing a URL uniquely identifying this MMS message list


totalNumberOfPendingMessages

java.lang.Integer totalNumberOfPendingMessages
the totalNumberOfPendingMessages awaiting retrieval from gateway storage

Class org.gsm.oneapi.responsebean.sms.RetrieveSMSResponse extends java.lang.Object implements Serializable

serialVersionUID: 5555314302096622836L

Serialized Fields

httpResponseCode

int httpResponseCode
contains the HTTP response code returned from the server


contentType

java.lang.String contentType
contains the HTTP Content-Type returned from the server if available


requestError

RequestError requestError
in the case the server has returned an error contains the error response.

See Also:
RequestError

location

java.lang.String location
the contents of the HTTP 'Location' header response if available


inboundSMSMessageList

InboundSMSMessageList inboundSMSMessageList
inboundSMSMessageList contains a count of the number of available SMS messages, and an array of SMS messages

Class org.gsm.oneapi.responsebean.sms.SMSDeliveryReceiptSubscriptionResponse extends java.lang.Object implements Serializable

serialVersionUID: 1385695000469468349L

Serialized Fields

httpResponseCode

int httpResponseCode
contains the HTTP response code returned from the server


contentType

java.lang.String contentType
contains the HTTP Content-Type returned from the server if available


requestError

RequestError requestError
in the case the server has returned an error contains the error response.

See Also:
RequestError

location

java.lang.String location
the contents of the HTTP 'Location' header response if available


deliveryReceiptSubscription

DeliveryReceiptSubscription deliveryReceiptSubscription
the deliveryReceiptSubscription response contains a URL identifying the subscription along with callback information (notification URL and callback data)

Class org.gsm.oneapi.responsebean.sms.SMSMessageReceiptSubscriptionResponse extends java.lang.Object implements Serializable

serialVersionUID: -6611385179127153724L

Serialized Fields

httpResponseCode

int httpResponseCode
contains the HTTP response code returned from the server


contentType

java.lang.String contentType
contains the HTTP Content-Type returned from the server if available


requestError

RequestError requestError
in the case the server has returned an error contains the error response.

See Also:
RequestError

location

java.lang.String location
the contents of the HTTP 'Location' header response if available


resourceReference

ResourceReference resourceReference
resourceReference contains a URL uniquely identifying a successful request to create the SMS message receipt subscription

Class org.gsm.oneapi.responsebean.sms.SMSResponse extends java.lang.Object implements Serializable

serialVersionUID: 1746683143328583536L

Class org.gsm.oneapi.responsebean.sms.SMSSendDeliveryStatusResponse extends java.lang.Object implements Serializable

serialVersionUID: -7840104931971343018L

Serialized Fields

httpResponseCode

int httpResponseCode
contains the HTTP response code returned from the server


contentType

java.lang.String contentType
contains the HTTP Content-Type returned from the server if available


requestError

RequestError requestError
in the case the server has returned an error contains the error response.

See Also:
RequestError

location

java.lang.String location
the contents of the HTTP 'Location' header response if available


deliveryInfoList

DeliveryInfoList deliveryInfoList
contains a list of one or more message delivery status according to the number of recipients for the SMS message

Class org.gsm.oneapi.responsebean.sms.SMSSendResponse extends java.lang.Object implements Serializable

serialVersionUID: 1746683143328583536L

Serialized Fields

httpResponseCode

int httpResponseCode
contains the HTTP response code returned from the server


contentType

java.lang.String contentType
contains the HTTP Content-Type returned from the server if available


requestError

RequestError requestError
in the case the server has returned an error contains the error response.

See Also:
RequestError

location

java.lang.String location
the contents of the HTTP 'Location' header response if available


resourceReference

ResourceReference resourceReference
resourceReference contains a URL uniquely identifying a successful request to send an SMS message


Package org.gsm.oneapi.server

Class org.gsm.oneapi.server.OneAPIServlet extends javax.servlet.http.HttpServlet implements Serializable

serialVersionUID: -8195763247832284073L


Package org.gsm.oneapi.server.location

Class org.gsm.oneapi.server.location.LocationServlet extends OneAPIServlet implements Serializable

serialVersionUID: 68103504439958479L

Serialized Fields

validationRules

java.lang.String[] validationRules

Package org.gsm.oneapi.server.mms

Class org.gsm.oneapi.server.mms.CancelMMSDeliveryReportSubscriptionServlet extends OneAPIServlet implements Serializable

serialVersionUID: -8377700391917892308L

Serialized Fields

validationRules

java.lang.String[] validationRules

Class org.gsm.oneapi.server.mms.CancelMMSReceiptReportSubscriptionServlet extends OneAPIServlet implements Serializable

serialVersionUID: 4877311182916937332L

Serialized Fields

validationRules

java.lang.String[] validationRules

Class org.gsm.oneapi.server.mms.MMSDeliveryReportSubscriptionServlet extends OneAPIServlet implements Serializable

serialVersionUID: -7359556423074788912L

Serialized Fields

validationRules

java.lang.String[] validationRules

Class org.gsm.oneapi.server.mms.MMSReceiptReportSubscriptionServlet extends OneAPIServlet implements Serializable

serialVersionUID: 8016610130231905846L

Serialized Fields

validationRules

java.lang.String[] validationRules

Class org.gsm.oneapi.server.mms.QueryMMSDeliveryStatusServlet extends OneAPIServlet implements Serializable

serialVersionUID: -2045239201538398260L

Serialized Fields

validationRules

java.lang.String[] validationRules

Class org.gsm.oneapi.server.mms.RetrieveMMSMessageServlet extends OneAPIServlet implements Serializable

serialVersionUID: 2849235677506318772L

Serialized Fields

validationRules

java.lang.String[] validationRules

Class org.gsm.oneapi.server.mms.RetrieveMMSMessagesServlet extends OneAPIServlet implements Serializable

serialVersionUID: -4424298224881074100L

Serialized Fields

validationRules

java.lang.String[] validationRules

Class org.gsm.oneapi.server.mms.SendMMSServlet extends OneAPIServlet implements Serializable

serialVersionUID: -626608869216499030L

Serialized Fields

validationRules

java.lang.String[] validationRules

Package org.gsm.oneapi.server.payment

Class org.gsm.oneapi.server.payment.AmountChargeServlet extends PaymentServlet implements Serializable

serialVersionUID: -6237772242372106922L

Serialized Fields

validationRules

java.lang.String[] validationRules

callbackData

AmountTransaction callbackData

callbackURL

java.lang.String callbackURL

Class org.gsm.oneapi.server.payment.AmountRefundServlet extends PaymentServlet implements Serializable

serialVersionUID: -6237772242372106922L

Serialized Fields

validationRules

java.lang.String[] validationRules

Class org.gsm.oneapi.server.payment.AmountReserveAdditionalServlet extends PaymentServlet implements Serializable

serialVersionUID: -6237772242372106922L

Serialized Fields

validationRules

java.lang.String[] validationRules

Class org.gsm.oneapi.server.payment.AmountReserveChargeServlet extends PaymentServlet implements Serializable

serialVersionUID: -6237772242372106922L

Serialized Fields

validationRules

java.lang.String[] validationRules

callbackData

AmountReservationTransaction callbackData

callbackURL

java.lang.String callbackURL

Class org.gsm.oneapi.server.payment.AmountReserveReleaseServlet extends PaymentServlet implements Serializable

serialVersionUID: -6237772242372106922L

Serialized Fields

validationRules

java.lang.String[] validationRules

Class org.gsm.oneapi.server.payment.AmountReserveServlet extends PaymentServlet implements Serializable

serialVersionUID: -6237772242372106922L

Serialized Fields

validationRules

java.lang.String[] validationRules

Class org.gsm.oneapi.server.payment.PaymentServlet extends OneAPIServlet implements Serializable

serialVersionUID: -5819947050596857914L


Package org.gsm.oneapi.server.sms

Class org.gsm.oneapi.server.sms.CancelSMSDeliveryReportSubscriptionServlet extends OneAPIServlet implements Serializable

serialVersionUID: 3175996183724131934L

Serialized Fields

validationRules

java.lang.String[] validationRules

Class org.gsm.oneapi.server.sms.CancelSMSReceiptReportSubscriptionServlet extends OneAPIServlet implements Serializable

serialVersionUID: 4877311182916937332L

Serialized Fields

validationRules

java.lang.String[] validationRules

Class org.gsm.oneapi.server.sms.QuerySMSDeliveryStatusServlet extends OneAPIServlet implements Serializable

serialVersionUID: 2849235677506318772L

Serialized Fields

validationRules

java.lang.String[] validationRules

Class org.gsm.oneapi.server.sms.RetrieveSMSMessagesServlet extends OneAPIServlet implements Serializable

serialVersionUID: 2849235677506318772L

Serialized Fields

validationRules

java.lang.String[] validationRules

Class org.gsm.oneapi.server.sms.SendSMSServlet extends OneAPIServlet implements Serializable

serialVersionUID: 6553586905656923326L

Serialized Fields

validationRules

java.lang.String[] validationRules

Class org.gsm.oneapi.server.sms.SMSDeliveryReportSubscriptionServlet extends OneAPIServlet implements Serializable

serialVersionUID: -7359556423074788912L

Serialized Fields

validationRules

java.lang.String[] validationRules

Class org.gsm.oneapi.server.sms.SMSReceiptReportSubscriptionServlet extends OneAPIServlet implements Serializable

serialVersionUID: -7359556423074788912L

Serialized Fields

validationRules

java.lang.String[] validationRules