Model

ProgramProgress programProgress{
        "_id": {
        "autogenerated": "true"
    },
    "program": {
        "ref": "Program._ObjectId"
    },
    "user": {
        "ref": "User._ObjectId"
    },
    "no_steps": {
        "type": "number"
    },
    "is_completed": {
        "type": "boolean",
        "default": "false"
    },
    "weeks_completed": {
        "type": ["string"]
    },
    "days_completed": {
        "type": ["string"]
    },
    "steps_completed": {
        "type": ["string"] 
    },
    "selectedWeek": {
        "virtual": "true"
    },
    "selectedWeekIndex": {
        "virtual": "true"
    },
    "selectedDay": {
        "virtual": "true"
    },
    "selectedDayIndex": {
        "virtual": "true"
    },
    "selectedStep": {
        "virtual": "true"
    },
    "selectedStepIndex": {
        "virtual": "true"
    },
    "about_section": {
        "virtual": "true"
    },
    "selected": {
        "type": "boolean",
        "default": false
    },
    "percentage": {
        "virtual": "true"
    },
    "createdAt": {
        "autogenerated": "true"
    },
    "updatedAt": {
        "autogenerated": "true"
    }
}

Methods

Create new

POST //program-progress req.body required

method: 'POST'
{
    url: 'https://{{your-builderly-domain}}//program-progress',
    headers: {
        'Authorization': 'Bearer ' + token
    },
    json: true,
    body: {program_progress}
}

Responses Success - status 201

{ program_progess_id }

Error - status 400

{
    error_message
}

Retrieve multiple

GET /program-progress

method: 'GET'
{
    url: 'https://{{your-builderly-domain}}/program-progress',
    headers: {},
    json: true,
    body: {}
}

Responses Success - status 200

[ program-progress ]

Error - status 400

{
    error_message
}

• Example usages: /program-progress - Get all program progresses

Retrieve single

GET /program-progress/:id?ionic=true

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

Responses Success - status 200

{ res_obj }

Not found - status 404

{}

Error - status 500

{
    error_message
}

• Example usages: /program-progress/:id?ionic=true - Retrives a specific program progress

Update single

PATCH /program-progress/:id

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

Responses Success - status 200

{ program-progress }

Error - status 400

{
    error_message
}

Not found - status 404

{}

Delete single

DELETE /program-progress/:id

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

Responses Success - status 200

{ program-progress }

Not found - status 404

{}

Error - status 500

{
    error_message
}