Swagger UI

Parameter	Value	Description	Parameter Type	Data Type
ip			query	string
releaseCache			query	boolean

Parameter	Value	Description	Parameter Type	Data Type
ip			query	string

Parameter	Value	Description	Parameter Type	Data Type
ip			query	string

Parameter	Value	Description	Parameter Type	Data Type
ip			query	string
language			query	string

Parameter	Value	Description	Parameter Type	Data Type
language			query	string
ip			query	string

Parameter	Value	Description	Parameter Type	Data Type
data	Parameter content type:		body	Model Example Value Debugging { encryptedText (string, optional) } `{ "encryptedText": "string" }`

Subscription

post /api/Subscription/Purchase_v1_5

Response Class (Status 200)

PurchaseResponse {

sequenceId (integer, optional),

details (Array[PurchaseResponseLine], optional),

paymentResponse (PaymentResponse, optional),

success (boolean, optional),

comments (string, optional),

error (MessageResource, optional)

}
PurchaseResponseLine {

billingId (integer, optional),

productId (integer, optional),

i_account (integer, optional),

statusCode (integer, optional) = ['100', '101', '200', '201', '202', '203', '204', '205', '206', '300', '300', '301', '301', '302', '302', '303', '303', '304', '305', '306', '307', '307', '400', '401', '402', '403', '404', '405', '406', '407', '408', '409', '410', '411', '412', '413', '414', '415', '416', '417', '426', '500', '501', '502', '503', '504', '505']

integer
Enum:	100, 101, 200, 201, 202, 203, 204, 205, 206, 300, 300, 301, 301, 302, 302, 303, 303, 304, 305, 306, 307, 307, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 426, 500, 501, 502, 503, 504, 505

success (boolean, optional),

comments (string, optional),

error (MessageResource, optional)

}
PaymentResponse {

success (boolean, optional),

code (integer, optional),

processor_message (string, optional),

message (string, optional),

amount (number, optional),

currency (string, optional),

request_reference (PaymentRequestReference, optional),

response_reference (PaymentResponseReference, optional),

card_type (string, optional),

card_number_masked (string, optional)

}
MessageResource {

code (integer, optional),

params (Array[string], optional)

}
PaymentRequestReference {

ref (string, optional),

customer_ref (string, optional),

reference_3 (string, optional),

previous_authorization_no (string, optional),

transaction_tag (string, optional)

}
PaymentResponseReference {

sequence_no (string, optional),

retrieval_ref_no (string, optional),

transaction_tag (string, optional),

authorization_num (string, optional)

}

{
  "sequenceId": 0,
  "details": [
    {
      "billingId": 0,
      "productId": 0,
      "i_account": 0,
      "statusCode": 100,
      "success": true,
      "comments": "string",
      "error": {
        "code": 0,
        "params": [
          "string"
        ]
      }
    }
  ],
  "paymentResponse": {
    "success": true,
    "code": 0,
    "processor_message": "string",
    "message": "string",
    "amount": 0,
    "currency": "string",
    "request_reference": {
      "ref": "string",
      "customer_ref": "string",
      "reference_3": "string",
      "previous_authorization_no": "string",
      "transaction_tag": "string"
    },
    "response_reference": {
      "sequence_no": "string",
      "retrieval_ref_no": "string",
      "transaction_tag": "string",
      "authorization_num": "string"
    },
    "card_type": "string",
    "card_number_masked": "string"
  },
  "success": true,
  "comments": "string",
  "error": {
    "code": 0,
    "params": [
      "string"
    ]
  }
}

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
request	Parameter content type:		body	Model Example Value PurchaseRequest { sequenceId (integer, optional), activeUserId (string, optional), userId (string, optional), facilityId (integer, optional), MAC (string, optional), IP (string, optional), emailAddress (string, optional), forceNewPurchase (boolean, optional), price (number, optional), details (Array[PurchaseRequestLine], optional), paymentInformation (PaymentRequestInformation, optional), originatorName (string, optional), forceNewPin (boolean, optional), forcePlanUpgrade (boolean, optional), pinId (integer, optional) } PurchaseRequestLine { productId (integer, optional) } PaymentRequestInformation { amount (number, optional), name (string, optional), card_number (string, optional), expiration_code (string, optional), currency (string, optional), security_code (string, optional), address (PaymentRequesAddress, optional), reference (PaymentRequestReference, optional), specific_fields (Array[PaymentProcessorSpecificField], optional) } PaymentRequesAddress { address1 (string, optional), address2 (string, optional), city (string, optional), zip (string, optional), country_code (string, optional), phone_number (string, optional), phone_type (string, optional) } PaymentRequestReference { ref (string, optional), customer_ref (string, optional), reference_3 (string, optional), previous_authorization_no (string, optional), transaction_tag (string, optional) } PaymentProcessorSpecificField { key (string, optional), value (string, optional) } { "sequenceId": 0, "activeUserId": "string", "userId": "string", "facilityId": 0, "MAC": "string", "IP": "string", "emailAddress": "string", "forceNewPurchase": true, "price": 0, "details": [ { "productId": 0 } ], "paymentInformation": { "amount": 0, "name": "string", "card_number": "string", "expiration_code": "string", "currency": "string", "security_code": "string", "address": { "address1": "string", "address2": "string", "city": "string", "zip": "string", "country_code": "string", "phone_number": "string", "phone_type": "string" }, "reference": { "ref": "string", "customer_ref": "string", "reference_3": "string", "previous_authorization_no": "string", "transaction_tag": "string" }, "specific_fields": [ { "key": "string", "value": "string" } ] }, "originatorName": "string", "forceNewPin": true, "forcePlanUpgrade": true, "pinId": 0 }

