Skip to content

Monster API

Jump to bottom
atsanan edited this page Dec 23, 2018 · 40 revisions

5. Monsters

[x] 5.1 Get Player Monster info

GET /api/v1/monster/info?mPlayerId="5b4710930837139ebc444bae"

Query parameters:

Field Description Optional Auth
mPlayerId ID of the monster of this player No Yes

Returns:

{
    "data": {
        "_id": "5b4710930837139ebc444bae",
        "createAt": "2018-07-12T08:25:55.263Z",
        "mDefaultId": "5b332284bdfdd84f1fbd6793",
        "mPlayerFoodDatetime": "0001-01-01T00:00:00Z",
        "mPlayerHabit": 0,
        "mPlayerHappinessDatetime": "0001-01-01T00:00:00Z",
        "mPlayerHealthDatetime": "0001-01-01T00:00:00Z",
        "mPlayerName": "",
        "mPlayerStatusFood": 0,
        "mPlayerStatusHappiness": 0,
        "mPlayerStatusHealth": 0,
        "monstersDefault": {
            "_id": "5b332284bdfdd84f1fbd6793",
            "createAt": "2018-06-27T05:41:51.71Z",
            "lastModified": "2018-06-27T08:23:49.71Z",
            "mDefaultAssetImageSlot": "1",
            "mDefaultAssetModel": "1",
            "mDefaultAssetVersion": 1,
            "mDefaultGroupId": 1,
            "mDefaultGroupLevel": 1,
            "mDefaultJobCategories": [
                0
            ],
            "mDefaultJobLevel": 1,
            "mDefaultName": "mon-1",
            "mDefaultTextDetail": "bobo",
            "mDefaultTypeId": 1
        },
        "playerId": "5b2ca882bdfdd84f1fa5fe44"
    },
    "isSuccess": true
}

[x] 5.2 Update monster info

POST /api/v1/monster/info/{mPlayerId: string}

Form data:

Field Description Optional
mPlayerName - -
mPlayerHabit - -
mPlayerNewDateTime - -
mPlayerLastDateTime - -

Returns:

{
    "data": {
        "_id": "5b4710930837139ebc444bae",
        "createAt": "2018-07-12T08:25:55.263Z",
        "lastModified": "2018-07-19T15:56:13.878Z",
        "mDefaultId": "5b332284bdfdd84f1fbd6793",
        "mPlayerFoodDatetime": "2018-07-19T13:46:01.487Z",
        "mPlayerHabit": "8",
        "mPlayerHappinessDatetime": "2018-07-19T13:46:01.529Z",
        "mPlayerHealthDatetime": "2018-07-19T13:46:01.571Z",
        "mPlayerLastDateTime": "",
        "mPlayerName": "bobon",
        "mPlayerNewDateTime": "2006-01-02T08:04:05Z",
        "mPlayerStatusFood": 10,
        "mPlayerStatusHappiness": 10,
        "mPlayerStatusHealth": 10,
        "monstersDefault": {
            "_id": "5b332284bdfdd84f1fbd6793",
            "createAt": "2018-06-27T05:41:51.71Z",
            "lastModified": "2018-06-27T08:23:49.71Z",
            "mDefaultAssetImageSlot": "1",
            "mDefaultAssetModel": "1",
            "mDefaultAssetVersion": 1,
            "mDefaultGroupId": 1,
            "mDefaultGroupLevel": 1,
            "mDefaultJobCategories": [
                0
            ],
            "mDefaultJobLevel": 1,
            "mDefaultName": "mon-1",
            "mDefaultTextDetail": "bobo",
            "mDefaultTypeId": 1
        },
        "playerId": "5b2ca882bdfdd84f1fa5fe44"
    },
    "isSuccess": true
}

[x] 5.2.1 Update data monster food

POST /api/v1/monster/food/{mPlayerId: string}

Form data:

Field Description Optional
mPlayerStatusFood Add food's Code to monster No
mPlayerFoodId item id No

Returns:

{
    "data": {
        "id": "5b35ee0508371345dc8e4dff",
        "playerId": "5b2ca882bdfdd84f1fa5fe44",
        "mPlayerName": "",
        "mPlayerNewDateTime": "0001-01-01T00:00:00Z",
        "mPlayerLastDateTime": "0001-01-01T00:00:00Z",
        "mPlayerHabit": 0,
        "mPlayerStatusFood": 1,
        "mPlayerStatusHappiness": 0,
        "mPlayerStatusHealth": 0,
        "mPlayerFoodDatetime": "2018-07-05T12:20:53.907Z",
        "mPlayerHappinessDatetime": "0001-01-01T00:00:00Z",
        "mPlayerHealthDatetime": "0001-01-01T00:00:00Z",
        "mDefaultId": "5b332284bdfdd84f1fbd6793",
        "channelId": "",
        "createAt": "2018-06-29T08:29:57.696Z",
        "lastModified": "2018-07-05T12:16:00.156Z"
    },
    "isSuccess": true
}

