Bol accounts

All endpoints that are created for managing bol accounts.

Create a new bol user in the database.

POST https://dev.bol.mintycloud.nl/api/v1/accounts/bol

This endpoint creates a new bol user into the database.

Request Body

Name	Type	Description
userId*	Number	db userId.
clientId*	String	Bol clientId
secret*	String	Bol secret
country*	String	Country (Netherlands)
label*	String	Country label (nl, be, nl-be)

200: OK Created successfully bol account

{
    "bolUserId": 1
}

400: Bad Request Missing details.

{
    "error": "Missing details"
}

401: Unauthorized Incorrect API key

500: Internal Server Error Database error

{
    "error": "Failed to add account"
}

Get all bol user.

GET https://dev.bol.mintycloud.nl/api/v1/accounts/bol

This endpoint is used for getting all bol users from the database.

200: OK

[
    {
        "userId": 1,
        "bolUserId": 1,
        "clientId": "50343e9d-66b2-3d74-9eda-2e53485674dd6",
        "secret": ".OP!(d?#[p[D6dk?Y^1[rYCviefESOScWD3[I31d?q5!!VLv!WD7tt!xJ}ODszOP",
        "country": "Netherlands",
        "label": "nl",
        "errorCount": 0,
        "lastError": "0000-00-00 00:00:00.000"
    },
    {
        "userId": 1,
        "bolUserId": 2,
        "clientId": "50343e9d-66b2-3d74-9eda-2e53485674dd6",
        "secret": ".OP!(d?#[p[D6dk?Y^1[rYCviefESOScWD3[I31d?q5!!VLv!WD7tt!xJ}ODszOP",
        "country": "Netherlands",
        "label": "nl",
        "errorCount": 0,
        "lastError": "0000-00-00 00:00:00.000"
    }
]

401: Unauthorized Incorrect API Key

{
    // Response
}

500: Internal Server Error Database error

{
    // Response
}

Get an existing bol user.

GET https://dev.bol.mintycloud.nl/api/v1/accounts/bol/:bolUserId

Get a bol user by their identifier.

Path Parameters

Name	Type	Description
bolUserId*	Number	Bol user identifier

200: OK

{
    "userId": 13,
    "bolUserId": 1,
    "clientId": "50343e9d-66b2-3d74-9eda-2e53485674dd6",
    "secret": ".OP!(d?#[p[D6dk?Y^1[rYCviefESOScWD3[I31d?q5!!VLv!WD7tt!xJ}ODszOP",
    "country": "Netherlands",
    "label": "nl",
    "errorCount": 0,
    "lastError": "0000-00-00 00:00:00.000"
}

401: Unauthorized Incorrect API key

500: Internal Server Error Database error

Update an existing bol user.

PUT https://dev.bol.mintycloud.nl/api/v1/accounts/bol/:bolUserId

Update bol user information.

Path Parameters

Name	Type	Description
bolUserId*	Number	Bol user identifier

Request Body

Name	Type	Description
clientId	String	Bol clientId
secret	String	Bol secret
country	String	Country (Netherlands)
label	String	Country label (nl, be, nl-be)
addError	Number	Add number to the error count.

200: OK Updated account successfully

{
    "message": "Bol User 1 updated."
}

400: Bad Request No data provided.

{
    "error": "No data provided."
}

401: Unauthorized Incorrect API key

500: Internal Server Error Database error

400: Bad Request No valid data provided.

{
    "error": "No valid data provided."
}

404: Not Found Didn't update any user information.

{
    "error": "Didn't update any user information."
}

Delete an existing bol user.

DELETE https://dev.bol.mintycloud.nl/api/v1/accounts/bol/:bolUserId

Delete bol user information.

Path Parameters

Name	Type	Description
bolUserId*	String	Bol user identifier

204: No Content Deleted bol account successfully.

401: Unauthorized Incorrect API key

500: Internal Server Error Database error

404: Not Found Bol User not found.

{
    "error": "Bol User not found."
}