Add OapApi.v1 module
This commit is contained in:
34
docs/api/OverseasAutoProtectionApi/getApplications.md
Normal file
34
docs/api/OverseasAutoProtectionApi/getApplications.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# getApplications
|
||||
|
||||
Gets applications for the current user.
|
||||
|
||||
```
|
||||
GET /applications
|
||||
?status={status}
|
||||
&limit={limit}
|
||||
&nextToken={nextToken}
|
||||
--- 200 OK
|
||||
{
|
||||
"applications": [ { "id": ... }, ... ],
|
||||
"total": (integer),
|
||||
"nextToken": "(string)",
|
||||
"isLastPage": (true|false)
|
||||
}
|
||||
```
|
||||
|
||||
| request | type | description |
|
||||
| --- | --- | --- |
|
||||
| status | [ApplicationStatus](ApplicationStatus.md) | Filter applications by the given status. |
|
||||
| limit | int32 | The limit of returned results. |
|
||||
| nextToken | string | The token presenting the next page of applications to get. |
|
||||
|
||||
| response | type | description |
|
||||
| --- | --- | --- |
|
||||
| applications | [Application](Application.md)[] | The applications. |
|
||||
| total | int64 | The total number of applications. |
|
||||
| nextToken | string | The token representing the next page of results. |
|
||||
| isLastPage | boolean | True if this is the last page of results, false otherwise. |
|
||||
|
||||
Gets the current user's applications in pages.
|
||||
|
||||
<!-- DO NOT EDIT: generated by fsdgenmd -->
|
||||
Reference in New Issue
Block a user