Hide Response

Curl

Request URL

Response Body

Response Code

Response Headers

post /api/Subscription/Terminate

Response Class (Status 200)

TerminateResponse {

success (boolean, optional),

comments (string, optional),

error (MessageResource, optional)

}
MessageResource {

code (integer, optional),

params (Array[string], optional)

}

{
  "success": true,
  "comments": "string",
  "error": {
    "code": 0,
    "params": [
      "string"
    ]
  }
}

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
request	Parameter content type:		body	Model Example Value TerminateRequest { activeUserId (string, optional), userId (string, optional), facilityId (integer, optional), MAC (string, optional), IP (string, optional), emailAddress (string, optional), userSubTypeId (integer, optional), productId (integer, optional), pinNumber (string, optional) } `{ "activeUserId": "string", "userId": "string", "facilityId": 0, "MAC": "string", "IP": "string", "emailAddress": "string", "userSubTypeId": 0, "productId": 0, "pinNumber": "string" }`

Hide Response

Curl

Request URL

Response Body

Response Code

Response Headers

post /api/Subscription/GetAccountBalance

Response Class (Status 200)

AccountBalanceResponse {

status_code (integer, optional),

balance (number, optional),

balanceText (string, optional),

success (boolean, optional),

comments (string, optional),

error (MessageResource, optional)

}
MessageResource {

code (integer, optional),

params (Array[string], optional)

}

{
  "status_code": 0,
  "balance": 0,
  "balanceText": "string",
  "success": true,
  "comments": "string",
  "error": {
    "code": 0,
    "params": [
      "string"
    ]
  }
}

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
request	Parameter content type:		body	Model Example Value AccountBalanceRequest { productByFacilityId (integer, optional), activeUserId (string, optional), userId (string, optional), facilityId (integer, optional), MAC (string, optional), IP (string, optional), emailAddress (string, optional) } `{ "productByFacilityId": 0, "activeUserId": "string", "userId": "string", "facilityId": 0, "MAC": "string", "IP": "string", "emailAddress": "string" }`

Hide Response

Curl

Request URL

Response Body

Response Code

Response Headers

post /api/Subscription/GetAccountDetails

Response Class (Status 200)

