TrackerProgress - OgnianApostolov/builderly-api-docs GitHub Wiki

Model

TrackerProgress trackerProgress {
    "_id": {
        "autogenerated": "true"
    },
    "score": {
        "type": "string"
    },
    "user_id": {
        "ref": "User._ObjectId"
    },
    "media": { 
        "type": "buffer"
    },
    "createdAt": {
        "autogenerated": "true"
    },
    "updatedAt": {
        "autogenerated": "true"
    }
}

Methods

Create new

POST /tracker-progress?ionic=true req.body required

method: 'POST'
{
    url: 'https://{{your-builderly-domain}}/tracker-progress?ionic=true,
    headers: {
        'Authorization': 'Bearer ' + token
    },
    json: true,
    body: {}
}

Responses Success - status 201

{}

Error - status 400

{
    error_message
}

Retrieve multiple

GET /tracker-progress?ionic=true

method: 'GET'
{
    url: 'https://{{your-builderly-domain}}/tracker-progress?ionic=true',
    headers: {
        'Authorization': 'Bearer ' + token
    },
    json: true,
    body: {}
}

Responses Success - status 200

{
    title,
    tracker_progress,
    site_name
}

Error - status 500

{
    error_message
}
  • Example usages: /tracker_progress?ionic=true - Get all tracker progresses

Retrieve single

GET /tracker_progress/:id

method: 'GET'
{
    url: 'https://{{your-builderly-domain}}/tracker_progress/{{tracker_progress._id}}',
    headers: {
        'Authorization': 'Bearer ' + token
    },
    json: true,
    body: {}
}

Responses Success - status 200

{
    tracker_progress
}

Not found - status 404

{}

Error - status 500

{
    error_message
}
  • Example usages: /tracker_progress/:id?ionic=true - Retrives a specific tracker progresss

Update single

PATCH /tracker_progress/:id

method: 'PATCH'
{
    url: 'https://{{your-builderly-domain}}/tracker_progress/{{tracker_progress._id}}',
    headers: {
        'Authorization': 'Bearer ' + token
    },
    json: true,
    body: {}
}

Responses Success - status 200

{ tracker_progress }

Error - status 400

{
    error_message
}

Not found - status 404

{}

Delete single

DELETE /tracker_progress/:id?

method: 'DELETE'
{
    url: 'https://{{your-builderly-domain}}/tracker_progress/{{tracker_progress._id}}',
    headers: {
        'Authorization': 'Bearer ' + token
    },
    json: true,
    body: {}
}

Responses Success - status 200

{ tracker_progress }

Not found - status 404

{}

Error - status 500

{
    error_message
}