Facilities_v1

RESTful resources related to facilities

APIDescription
GET api/v1/facilities/{id}

Gets facility information

GET api/v1/facilities/{id}/features

Gets services via facility id.

GET api/v1/facilities/{id}/plans

Gets all the available plans by facility id

GET api/v1/facilities/{id}/freezones

Gets facility information

GET api/v1/facilities/{id}/itineraries?numberOfDays={numberOfDays}

Returns ICS Users

GET api/v1/facilities/{id}/voyages?startDate={startDate}&endDate={endDate}

Gets facility voyage information

Facilities

Resources related to facilities

APIDescription
GET api/facilities/{id}

RESTful endpoint to get facility information

GET api/facilities/{id}/plans

Gets all the available plans for a ship via Facility Id.

GET api/Facilities/Ping

Ping to test for connectivity

GET api/Facilities/info?ip={ip}&releaseCache={releaseCache}

Gets the facility information for a specific ship via Nomadix IP.

GET api/Facilities/plans?ip={ip}

Gets all the available plans for a ship via Facility Id.

GET api/Facilities/communityZones?ip={ip}

Gets the Free Zones for a facility specific for a cafe i.e. PAX or CREW.

GET api/Facilities/language?ip={ip}&language={language}

Gets the text to display in specified language for controls.

GET api/Facilities/help?language={language}&ip={ip}

Gets the frequently asked questions in the specified language

Users

APIDescription
GET api/users/activepin/{activeId}

Gets an active OceanPhone pin for a user by ActiveId

POST api/Users/user

Gets a user based on parameters provided.

GET api/Users/user?lastName={lastName}&dob={dob}&ip={ip}

Gets a user based on parameters provided.

GET api/Users/user?cardId={cardId}&cabin={cabin}&dob={dob}&ip={ip}

Gets a user based on parameters provided.

POST api/Users/userlogin

Gets a user based on parameters provided.

POST api/Users/userlogin_v1_5

Gets a user based on parameters provided.

GET api/Users/activeuser?activeId={activeId}&mac={mac}&ip={ip}

Gets a user based on parameters provided.

POST api/Users/reserveactivepin

Reserves an active OceanPhone pin for a user.

POST api/Users/changepassword

Changes a user's password by active id

POST api/Users/resetpassword

Reset a user password by userId and security questions

POST api/Users/setlimit

Set's the limit in money that a user can spend on a Pay As You Go plan

POST api/Users/setlimit_v1_5

Set's the limit in money that a user can spend on a Pay As You Go plan

GET api/Users/plans?activeId={activeId}&ip={ip}

Gets all the available plans base on a user's active id.

GET api/Users/usage?activeId={activeId}&billingId={billingId}&mac={mac}&ip={ip}

Gets the current usage for a user

GET api/Users/liveusage?activeId={activeId}&billingId={billingId}&mac={mac}&ip={ip}

Gets the current usage for a user

GET api/Users/summary?mac={mac}&page={page}&itemsPerPage={itemsPerPage}&activeId={activeId}&ip={ip}

Gets the billing summary for a user by active id

GET api/Users/loginURL?activeId={activeId}&mac={mac}&ip={ip}&os={os}&protocol={protocol}&port={port}

Gets the login URL for a user to go online

POST api/Users/kick?activeId={activeId}&transId={transId}

Gets the login URL for a user to go online

POST api/Users/endsession

Ends a devices session

POST api/Users/securityquestions

Gets a user security questions by username

ICSUsers

APIDescription
GET api/icsusers/{id}

Returns ICS Users

Health

APIDescription
GET status/healthcheck

Returns health check of the application

GET status/healthcheck/ping

Returns health check ping

VatCountries

APIDescription
GET api/VatCountries/get

Debug

DebugController class

APIDescription
POST api/Debug/CreateTestUser

Creates the test user.

Subscription

SubscriptionController class
This module provides all the purchase operations

APIDescription
GET api/Subscription/GetProvision?username={username}&password={password}&ip={ip}

Authenticates the user into the ICS System.

POST api/Subscription/Purchase

Purchases products for the specified user

POST api/Subscription/Purchase_v1_5

Purchases products for the specified user

POST api/Subscription/Recharge

Recharges products for the specified customer

POST api/Subscription/Terminate

Cancels products from the specified customer

POST api/Subscription/GetAccountBalance

Gets the balance.

POST api/Subscription/GetAccountDetails

Gets the account details.

POST api/Subscription/GetAccountActivity

Gets the account activity.

RSA

RSAController class

APIDescription
GET api/RSA/GetPublicKey

Gets the public RSA key.