AccountDetailsResponse {

status_code (integer, optional),

OPM (OceanPhoneMobileDetailsResponse, optional),

OP (OceanPhoneDetailsResponse, optional),

media (MediaPlanDetailsResponse, optional),

success (boolean, optional),

comments (string, optional),

error (MessageResource, optional)

}
OceanPhoneMobileDetailsResponse {

productByFacilityId (integer, optional),

planName (string, optional),

accountNumber (string, optional),

phoneNumber (string, optional),

userName (string, optional),

password (string, optional),

balanceText (string, optional),

promo (PromoBannerResponse, optional),

success (boolean, optional),

comments (string, optional),

error (MessageResource, optional)

}
OceanPhoneDetailsResponse {

productByFacilityId (integer, optional),

planName (string, optional),

pin (string, optional),

expirationDate (string, optional),

balanceText (string, optional),

culture (string, optional),

success (boolean, optional),

comments (string, optional),

error (MessageResource, optional)

}
MediaPlanDetailsResponse {

planName (string, optional),

expirationDate (string, optional),

url (string, optional),

success (boolean, optional),

comments (string, optional),

error (MessageResource, optional)

}
MessageResource {

code (integer, optional),

params (Array[string], optional)

}
PromoBannerResponse {

balance (number, optional),

unit (string, optional),

stores (Array[PromoBannerStoreResponse], optional),

success (boolean, optional),

comments (string, optional),

error (MessageResource, optional)

}
PromoBannerStoreResponse {

url (string, optional),

store (string, optional),

success (boolean, optional),

comments (string, optional),

error (MessageResource, optional)

}

{
  "status_code": 0,
  "OPM": {
    "productByFacilityId": 0,
    "planName": "string",
    "accountNumber": "string",
    "phoneNumber": "string",
    "userName": "string",
    "password": "string",
    "balanceText": "string",
    "promo": {
      "balance": 0,
      "unit": "string",
      "stores": [
        {
          "url": "string",
          "store": "string",
          "success": true,
          "comments": "string",
          "error": {
            "code": 0,
            "params": [
              "string"
            ]
          }
        }
      ],
      "success": true,
      "comments": "string",
      "error": {
        "code": 0,
        "params": [
          "string"
        ]
      }
    },
    "success": true,
    "comments": "string",
    "error": {
      "code": 0,
      "params": [
        "string"
      ]
    }
  },
  "OP": {
    "productByFacilityId": 0,
    "planName": "string",
    "pin": "string",
    "expirationDate": "string",
    "balanceText": "string",
    "culture": "string",
    "success": true,
    "comments": "string",
    "error": {
      "code": 0,
      "params": [
        "string"
      ]
    }
  },
  "media": {
    "planName": "string",
    "expirationDate": "string",
    "url": "string",
    "success": true,
    "comments": "string",
    "error": {
      "code": 0,
      "params": [
        "string"
      ]
    }
  },
  "success": true,
  "comments": "string",
  "error": {
    "code": 0,
    "params": [
      "string"
    ]
  }
}

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
request	Parameter content type:		body	Model Example Value AccountDetailsRequest { sequenceId (integer, optional), activeUserId (string, optional), userId (string, optional), facilityId (integer, optional), MAC (string, optional), IP (string, optional), emailAddress (string, optional) } `{ "sequenceId": 0, "activeUserId": "string", "userId": "string", "facilityId": 0, "MAC": "string", "IP": "string", "emailAddress": "string" }`

Hide Response

Curl

Request URL

Response Body

Response Code

Response Headers

post /api/Subscription/Credit

Response Class (Status 200)

CreditResponse {

success (boolean, optional),

comments (string, optional),

error (MessageResource, optional)

}
MessageResource {

code (integer, optional),

params (Array[string], optional)

}

{
  "success": true,
  "comments": "string",
  "error": {
    "code": 0,
    "params": [
      "string"
    ]
  }
}

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
request	Parameter content type:		body	Model Example Value CreditRequest { activeUserId (string, optional), userId (string, optional), facilityId (integer, optional), productId (integer, optional), productTypeId (integer, optional), pin (string, optional), reason (string, optional), issuedBy (string, optional), issuedByAppName (string, optional), amount (number, optional), emailAddress (string, optional) } `{ "activeUserId": "string", "userId": "string", "facilityId": 0, "productId": 0, "productTypeId": 0, "pin": "string", "reason": "string", "issuedBy": "string", "issuedByAppName": "string", "amount": 0, "emailAddress": "string" }`

Hide Response

Curl

Request URL

Response Body

Response Code

Response Headers

Users

post /api/Users/user

Response Class (Status 200)

