

Skeleton Endpoint

Skels

• Description
• Structure
  • Default Properties
  • Conditional Properties
• Crossbar
  • GET
  • GET
  • PUT
  • POST
  • DELETE

About Skels

Description of the skel module goes here.

Schema

Fetch

GET /v2/accounts/{ACCOUNT_ID}/skels

More description if needed!

curl -v -X GET \
    -H "X-Auth-Token: {AUTH_TOKEN}" \
http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/skels

{
    "data": [
        {
            "name": "John",
            "email": "john@email.com",
            "stuff": [
                "stuff1"
            ],
            "age": 30,
            "city": "San Francisco",
            "zipcode": 94109
        },
        {
            "name": "Jane",
            "email": "Jane@email.com",
            "stuff": [
                "stuff2"
            ],
            "age": 28,
            "city": "San Francisco",
            "zipcode": 94109
        }
    ],
    "page_size": 2,
    "request_id": "{REQUEST_ID}",
    "status": "success",
    "auth_token": "{AUTH_TOKEN}"
}

Create a resource

PUT /v2/accounts/{ACCOUNT_ID}/skels

More description if needed!

curl -v -X PUT \
    -H "X-Auth-Token: {AUTH_TOKEN}" \
    -d '{"data": {
        "name": "Jane",
        "email": "Jane@email.com",
        "stuff": ["stuff2"],
        "age": 28,
        "city": "San Francisco",
        "zipcode": 94109
        }}' \
    http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/skels

{
    "data": {
        "name": "Jane",
        "email": "Jane@email.com",
        "stuff": [
            "stuff2"
        ],
        "age": 28,
        "city": "San Francisco",
        "zipcode": 94109
    },
    "request_id": "{REQUEST_ID}",
    "status": "success",
    "auth_token": "{AUTH_TOKEN}"
}

Delete a resource

DELETE /v2/accounts/{ACCOUNT_ID}/skels/{THING}

More description if needed!

curl -v -X DELETE \
    -H "X-Auth-Token: {AUTH_TOKEN}" \
    http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/skels/{THING}

{
    "data": {},
    "request_id": "{REQUEST_ID}",
    "status": "success",
    "auth_token": "{AUTH_TOKEN}"
}

Get a resource

GET /v2/accounts/{ACCOUNT_ID}/skels/{THING}

More description if needed!

curl -v -X GET \
    -H "X-Auth-Token: {AUTH_TOKEN}" \
    http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/skels/{THING}

{
    "data": {
        "name": "Jane",
        "email": "Jane@email.com",
        "stuff": [
            "stuff2"
        ],
        "age": 28,
        "city": "San Francisco",
        "zipcode": 94109
    },
    "request_id": "{REQUEST_ID}",
    "status": "success",
    "auth_token": "{AUTH_TOKEN}"
}

Update a resource

POST /v2/accounts/{ACCOUNT_ID}/skels/{THING}

PATCH /v2/accounts/{ACCOUNT_ID}/skels/{THING}

More description if needed!

curl -v -X POST \
    -H "X-Auth-Token: {AUTH_TOKEN}" \
    -d '{"data": {
        "name": "Jane",
        "email": "jane@email.com",
        "stuff": ["some new stuff"],
        "age": 29,
        "city": "San Francisco",
        "zipcode": 94109
        }}' \
    http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/skels/{THING}

{
    "data": {
        "name": "Jane",
        "email": "jane@email.com",
        "stuff": [
            "some new stuff"
        ],
        "age": 29,
        "city": "San Francisco",
        "zipcode": 94109
    },
    "request_id": "{REQUEST_ID}",
    "status": "success",
    "auth_token": "{AUTH_TOKEN}"
}