[x] 5.2.2 Update data monster happy

POST /api/v1/monster/happy/{mPlayerId: string}

Form data:

Field Description Optional Auth
mPlayerStatusHappiness - No Yes
mPlayerHappyId item id No Yes

Returns:

{
    "data": {
        "id": "5b35ee0508371345dc8e4dff",
        "playerId": "5b2ca882bdfdd84f1fa5fe44",
        "mPlayerName": "",
        "mPlayerNewDateTime": "0001-01-01T00:00:00Z",
        "mPlayerLastDateTime": "0001-01-01T00:00:00Z",
        "mPlayerHabit": 0,
        "mPlayerStatusFood": 1,
        "mPlayerStatusHappiness": 3,
        "mPlayerStatusHealth": 0,
        "mPlayerFoodDatetime": "2018-07-06T04:26:57.683Z",
        "mPlayerHappinessDatetime": "2018-07-06T04:34:02.408Z",
        "mPlayerHealthDatetime": "0001-01-01T00:00:00Z",
        "mDefaultId": "5b332284bdfdd84f1fbd6793",
        "channelId": "",
        "createAt": "2018-06-29T08:29:57.696Z",
        "lastModified": "2018-07-06T04:29:07.766Z"
    },
    "isSuccess": true
}

[x] 5.2.3 Update data monster health

POST /api/v1/monster/health/{mPlayerId: string}

Form data:

Field Description Optional Auth
mPlayerStatusHealth - No Yes
mPlayerHealthId item id No Yes

Returns:

{
    "data": {
        "id": "5b35ee0508371345dc8e4dff",
        "playerId": "5b2ca882bdfdd84f1fa5fe44",
        "mPlayerName": "",
        "mPlayerNewDateTime": "0001-01-01T00:00:00Z",
        "mPlayerLastDateTime": "0001-01-01T00:00:00Z",
        "mPlayerHabit": 0,
        "mPlayerStatusFood": 5,
        "mPlayerStatusHappiness": 3,
        "mPlayerStatusHealth": 10,
        "mPlayerFoodDatetime": "2018-07-06T04:43:16.614Z",
        "mPlayerHappinessDatetime": "2018-07-06T04:34:02.408Z",
        "mPlayerHealthDatetime": "2018-07-06T04:49:03.933Z",
        "mDefaultId": "5b332284bdfdd84f1fbd6793",
        "channelId": "",
        "createAt": "2018-06-29T08:29:57.696Z",
        "lastModified": "2018-07-06T04:44:09.326Z"
    },
    "isSuccess": true
}

[x] 5.3 Get Player Monsters in bag

GET /api/v1/monster/inbag/{playerId : string}?page=0&limit=10&fields=mDefaultId

Query parameters:

Field Description Optional Default Auth
playerId Player's ID No - Yes
page Current page of monster in bag Yes 0 Yes
limit Maximum page of the bag Yes 10 Yes
fields Fields selection [mDefaultId] Yes - Yes

Returns:

{
    "data": {
        "monsters": [
            {
                "_id": "5b4710930837139ebc444bae",
                "createAt": "2018-07-12T08:25:55.263Z",
                "joinChannels": [],
                "mDefaultId": "5b332284bdfdd84f1fbd6793",
                "mPlayerFoodDatetime": "0001-01-01T00:00:00Z",
                "mPlayerHabit": 0,
                "mPlayerHappinessDatetime": "0001-01-01T00:00:00Z",
                "mPlayerHealthDatetime": "0001-01-01T00:00:00Z",
                "mPlayerName": "",
                "mPlayerStatusFood": 0,
                "mPlayerStatusHappiness": 0,
                "mPlayerStatusHealth": 0,
                "monsterDefault": {
                    "_id": "5b332284bdfdd84f1fbd6793",
                    "createAt": "2018-06-27T05:41:51.71Z",
                    "lastModified": "2018-06-27T08:23:49.71Z",
                    "mDefaultAssetImageSlot": "1",
                    "mDefaultAssetModel": "1",
                    "mDefaultAssetVersion": 1,
                    "mDefaultGroupId": 1,
                    "mDefaultGroupLevel": 1,
                    "mDefaultJobCategories": [
                        0
                    ],
                    "mDefaultJobLevel": 1,
                    "mDefaultName": "mon-1",
                    "mDefaultTextDetail": "bobo",
                    "mDefaultTypeId": 1
                },
                "playerId": "5b2ca882bdfdd84f1fa5fe44"
            }
        ],
        "pageIndex": 0,
        "pageLimit": 1,
        "pages": 189,
        "paging": {
            "next": "/api/v1/monster/inbag/5b2ca882bdfdd84f1fa5fe44?page=1&limit=1",
            "previous": ""
        }
    },
    "isSuccess": true
}

