Skip to content

feat/ documentation for the apis newly created for the internal admin dashboard #46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 11, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 75 additions & 0 deletions Versus-2.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -1038,6 +1038,43 @@ Update client data
- 404 - Team not found || Client does not exist
- 500 - Backend service error

## Edit Client Admin

Update client data for admin

> Endpoint: versus_v2_edit_client_admin

> Payload

```json
{
"email": "xavier@stan.dev",
"uid": "bfbbc055eeec778b",
"idToken": "13238bee-3ac9-4c77-b3b1-c7c53f113d5a.13238bee-3ac9-4c77-b3b1-c7c53f113d5a",
"clientData": {
"twitterHandles": "@johndoe",
"otherBrandNames": "enterfive",
...
...
}
}
```

> Response

```json
{
"message": "Successfully updated client data"
}
```

**Errors**
- 400 - Missing required parameters || Error updating client data
- 401 - Team member does not have edit capability || Error authenticating user
- 403 - Only POST request is allowed
- 404 - Team not found || Client does not exist
- 500 - Backend service error

## Get Survey Data

Get Survey data
Expand Down Expand Up @@ -1327,6 +1364,44 @@ Get client data
- 404 - Client or Team does not exist
- 500 - Backend service error

## Get Clients

Get clients data

> Endpoint: versus_v2_get_clients

> Payload

```json
{
"page": 1,
"size": 10,
"authstring": "13238bee-3ac9-4c77-b3b1"
}
```

> Response

```json
{
"message": "Successfully obtained clients",
"totalPages": 1,
"totalClients": 10,
"pageSize": 10,
"currentPage": 1,
"clients": [],

}
```

**Errors**

- 400 - Missing required parameters
- 401 - User is not authorized to make this request || Error authenticating user
- 404 - No record found
- 500 - Backend service error


## Get Subscription Status

Get subscription status
Expand Down