Platform Routes

Part of REST API Documentation (v0.1.0) last public on August 5, 2023 at 12:00 AM UTC. You may see previous version(s) of the zone.

The routes listed in this page allows the client to perform CRUD operations on platform resources for the authenticated user.

Platforms are websites that knows the authenticated user which may require a common username/password info (intraplatform credentials), or through the use of other accounts in other platforms (interplatform credentials).

`GET/api/v1/platforms`

Allows the client to have a list of platforms existing for the current user.

Request Info

There are no inputs needed to invoke the route.

Defined Responses

Route may return a status code of 200.

It returns a response having application/json as its content type with a schema of:

{
	"platforms": [
		{
			"id": "number",
			"user_id": "number",
			"name": "string",
			"address": "string",
			"created_at": "string",
			"updated_at": "string"
		}
	]
}

`GET/api/v1/platforms/[platform_id]`

Allows the client to request a specific platform info.

Request Info

There are no inputs needed to invoke the route.

Defined Responses

Route may return a status code of 200.

It returns a response having application/json as its content type with a schema of:

{
	"platform": {
		"id": "number",
		"user_id": "number",
		"name": "string",
		"address": "string",
		"created_at": "string",
		"updated_at": "string"
	}
}

`POST/api/v1/platforms`

Allows the client to create platform info.

Request Info

It requires an input having application/json with a schema of:

{
	"platform": {
		"name": "string",
		"address": "string"
	}
}

Defined Responses

Route may return a status code of 201.

It returns a response having application/json as its content type with a schema of:

{
	"platform": {
		"id": "number",
		"user_id": "number",
		"name": "string",
		"address": "string",
		"created_at": "string",
		"updated_at": "string"
	}
}

`PUT/api/v1/platforms/[platform_id]`

Allows the client to update platform info.

Request Info

It requires an input having application/json with a schema of:

{
	"platform": {
		"name": "string",
		"address": "string"
	}
}

Defined Responses

Route may return a status code of 204.

`DELETE/api/v1/platforms/[platform_id]`

Allows the client to delete platform info.

Request Info

There are no inputs needed to invoke the route.

Defined Responses

Route may return a status code of 204.

Previous versions

There are no previous versions yet. Check back in the future.