Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/atlasacademy/submissions.atlasacademy.io

Last synced: about 1 month ago
JSON representation

Host: GitHub
URL: https://github.com/atlasacademy/submissions.atlasacademy.io
Owner: atlasacademy
Created: 2019-04-05T06:08:18.000Z (almost 6 years ago)
Default Branch: master
Last Pushed: 2023-02-02T09:45:05.000Z (almost 2 years ago)
Last Synced: 2023-03-05T06:50:24.320Z (almost 2 years ago)
Language: PHP
Size: 3.6 MB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 4
Metadata Files:
- Readme: readme.md

Awesome Lists containing this project

README

# submissions.atlasacademy.io

submissions.atlasacademy.io is a API service intended for
connecting the submissions and drop rate sheets with other
outside services and devices.

### Available Routes

- GET /event
- GET /event/{uid}
- GET /event/{event_uid}/{event_node_uid}/submissions
- POST /submit/run
- POST /submit/revert

### /event

Returns
```javascript
[event, ...]
```

### /event/{uid}
Returns
```javascript
{
...event,
nodes: [node, ...],
drops: [drop, ...],
node_drops: [node_drop, ...]
}
```

### /event/{event_uid}/{event_node_uid}/submissions
Expects
```javascript
{
after_receipt: receipt
}
```

Returns
```javascript
[submission, ...]
```

### /submit/run
Expects
```javascript
{
event_uid: event.uid,
event_node_uid: event.nodes[#].uid,
submitter: "Optional",
token: "Needs to be set if wanted to revert submission",
drops: [
{
uid: event.node_drops[#].uid,
quantity: event.node_drops[#].quantity,
count: Number,
ignored: Boolean
}
...
]
}
```

Returns
```javascript
{
status: "Success",
receipt: "Receipt id",
missing_drops: "Bool. Indicates if submissions was missing drops (not ignored). Helps app know if refresh of data is required."
}
```

### Event Object

```javascript
{
uid: "Unique string identifier",
sheet_type: "Internal flag for import/export adapter",
sheet_id: "Google sheets id",
name: "Event name",
node_filter: "Regex to filter out only applicable nodes",
submittable: "Bool of if event allows /submit requests"
}
```

### Node Object

```javascript
{
event_uid: "Event uid",
uid: "Unique string identifier",
name: "Node name",
sheet_name: "Google sheet tab",
submissions: "Number of total submissions",
submitters: "Number of unique submitters"
}
```

### Drops Object

```javascript
{
uid: "Drop uid",
name: "Drop name",
type: "Bonus Rate-Up, Material, or QP",
quantity: "Some drops have their own embedded quantity. Such as Q050 = 5,000 QP",
image: "Url to hosted image",
image_original: "Url to original image",
event: "Bool of if this drop is event only"
}
```

### NodeDrops Object

```javascript
{
event_uid: "Event uid",
event_node_uid: "Event Node uid",
uid: "Drop uid",
quantity: "This quantity field overrides the drops.quantity field if enabled",
rate: "Drop rate",
apd: "AP per drop",
count: "Number of drops recorded",
submissions: "Number of submissions recorded"
}
```

### Submission Object

```javascript
{
receipt: "Unique receipt id",
event_uid: "Event uid",
event_node_uid: "Event Node uid",
submitter: "Name of submitter",
drops: [
{
uid: "Drop uid",
quantity: "Drop quantity. The multiplier for the drop.",
count: "Drop count. The value that is submitted by the user.",
ignored: "Bool on whether user didn't track drop"
},
...
]
}
```