Create
Use POST method to create new subordinate resources.Example request URIs
[POST] https://{{kiwire_ip}}/api/user/Parameters Required
Parameter | Value | Description |
---|---|---|
tenant_id | string | Tenant ID or Tenant name of the API key |
integration | string | Integration type (int/pms/msad/ldap) |
profile_subs | string | Account profile |
date_expiry | datetime | Date and time of expiry (YYYY-MM-DD HH:mm:ss) |
username | string | Username to login into Kiwire system |
fullname | string | User full name |
password | string | Password to login into Kiwire system |
email_address | string | Email address to send notification |
phone_number | integer | User phone number |
remark | string | Description or remark of the voucher generated. |
status | y or n | The status of the user whether active or expired. |
allowed_zone | string | (optional) (default: nozone) Specific zone |
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/user/{{id}}/ Parameters RequiredParameter | Value | Description |
---|---|---|
tenant_id | string | Tenant ID or Tenant name of the API key |
updated_date | datetime | The last updated date and time |
username | string | Username to login into Kiwire system |
fullname | string | User full name |
password | string | Password to login into Kiwire system |
email_address | string | Email address to send notification |
phone_number | integer | User phone number |
remark | string | Description or remark of the voucher generated. |
status | y or n | The status of the user whether active or expired. |
allowed_zone | string | (optional) (default: nozone) Specific zone |
delete
Use DELETE method as the name applies to delete resources.Example request URIs
[DELETE] https://{{kiwire_ip}}/api/user/{{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/user/ [GET] https://{{kiwire_ip}}/api/user/{{id}}/ [GET] https://{{kiwire_ip}}/api/user/{{offset}}/{{limit}}/{{column}}/{{order}}/Value | Description | |
---|---|---|
offset | integer | Start data count |
limit | integer | Limit data count |
column | string | Column name |
order | desc or asc | Sort the result set in ascending or descending order. |