Pathwar API

Official Pathwar REST Api

Authentication

To be defined

Media Types

This API uses the json media-type to represent resources states and affordances.

Requests with a message-body are using plain JSON to set or update resource states.

Error States

The common HTTP Response Status Codes are used.

People

This section describes about the People

User

This resource represents one particular user identified by its id.

Retrieve User

GET

/user/{id}

Return the information for the User

Parameters
id
string (required) Example: 1
The id of the User.

RequestShowHide
Headers
```
Content-Type: application/json
```
Response 200ShowHide

JSON representation of User resource.

Headers

Content-Type: application/json

Body

{
  "name": "m1ch3l",
  "birthdate": "04-02-1942",
  "organization_id": "xxxx-xxxxxx-xxxxxx-xxxx"
}

Organization

This resource represents one particular organization identified by its id.

Retrieve Organization

GET

/organization/{id}

Return the information for the Organization

RequestShowHide
Headers
```
Content-Type: application/json
```
Response 200ShowHide

JSON representation of Organization resource.

Headers

Content-Type: application/json

Body

{
  "name": "ulteam",
  "members": [
    "xxxx-xxxxxx-xxxxxx-xxxx",
    "xxxx-xxxxxx-xxxxxx-xxxx",
  ]
}

Level

This section describes about the Level

Level

This resource represents one particular level identified by its id.

Retrieve Level

GET

/level/{id}

Return the information for the Level

RequestShowHide
Headers
```
Content-Type: application/json
```
Response 200ShowHide

JSON representation of a Level resource.

Headers

Content-Type: application/json

Body

{
  "name": "pwnland",
  "description": "pwnland is cool",
  "author": "Pathwar Team (@pathwar_net)"
}

Coupon

This section describes about the Coupon

Coupon

This resource represents one particular coupon identified by its id.

Retrieve Achievement

GET

/coupon/{id}

Return the information for the Achievement

RequestShowHide
Headers
```
Content-Type: application/json
```
Response 200ShowHide

JSON representation of a Achievement resource.

Headers

Content-Type: application/json

Body

{
  "name": "hack the planet",
  "description": "Finish all the levels"
}

Achievement

This section describes about the Achievement

Achievement

This resource represents one particular achievement identified by its id.

Retrieve Achievement

GET

/achievement/{id}

Return the information for the Achievement

RequestShowHide
Headers
```
Content-Type: application/json
```
Response 200ShowHide

JSON representation of a Achievement resource.

Headers

Content-Type: application/json

Body

{
  "name": "hack the planet",
  "description": "Finish all the levels"
}