[x] 5.4 Get Player Monsters in channel.

GET /api/v1/monster/inChannel/{playerId : string}?page=0limit=10fields=mDefaultId

Query parameters:

Field Description Optional Default Auth
playerId Player's ID No - Yes
page Current page of monster in bag Yes 0 Yes
limit Maximum page of the bag Yes 10 Yes
fields Fields selection [mDefaultId] Yes - Yes

Returns:

{
    "data": {
        "monsters": [
            {
                "_id": "5b4710930837139ebc444bae",
                "createAt": "2018-07-12T08:25:55.263Z",
                "joinChannels": {
                    "_id": "5b3a13d0083713cebe481416",
                    "channelId": "5b3a13d0083713cebe481415",
                    "createAt": "2018-07-02T12:00:16.637Z",
                    "joinDateTime": "2018-07-02T12:00:16.637Z",
                    "mPlayerId": "5b4710930837139ebc444bae",
                    "playerId": "5b306dbdbdfdd84f1fae8b40"
                },
                "mDefaultId": "5b332284bdfdd84f1fbd6793",
                "mPlayerFoodDatetime": "0001-01-01T00:00:00Z",
                "mPlayerHabit": 0,
                "mPlayerHappinessDatetime": "0001-01-01T00:00:00Z",
                "mPlayerHealthDatetime": "0001-01-01T00:00:00Z",
                "mPlayerName": "",
                "mPlayerStatusFood": 0,
                "mPlayerStatusHappiness": 0,
                "mPlayerStatusHealth": 0,
                "monsterDefault": {
                    "_id": "5b332284bdfdd84f1fbd6793",
                    "createAt": "2018-06-27T05:41:51.71Z",
                    "lastModified": "2018-06-27T08:23:49.71Z",
                    "mDefaultAssetImageSlot": "1",
                    "mDefaultAssetModel": "1",
                    "mDefaultAssetVersion": 1,
                    "mDefaultGroupId": 1,
                    "mDefaultGroupLevel": 1,
                    "mDefaultJobCategories": [
                        0
                    ],
                    "mDefaultJobLevel": 1,
                    "mDefaultName": "mon-1",
                    "mDefaultTextDetail": "bobo",
                    "mDefaultTypeId": 1
                },
                "playerId": "5b2ca882bdfdd84f1fa5fe44"
            }
        ],
        "pageIndex": 0,
        "pageLimit": 1,
        "pages": 1,
        "paging": {
            "next": "",
            "previous": ""
        }
    },
    "isSuccess": true
}

[x] 5.5 Get All Player Monsters.

GET /api/v1/monster/all/{playerId : string}?page=0&limit=10&fields=mDefaultId

Query parameters:

Field Description Optional Default Auth
playerId Player's ID No - Yes
page Current page of monster in bag Yes 0 Yes
limit Maximum page of the bag Yes 10 Yes
fields Fields selection [mDefaultId] Yes - Yes

Returns:

{
    "data": {
        "monsters": [
            {
                "_id": "5b473243083713659d1b6cce",
                "createAt": "2018-07-12T10:49:39.678Z",
                "lastModified": "0001-01-01T00:00:00Z",
                "mDefaultId": "5b332284bdfdd84f1fbd6793",
                "mPlayerFoodDatetime": "0001-01-01T00:00:00Z",
                "mPlayerHabit": 0,
                "mPlayerHappinessDatetime": "0001-01-01T00:00:00Z",
                "mPlayerHealthDatetime": "0001-01-01T00:00:00Z",
                "mPlayerLastDateTime": "0001-01-01T00:00:00Z",
                "mPlayerName": "",
                "mPlayerNewDateTime": "0001-01-01T00:00:00Z",
                "mPlayerStatusFood": 0,
                "mPlayerStatusHappiness": 0,
                "mPlayerStatusHealth": 0,
                "monsterDefault": {
                    "_id": "5b332284bdfdd84f1fbd6793",
                    "createAt": "2018-06-27T05:41:51.71Z",
                    "lastModified": "2018-06-27T08:23:49.71Z",
                    "mDefaultAssetImageSlot": "1",
                    "mDefaultAssetModel": "1",
                    "mDefaultAssetVersion": 1,
                    "mDefaultGroupId": 1,
                    "mDefaultGroupLevel": 1,
                    "mDefaultJobCategories": [
                        0
                    ],
                    "mDefaultJobLevel": 1,
                    "mDefaultName": "mon-1",
                    "mDefaultTextDetail": "bobo",
                    "mDefaultTypeId": 1
                },
                "playerId": "5b2ca882bdfdd84f1fa5fe44"
            }
        ],
        "pageIndex": 10,
        "pageLimit": 1,
        "pages": 180,
        "paging": {
            "next": "/api/v1/monster/all/5b2ca882bdfdd84f1fa5fe44?page=11&limit=1",
            "previous": "/api/v1/monster/all/5b2ca882bdfdd84f1fa5fe44?page=9&limit=1"
        }
    },
    "isSuccess": true
}

