Query string
Introduction
Since Websites are stateles by design, we need to maintain data via a portion of the URL , that's Query strings
example: https://phpr.link/parameters?specific.tenant=2
Listing
Parameters
list of Query strings:
Query string | Description | implemented |
---|---|---|
q | query for search resutls | partial[api] |
specific.name | filter based on a specific property of the entity | Yes |
fields | list of the fields, seperated by , | Yes |
actions | list of the actions, seperated by , example: ?actions=edit,delete | Yes |
limit | specify the maximum number of returned data | partial[api] |
offset | specify the offset of the data | partial[api] |
page | specify the page number | yes |
sort | sort the returned data based on a field | Yes |
order | order the returned data based on a field, example: ?order=asc | Yes |
perPage | Table row count per page | Yes |
Hostnames ``
list of Query strings:
Query string | Description | implemented |
---|---|---|
q | query for search resutls | partial[api] |
fields | list of the fields, seperated by , | Yes |
actions | list of the actions, seperated by , | Yes |
limit | specify the maximum number of returned data | partial[api] |
offset | specify the offset of the data | partial[api] |
page | specify the page number | yes |
sort | sort the returned data based on a field example: ?sort=name | Yes |
order | order the returned data based on a field, example: ?order=asc | Yes |
perPage | Table row count per page | Yes |
Tenants `
list of Query strings:
Query string | Description | implemented |
---|---|---|
specific.name | filter based on a specific property of the entity | Yes |
q | query for search resutls | partial[api] |
fields | list of the fields, seperated by , | Yes |
actions | list of the actions, seperated by , | Yes |
limit | specify the maximum number of returned data | partial[api] |
offset | specify the offset of the data | partial[api] |
page | specify the page number | yes |
sort | sort the returned data based on a field example: ?sort=name | Yes |
order | order the returned data based on a field, example: ?order=asc | Yes |
perPage | Table row count per page | Yes |
Edit
list of Query strings:
Query string | Description | implemented |
---|---|---|
field | field=value will populate the field with the appropriate entry | yes |
ADD
list of Query strings:
Query string | Description | implemented |
---|---|---|
field | field=value will populate the field with the appropriate entry | yes |