Inline Model [

Inline Model 1

]
Inline Model 1 {

firstName (string, optional),

lastName (string, optional),

error (Error, optional),

id (string, optional),

activeId (string, optional),

loginId (string, optional),

billingId (integer, optional),

changePassword (boolean, optional),

isOnline (boolean, optional),

plans (Array[UserPlan], optional)

}
Error {

code (integer, optional),

msg (string, optional),

params (Array[string], optional)

}
UserPlan {

name (string, optional),

alternateName (string, optional),

id (integer, optional),

productId (integer, optional),

planOptionId (integer, optional),

units (integer, optional),

unitOfMeasure (string, optional),

price (string, optional),

suffix (string, optional),

value (number, optional),

merger (string, optional),

desc (string, optional),

subDesc (string, optional),

activationFee (string, optional),

upgradable (boolean, optional),

perceivedRetailValue (number, optional)

}

[
  {
    "firstName": "string",
    "lastName": "string",
    "error": {
      "code": 0,
      "msg": "string",
      "params": [
        "string"
      ]
    },
    "id": "string",
    "activeId": "string",
    "loginId": "string",
    "billingId": 0,
    "changePassword": true,
    "isOnline": true,
    "plans": [
      {
        "name": "string",
        "alternateName": "string",
        "id": 0,
        "productId": 0,
        "planOptionId": 0,
        "units": 0,
        "unitOfMeasure": "string",
        "price": "string",
        "suffix": "string",
        "value": 0,
        "merger": "string",
        "desc": "string",
        "subDesc": "string",
        "activationFee": "string",
        "upgradable": true,
        "perceivedRetailValue": 0
      }
    ]
  }
]

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
login	Parameter content type:		body	Model Example Value UserLogin { ip (string, optional), id (string, optional), lastName (string, optional), cardId (string, optional), cabin (string, optional), dob (string, optional), activeUserName (string, optional), activePassword (string, optional), userName (string, optional), password (string, optional), SecurityQAs (inline_model, optional), UserMetaData (inline_model_0, optional), mac (string, optional), language (string, optional), loginType (string, optional), appId (string, optional), isOnline (boolean, optional), isOnlineError (boolean, optional), productId (integer, optional), userAgent (string, optional), associateDevice (boolean, optional) } inline_model {} inline_model_0 {} `{ "ip": "string", "id": "string", "lastName": "string", "cardId": "string", "cabin": "string", "dob": "string", "activeUserName": "string", "activePassword": "string", "userName": "string", "password": "string", "SecurityQAs": {}, "UserMetaData": {}, "mac": "string", "language": "string", "loginType": "string", "appId": "string", "isOnline": true, "isOnlineError": true, "productId": 0, "userAgent": "string", "associateDevice": true }`

Hide Response

Curl

Request URL

Response Body

Response Code

Response Headers

post /api/Users/userlogin_v1_5

Response Class (Status 200)

Inline Model {}

{}

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
login	Parameter content type:		body	Model Example Value UserLogin { ip (string, optional), id (string, optional), lastName (string, optional), cardId (string, optional), cabin (string, optional), dob (string, optional), activeUserName (string, optional), activePassword (string, optional), userName (string, optional), password (string, optional), SecurityQAs (inline_model, optional), UserMetaData (inline_model_0, optional), mac (string, optional), language (string, optional), loginType (string, optional), appId (string, optional), isOnline (boolean, optional), isOnlineError (boolean, optional), productId (integer, optional), userAgent (string, optional), associateDevice (boolean, optional) } inline_model {} inline_model_0 {} `{ "ip": "string", "id": "string", "lastName": "string", "cardId": "string", "cabin": "string", "dob": "string", "activeUserName": "string", "activePassword": "string", "userName": "string", "password": "string", "SecurityQAs": {}, "UserMetaData": {}, "mac": "string", "language": "string", "loginType": "string", "appId": "string", "isOnline": true, "isOnlineError": true, "productId": 0, "userAgent": "string", "associateDevice": true }`

Hide Response

Curl

Request URL

Response Body

Response Code

Response Headers

post /api/Users/authenticate

Response Class (Status 200)

Inline Model {}