[x] 5.6 Update quest1 Player Monsters.

POST /api/v1/monster/quest1/{mPlayerId: string}

Form :

Field Description Optional Default Auth
mPlayerStatusQuest1 mPlayerStatusQuest1 No - Yes

Returns:

{
    "data": {
        "_id": "5c1cb034e13823e840e00bab",
        "createAt": "2018-12-21T09:19:48.21Z",
        "lastModified": "2018-12-23T15:33:32.457Z",
        "mDefaultId": "5bda98529dc6d63a7a67a692",
        "mPlayerExpDatetime": "2018-12-21T09:19:48.21Z",
        "mPlayerFoodDatetime": "2018-12-23T09:00:20.928Z",
        "mPlayerFoodId": "5bf51b1c9dc6d624f7398182",
        "mPlayerHabit": 0,
        "mPlayerHappinessDatetime": "2018-12-23T09:00:21.486Z",
        "mPlayerHappyId": "5bf51b1c9dc6d624f7398182",
        "mPlayerHealthDatetime": "2018-12-23T09:00:21.966Z",
        "mPlayerHealthId": "5bf51b1c9dc6d624f7398182",
        "mPlayerLastDateTime": "2018-12-21T09:19:48.21Z",
        "mPlayerMessage": "",
        "mPlayerName": "",
        "mPlayerNewDateTime": "2018-12-21T09:19:48.21Z",
        "mPlayerQuest1Datetime": "2018-12-23T15:33:32.456Z",
        "mPlayerQuest2Datetime": "2018-12-21T09:19:48.21Z",
        "mPlayerQuest3Datetime": "2018-12-21T09:19:48.21Z",
        "mPlayerStatusExp": 0,
        "mPlayerStatusFood": 1,
        "mPlayerStatusHappiness": 1,
        "mPlayerStatusHealth": 1,
        "mPlayerStatusQuest1": 1,
        "mPlayerStatusQuest2": 0,
        "mPlayerStatusQuest3": 0,
        "playerId": "5c1cafe214b201b38be401f4"
    },
    "isSuccess": true
}

[x] 5.7 Update quest2 Player Monsters.

POST /api/v1/monster/quest2/{mPlayerId: string}

Form :

Field Description Optional Default Auth
mPlayerStatusQuest2 mPlayerStatusQuest2 No - Yes

Returns:

{
    "data": {
        "_id": "5c1cb034e13823e840e00bab",
        "createAt": "2018-12-21T09:19:48.21Z",
        "lastModified": "2018-12-23T15:33:32.457Z",
        "mDefaultId": "5bda98529dc6d63a7a67a692",
        "mPlayerExpDatetime": "2018-12-21T09:19:48.21Z",
        "mPlayerFoodDatetime": "2018-12-23T09:00:20.928Z",
        "mPlayerFoodId": "5bf51b1c9dc6d624f7398182",
        "mPlayerHabit": 0,
        "mPlayerHappinessDatetime": "2018-12-23T09:00:21.486Z",
        "mPlayerHappyId": "5bf51b1c9dc6d624f7398182",
        "mPlayerHealthDatetime": "2018-12-23T09:00:21.966Z",
        "mPlayerHealthId": "5bf51b1c9dc6d624f7398182",
        "mPlayerLastDateTime": "2018-12-21T09:19:48.21Z",
        "mPlayerMessage": "",
        "mPlayerName": "",
        "mPlayerNewDateTime": "2018-12-21T09:19:48.21Z",
        "mPlayerQuest1Datetime": "2018-12-23T15:33:32.456Z",
        "mPlayerQuest2Datetime": "2018-12-21T09:19:48.21Z",
        "mPlayerQuest3Datetime": "2018-12-21T09:19:48.21Z",
        "mPlayerStatusExp": 0,
        "mPlayerStatusFood": 1,
        "mPlayerStatusHappiness": 1,
        "mPlayerStatusHealth": 1,
        "mPlayerStatusQuest1": 1,
        "mPlayerStatusQuest2": 1,
        "mPlayerStatusQuest3": 0,
        "playerId": "5c1cafe214b201b38be401f4"
    },
    "isSuccess": true
}

