Platform

List of all supported platforms

API Endpoint

URL {base url}/api/References/GetPlatforms
Method GET
Authorization Bearer Token
Content-Type application/json

Request Headers

Parameter Type Required Description
APIKEY string true System key code

Request Parameters

Parameter Type Required Description
filter string false Platform ID / Name / Tag

Request Example


    {base url}/api/References/GetPlatforms?filter={}

Response Parameters

Parameter Type Description
Id integer Error status (e.g. 0 = No error)
Success boolean Request success status
Message string Response message
RequestId string Request reference ID
Size integer Number of records
Data object Platform data

Data

Parameter Type Description
Id string Platform ID
Code string Platform code
Name string Platform name
ShotName string Short name
PType string Platform type
Tag string Platform tag

Response JSON Example


{
    "Id": 0,
    "Success": true,
    "Message": "SUCCESS",
    "RequestId": "68AD786C-50FE-4194-9826-F0F18591ABBB",
    "Size": 3,
    "Data": [
        {
            "Id": "A156450F9B3447B59978EF249038DA40",
            "Code": "SHP",
            "Name": "Shopee",
            "ShotName": "Shopee",
            "PType": "ONL",
            "Tag": "#shopee"
        },
        {
            "Id": "37FD73618BEB40B48EF83F7EA8FF3AA6",
            "Code": "LZD",
            "Name": "Lazada",
            "ShotName": "Lazada",
            "PType": "ONL",
            "Tag": "#lazada"
        },
        {
            "Id": "70AFBDB510B34FC69C47D78649B2323D",
            "Code": "BL-OMS",
            "Name": "BL-OMS",
            "ShotName": "BL-OMS",
            "PType": "BTL",
            "Tag": "#bl-oms#offline"
        }
    ]
}