openapi: 3.0.3
info:
title: 'My light mobile API Documentation'
description: ''
version: 1.0.0
servers:
-
url: 'https://api2.mylightmobile.com'
tags:
-
name: Endpoints
description: ''
components:
securitySchemes:
default:
type: http
scheme: bearer
description: 'You can retrieve your token by calling login method.'
security:
-
default: []
paths:
/api/login:
post:
summary: 'POST api/login'
operationId: pOSTApilogin
description: 'This endpoint allows you to fetch your access token..'
parameters: []
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n \"success\": true,\n \"message\": \"Login Successful\",\n \"data\": {\n \"token\": \"xyzAbc374672346\",\n \"name\": \"Cassie\",\n \"address\": \"Gujarat \",\n }\n}"
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
email:
type: string
description: 'The email of the user.'
example: cassie52@example.net
password:
type: string
description: 'The password of the user.'
example: password
required:
- email
- password
security: []
/api/brands:
get:
summary: ''
operationId: getApiBrands
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
status_code: 401
success: false
message: Unauthenticated.
data: null
properties:
status_code:
type: integer
example: 401
success:
type: boolean
example: false
message:
type: string
example: Unauthenticated.
data:
type: string
example: null
tags:
- Endpoints
'/api/brand/{id}':
get:
summary: ''
operationId: getApiBrandId
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
status_code: 401
success: false
message: Unauthenticated.
data: null
properties:
status_code:
type: integer
example: 401
success:
type: boolean
example: false
message:
type: string
example: Unauthenticated.
data:
type: string
example: null
tags:
- Endpoints
parameters:
-
in: path
name: id
description: 'The ID of the brand.'
example: '564'
required: true
schema:
type: string
'/api/activation/plans/{brand_id}':
get:
summary: ''
operationId: getApiActivationPlansBrand_id
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
status_code: 401
success: false
message: Unauthenticated.
data: null
properties:
status_code:
type: integer
example: 401
success:
type: boolean
example: false
message:
type: string
example: Unauthenticated.
data:
type: string
example: null
tags:
- Endpoints
parameters:
-
in: path
name: brand_id
description: 'The ID of the brand.'
example: '564'
required: true
schema:
type: string
'/api/refill/plans/{brand_id}':
get:
summary: ''
operationId: getApiRefillPlansBrand_id
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
status_code: 401
success: false
message: Unauthenticated.
data: null
properties:
status_code:
type: integer
example: 401
success:
type: boolean
example: false
message:
type: string
example: Unauthenticated.
data:
type: string
example: null
tags:
- Endpoints
parameters:
-
in: path
name: brand_id
description: 'The ID of the brand.'
example: '564'
required: true
schema:
type: string
'/api/activation/plan/{id}':
get:
summary: ''
operationId: getApiActivationPlanId
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
status_code: 401
success: false
message: Unauthenticated.
data: null
properties:
status_code:
type: integer
example: 401
success:
type: boolean
example: false
message:
type: string
example: Unauthenticated.
data:
type: string
example: null
tags:
- Endpoints
parameters:
-
in: path
name: id
description: 'The ID of the plan.'
example: architecto
required: true
schema:
type: string
'/api/refill/plan/{id}':
get:
summary: ''
operationId: getApiRefillPlanId
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
status_code: 401
success: false
message: Unauthenticated.
data: null
properties:
status_code:
type: integer
example: 401
success:
type: boolean
example: false
message:
type: string
example: Unauthenticated.
data:
type: string
example: null
tags:
- Endpoints
parameters:
-
in: path
name: id
description: 'The ID of the plan.'
example: architecto
required: true
schema:
type: string
/api/activation:
post:
summary: ''
operationId: postApiActivation
description: ''
parameters: []
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
brand_id:
type: string
description: 'The id of an existing record in the brands table.'
example: architecto
plan_id:
type: string
description: 'The id of an existing record in the plans table.'
example: architecto
imei:
type: number
description: ''
example: 4326.41688
nullable: true
first_name:
type: string
description: ''
example: architecto
last_name:
type: string
description: ''
example: architecto
email:
type: string
description: 'Must be a valid email address.'
example: zbailey@example.net
address:
type: string
description: ''
example: architecto
city:
type: string
description: ''
example: architecto
state:
type: string
description: ''
example: architecto
zipcode:
type: number
description: ''
example: 4326.41688
sim_type:
type: string
description: ''
example: physical
enum:
- physical
- esim
required:
- brand_id
- plan_id
- first_name
- last_name
- email
- address
- city
- state
- zipcode
- sim_type
/api/activation-calculation:
post:
summary: ''
operationId: postApiActivationCalculation
description: ''
parameters: []
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
plan_id:
type: string
description: 'The id of an existing record in the plans table.'
example: architecto
month:
type: string
description: ''
example: architecto
required:
- plan_id
- month
/api/refill:
post:
summary: ''
operationId: postApiRefill
description: ''
parameters: []
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
mdn:
type: string
description: 'Must not be greater than 10 characters.'
example: bngzmi
plan_id:
type: string
description: 'The id of an existing record in the plans table.'
example: architecto
brand_id:
type: string
description: 'The id of an existing record in the brands table.'
example: architecto
amount:
type: number
description: ''
example: 4326.41688
nullable: true
required:
- mdn
- plan_id
- brand_id
/api/portin:
post:
summary: ''
operationId: postApiPortin
description: ''
parameters: []
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
brand_id:
type: string
description: 'The id of an existing record in the brands table.'
example: architecto
plan_id:
type: string
description: 'The id of an existing record in the plans table.'
example: architecto
imei:
type: string
description: 'Must be 15 digits.'
example: '822569775449171'
nullable: true
last_name:
type: string
description: ''
example: architecto
email:
type: string
description: 'Must be a valid email address.'
example: zbailey@example.net
address:
type: string
description: ''
example: architecto
city:
type: string
description: ''
example: architecto
state:
type: string
description: ''
example: architecto
zipcode:
type: number
description: ''
example: 4326.41688
sim_type:
type: string
description: ''
example: esim
enum:
- physical
- esim
mdn:
type: string
description: 'Must be between 10 and 15 digits.'
example: '1374491716806'
account_number:
type: string
description: ''
example: architecto
account_password:
type: string
description: ''
example: architecto
required:
- brand_id
- plan_id
- last_name
- email
- address
- city
- state
- zipcode
- sim_type
- mdn
- account_number
- account_password
'/api/transaction/{public_id}':
get:
summary: ''
operationId: getApiTransactionPublic_id
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
status_code: 401
success: false
message: Unauthenticated.
data: null
properties:
status_code:
type: integer
example: 401
success:
type: boolean
example: false
message:
type: string
example: Unauthenticated.
data:
type: string
example: null
tags:
- Endpoints
parameters:
-
in: path
name: public_id
description: 'The ID of the public.'
example: architecto
required: true
schema:
type: string
/api/esim/qr:
post:
summary: ''
operationId: postApiEsimQr
description: ''
parameters: []
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
brand_id:
type: string
description: 'The id of an existing record in the brands table.'
example: architecto
sim_no:
type: string
description: ''
example: architecto
required:
- brand_id
- sim_no
'/api/esim/qr/{public_id}':
get:
summary: ''
operationId: getApiEsimQrPublic_id
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
status_code: 401
success: false
message: Unauthenticated.
data: null
properties:
status_code:
type: integer
example: 401
success:
type: boolean
example: false
message:
type: string
example: Unauthenticated.
data:
type: string
example: null
tags:
- Endpoints
parameters:
-
in: path
name: public_id
description: 'The ID of the public.'
example: architecto
required: true
schema:
type: string
/api/plans/activation/month-wise:
post:
summary: ''
operationId: postApiPlansActivationMonthWise
description: ''
parameters: []
responses: { }
tags:
- Endpoints
'/api/plans/activation/{id}/month-wise':
post:
summary: ''
operationId: postApiPlansActivationIdMonthWise
description: ''
parameters: []
responses: { }
tags:
- Endpoints
parameters:
-
in: path
name: id
description: 'The ID of the activation.'
example: architecto
required: true
schema:
type: string