[x] 5.8 Update quest3 Player Monsters.

POST /api/v1/monster/quest3/{mPlayerId: string}

Form :

Field Description Optional Default Auth
mPlayerStatusQuest3 mPlayerStatusQuest3 No - Yes

Returns:

{
    "data": {
        "_id": "5c1cb034e13823e840e00bab",
        "createAt": "2018-12-21T09:19:48.21Z",
        "lastModified": "2018-12-23T15:33:32.457Z",
        "mDefaultId": "5bda98529dc6d63a7a67a692",
        "mPlayerExpDatetime": "2018-12-21T09:19:48.21Z",
        "mPlayerFoodDatetime": "2018-12-23T09:00:20.928Z",
        "mPlayerFoodId": "5bf51b1c9dc6d624f7398182",
        "mPlayerHabit": 0,
        "mPlayerHappinessDatetime": "2018-12-23T09:00:21.486Z",
        "mPlayerHappyId": "5bf51b1c9dc6d624f7398182",
        "mPlayerHealthDatetime": "2018-12-23T09:00:21.966Z",
        "mPlayerHealthId": "5bf51b1c9dc6d624f7398182",
        "mPlayerLastDateTime": "2018-12-21T09:19:48.21Z",
        "mPlayerMessage": "",
        "mPlayerName": "",
        "mPlayerNewDateTime": "2018-12-21T09:19:48.21Z",
        "mPlayerQuest1Datetime": "2018-12-23T15:33:32.456Z",
        "mPlayerQuest2Datetime": "2018-12-21T09:19:48.21Z",
        "mPlayerQuest3Datetime": "2018-12-21T09:19:48.21Z",
        "mPlayerStatusExp": 0,
        "mPlayerStatusFood": 1,
        "mPlayerStatusHappiness": 1,
        "mPlayerStatusHealth": 1,
        "mPlayerStatusQuest1": 1,
        "mPlayerStatusQuest2": 1,
        "mPlayerStatusQuest3": 1,
        "playerId": "5c1cafe214b201b38be401f4"
    },
    "isSuccess": true
}

[x] 5.9 Update Exp Player Monsters.

POST /api/v1/monster/exp/{mPlayerId: string}

Form :

Field Description Optional Default Auth
exp exp No - Yes

Returns:

{
    "data": {
        "_id": "5c1cb034e13823e840e00bab",
        "createAt": "2018-12-21T09:19:48.21Z",
        "lastModified": "2018-12-23T15:33:32.457Z",
        "mDefaultId": "5bda98529dc6d63a7a67a692",
        "mPlayerExpDatetime": "2018-12-21T09:19:48.21Z",
        "mPlayerFoodDatetime": "2018-12-23T09:00:20.928Z",
        "mPlayerFoodId": "5bf51b1c9dc6d624f7398182",
        "mPlayerHabit": 0,
        "mPlayerHappinessDatetime": "2018-12-23T09:00:21.486Z",
        "mPlayerHappyId": "5bf51b1c9dc6d624f7398182",
        "mPlayerHealthDatetime": "2018-12-23T09:00:21.966Z",
        "mPlayerHealthId": "5bf51b1c9dc6d624f7398182",
        "mPlayerLastDateTime": "2018-12-21T09:19:48.21Z",
        "mPlayerMessage": "",
        "mPlayerName": "",
        "mPlayerNewDateTime": "2018-12-21T09:19:48.21Z",
        "mPlayerQuest1Datetime": "2018-12-23T15:33:32.456Z",
        "mPlayerQuest2Datetime": "2018-12-21T09:19:48.21Z",
        "mPlayerQuest3Datetime": "2018-12-21T09:19:48.21Z",
        "mPlayerStatusExp": 0,
        "mPlayerStatusFood": 1,
        "mPlayerStatusHappiness": 1,
        "mPlayerStatusHealth": 1,
        "mPlayerStatusQuest1": 1,
        "mPlayerStatusQuest2": 1,
        "mPlayerStatusQuest3": 1,
        "playerId": "5c1cafe214b201b38be401f4"
    },
    "isSuccess": true
}

Clone this wiki locally