{}

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
login	Parameter content type:		body	Model Example Value UserLogin { ip (string, optional), id (string, optional), lastName (string, optional), cardId (string, optional), cabin (string, optional), dob (string, optional), activeUserName (string, optional), activePassword (string, optional), userName (string, optional), password (string, optional), SecurityQAs (inline_model, optional), UserMetaData (inline_model_0, optional), mac (string, optional), language (string, optional), loginType (string, optional), appId (string, optional), isOnline (boolean, optional), isOnlineError (boolean, optional), productId (integer, optional), userAgent (string, optional), associateDevice (boolean, optional) } inline_model {} inline_model_0 {} `{ "ip": "string", "id": "string", "lastName": "string", "cardId": "string", "cabin": "string", "dob": "string", "activeUserName": "string", "activePassword": "string", "userName": "string", "password": "string", "SecurityQAs": {}, "UserMetaData": {}, "mac": "string", "language": "string", "loginType": "string", "appId": "string", "isOnline": true, "isOnlineError": true, "productId": 0, "userAgent": "string", "associateDevice": true }`

Hide Response

Curl

Request URL

Response Body

Response Code

Response Headers

post /api/Users/changepassword

Response Class (Status 200)

Inline Model {}

{}

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
passwordChange	Parameter content type:		body	Model Example Value PasswordChange { ActiveId (string, optional), OldPassword (string, optional), NewPassword (string, optional), Language (string, optional) } `{ "ActiveId": "string", "OldPassword": "string", "NewPassword": "string", "Language": "string" }`

Hide Response

Curl

Request URL

Response Body

Response Code

Response Headers

post /api/Users/setlimit_v1_5

Response Class (Status 200)

Inline Model {}

{}

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
StopLimit	Parameter content type:		body	Model Example Value SetStopLimit { ActiveId (string, optional), StopLimit (number, optional), Language (string, optional) } `{ "ActiveId": "string", "StopLimit": 0, "Language": "string" }`

Hide Response

Curl

Request URL

Response Body

Response Code

Response Headers

get /api/Users/plans

Response Class (Status 200)

Inline Model {}

{}

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
activeId			query	string
ip			query	string

Hide Response

Curl

Request URL

Response Body

Response Code

Response Headers

get /api/Users/liveusage

Response Class (Status 200)

Inline Model {}

{}

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
activeId	query	string
billingId	query	long
mac	query	string
ip	query	string

Hide Response

Curl

Request URL

Response Body

Response Code

Response Headers

get /api/Users/summary

Response Class (Status 200)

Inline Model {}

{}

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
mac	query	string
page	query	string
itemsPerPage	query	integer
activeId	query	string
ip	query	string

Hide Response

Curl

Request URL

Response Body

Response Code

Response Headers

get /api/Users/summary_poc

Response Class (Status 200)

Inline Model {}

{}

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
activeId			query	string

Hide Response

Curl

Request URL

Response Body

Response Code

Response Headers

get /api/Users/loginURL

Response Class (Status 200)

Inline Model {}

{}

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
activeId	query	string
mac	query	string
ip	query	string
os	query	string
protocol	query	string
port	query	string

Hide Response

Curl

Request URL

Response Body

Response Code

Response Headers

post /api/Users/endsession

Response Class (Status 200)

Inline Model {}

{}

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
Session	Parameter content type:		body	Model Example Value EndSession { Id (string, optional) } `{ "Id": "string" }`

Hide Response

Curl

Request URL

Response Body

Response Code

Response Headers

post /api/Users/upgradeplan

Response Class (Status 200)

Inline Model {}

{}

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
upgradeRequest	Parameter content type:		body	Model Example Value UpgradePlanRequest { activeId (string, optional), mac (string, optional), UserMetaData (inline_model_1, optional) } inline_model_1 {} `{ "activeId": "string", "mac": "string", "UserMetaData": {} }`

Hide Response

Curl

Request URL

Response Body

Response Code

Response Headers

post /api/Users/ghostaccount

Response Class (Status 200)

Inline Model {}

{}

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
ghostAccountRequest	Parameter content type:		body	Model Example Value GhostAccountRequest { activeId (string, optional), mac (string, optional) } `{ "activeId": "string", "mac": "string" }`