1. Home
  2. Docs
  3. Kiwire ( v3 ) – API
  4. Profile

Profile



Create

Use POST method to create new subordinate resources.

Example request URIs

[POST] https://{{kiwire_ip}}/api/profile/

Parameters Required

ParameterValueDescription
tenant_idstringTenant ID or Tenant name of the API key
updated_datedatetimeThe last updated date and time
namestringThe name of the profile
typestring

There are 4 types of profile such as Countdown, Expiration, Free and Pay As You Use.

  • Countdown : A countdown plan type which user minutes are deducted only when they are online.
  • Expiration : A countdown plan type but countdown started the moment the user first login tonetwork until the minutes is finished regardless if the user is connected or not.
  • Free : A free plan that does not have minutes/credit restriction.
  • Pay As You Use : A plan that let you charge on usage basis on how much the user consume the internet usage on minute basis. The Price will be use for per minute charges.
advancestringAutomatically throttle user to a second profile when they reach their assigned profile limit. The profile will automatically reset to the original profile based on reset-type setting.
a_limitintegerIn Mbps how much maximum download speed is allowed for user.
* NOTE : 0 for Unlimited quota
priceintegerThe price of the profile which the price will be per minutes basis.
* NOTE : Except for type “Pay as you use”
attribute_customstringCustom attributes separated by commas.
* NOTE : Optional
remarkstringDescription or remark of the voucher generated.



PATCH

Use PATCH method is to make a partial update on a resource. 

The differences between PATCH and PUT, PUT method also modify a resource entity but PATCH method is used for partially updating an existing resource. PUT should be used if you are entirety replacing a resource.

Example request URIs

[PATCH] https://{{kiwire_ip}}/api/profile/{{id}}/

Parameters Required

ParameterValueDescription
tenant_idstringTenant ID or Tenant name of the API key
updated_datedatetimeThe last updated date and time
namestringThe name of the profile
typestring

There are 4 types of profile such as Countdown, Expiration, Free and Pay As You Use.

  • Countdown : A countdown plan type which user minutes are deducted only when they are online.
  • Expiration : A countdown plan type but countdown started the moment the user first login tonetwork until the minutes is finished regardless if the user is connected or not.
  • Free : A free plan that does not have minutes/credit restriction.
  • Pay As You Use : A plan that let you charge on usage basis on how much the user consume the internet usage on minute basis. The Price will be use for per minute charges.
advancestringAutomatically throttle user to a second profile when they reach their assigned profile limit. The profile will automatically reset to the original profile based on reset-type setting.
a_limitintegerIn Mbps how much maximum download speed is allowed for user.
* NOTE : 0 for Unlimited quota
priceintegerThe price of the profile which the price will be per minutes basis.
* NOTE : Except for type “Pay as you use”
attribute_customstringCustom attributes separated by commas.
* NOTE : Optional
remarkstringDescription or remark of the voucher generated.



delete

Use DELETE method as the name applies to delete resources.

Example request URIs

[DELETE] https://{{kiwire_ip}}/api/profile/{{id}}/




get

Use GET method to retrieve resource information only and not to modify it in any way.

Example request URIs

[GET] https://{{kiwire_ip}}/api/profile/

[GET] https://{{kiwire_ip}}/api/profile/{{id}}/

[GET] https://{{kiwire_ip}}/api/profile/{{offset}}/{{limit}}/{{column}}/{{order}}/

 ValueDescription
offsetintegerStart data count
limitintegerLimit data count
columnstringColumn name
orderdesc or ascSort the result set in ascending or descending order.

NOTE:

For GET method, if {{offset}}, {{limit}}, {{column}}, and {{order}} not provided then Kiwire will return default value eg :

https://{{kiwire_ip}}/api/profile/0/10/id/desc/