get-schedule

README

Module/Method INFORMATION:GET_SCHEDULE (information.get_schedule)

Module "Get Schedule" (INFORMATION:GET_SCHEDULE) is a service method to retreive list of schedule information from KAI Train (RailTicket) Web Service [1].

The following are the sections available in this guide.

• Use Case
• Prerequisites
• Implementation
• Build and Running

Use Case

Let’s retrieve schedule information from KAI Train Web Service Endpoint.

Prerequisites

• KAI Train Web Service Client for Go (kaiwsdkv2 GoLang package)

go get github.com/ClientSDK/kai-train-ws-client-go/kaiwsdkv2

• A Text Editor or an IDE

KAI Agent requirements

• KAI Train (RailTicket) Agent Credential Account (RQID)
• KAI Train (RailTicket) Web Service Access (IP Whitelist) ( Production Server, Demo Server)

Implementation

If you want to skip the basics, you can download the git repo and directly move to the "Build and Running" section by skipping "Implementation" section.

Example structure

Go is a complete programming language that supports custom project structures. Let's use the following package structure for this example.

get-schedule
   ├── build_and_run.sh
   └── main.go

• Create the above directories in your local machine and also create empty main.go and build_and_run.sh files.

Developing the application

Let's make a simple application for getting list of schedule information using kaiwsdkv2 package.

Main code for "information.get_schedule" (main.go)

package main

import (
	"crypto/tls"
	"encoding/json"
	"fmt"
	"log"
	"net/http"
	"net/url"
	"time"

	"github.com/ClientSDK/kai-train-ws-client-go/kaiwsdkv2"
)

const (
	kaiServer = "https://railticket.kereta-api.co.id/" // Production Server
	// kaiServer = "http://ws.demo.kai.sqiva.com/"		// Demo Server
	kaiRQID = "YOUR-KAI-AGENT-CREDENTIAL-RQID"
)

func makeHTTPClient() *http.Client {
	// Access via proxy if needed
	proxyURL, _ := url.Parse("http://proxy-ip-address:proxy-port")
	//proxyURL, _ := url.Parse("http://proxy-user:proxy-password@proxy-ip-address:proxy-port")

	// Initiate transport with proxy and skip TLS
	tr := &http.Transport{
		Proxy:           http.ProxyURL(proxyURL),
		TLSClientConfig: &tls.Config{InsecureSkipVerify: true},
	}

	// Initiate transport without proxy and skip TLS
	// tr := &http.Transport{
	//	TLSClientConfig: &tls.Config{InsecureSkipVerify: true},
	// }

	// Using Transport
	httpClient := &http.Client{Transport: tr}

	return httpClient
}

func main() {

	// init http client
	httpClient := makeHTTPClient()

	// Initiate NewKAIHttpClient version 2
	kaiClient, err := kaiwsdkv2.NewKAIHttpClient(httpClient, kaiServer, kaiRQID)
	if err != nil {
		log.Fatal(err)
	}

	// call KAI web service method
	callGetSchedule(kaiClient)
}

func callGetSchedule(kaiClient *kaiwsdkv2.KAIHttpClient) {

	params := make(map[string]string)

	params["org"] = "BD"
	params["des"] = "GMR"
	currentDate := time.Now().Local()
	params["dep_date"] = currentDate.AddDate(0, 0, 7).Format("20060102")

	vRS, err := kaiClient.CallGetSchedule(params, false)

	if err != nil {
		log.Fatal(err)
	}

	// sample how to Access Response
	// fmt.Println(vRS.ErrCode)
	// fmt.Println(vRS.ErrMsg)
	// fmt.Println(vRS.Return.Origin)
	// fmt.Println(vRS.Return.Destination)
	// fmt.Println(vRS.Return.DepartureDate)
	// fmt.Println(vRS.Return.Schedules[0].TrainName)
	// fmt.Println(vRS.Return.Schedules[0].AvailSubClass[0].SubClass)

	// if you want to retreive KAI Origin Response
	// fmt.Println(string(kaiClient.KAIRealResponseBody))

	json, _ := json.Marshal(vRS)
	fmt.Println(string(json))
}

Bash code for building and running the example application (build_and_run.sh)

echo "Clean..."
rm ./information.get_schedule
echo "Build..."
go build -o information.get_schedule main.go 
echo "Build Done..."
echo "Run..."
./information.get_schedule > information.get_schedule-rs.json
echo "Done."

Build and Running

You can build and running by execute the "build_and_run.sh" bash files.

   $ sh build_and_run.sh 

After the application is running, you will get the json response in information.get_schedule-rs.json files.

Sample Response

Sample KAI Response:

    // Get KAI Response Raw from KAIHttpClient Struct 
    KAIHttpClient.KAIRealResponseBody

{
    "err_code": 0,
    "org": "BD",
    "des": "GMR",
    "dep_date": "20191201",
    "schedule": [
        [
            "10501",
            "ARGO PARAHYANGAN PREMIUM",
            "0415",
            "0725",
            [
                [
                    "C",
                    799,
                    "K",
                    100000,
                    0,
                    0
                ]
            ]
        ],
        [
            "77A",
            "ARGO GOPAR",
            "1200",
            "1500",
            [
                [
                    "A",
                    50,
                    "E",
                    100000,
                    0,
                    0
                ],
                [
                    "B",
                    50,
                    "B",
                    90000,
                    0,
                    0
                ],
                [
                    "C",
                    50,
                    "K",
                    60000,
                    0,
                    0
                ]
            ]
        ]
    ]
}

Sample Internal Response:

    // Get Internal Response Raw from KAIHttpClient Struct 
    KAIHttpClient.KAIResponseBody

 {
    "errCode": "0",
    "errMsg": null,
    "return": {
        "origin": "BD",
        "destination": "GMR",
        "departureDate": "20191201",
        "schedules": [
            {
                "trainNo": "10501",
                "trainName": "ARGO PARAHYANGAN PREMIUM",
                "departureTime": "0415",
                "arriveTime": "0725",
                "availSubClass": [
                    {
                        "subClass": "C",
                        "seatAvailable": 800,
                        "seatClass": "K",
                        "adultPrice": 100000,
                        "childPrice": 0,
                        "infantPrice": 0
                    }
                ]
            },
            {
                "trainNo": "77A",
                "trainName": "ARGO GOPAR",
                "departureTime": "1200",
                "arriveTime": "1500",
                "availSubClass": [
                    {
                        "subClass": "A",
                        "seatAvailable": 50,
                        "seatClass": "E",
                        "adultPrice": 100000,
                        "childPrice": 0,
                        "infantPrice": 0
                    },
                    {
                        "subClass": "B",
                        "seatAvailable": 50,
                        "seatClass": "B",
                        "adultPrice": 90000,
                        "childPrice": 0,
                        "infantPrice": 0
                    },
                    {
                        "subClass": "C",
                        "seatAvailable": 50,
                        "seatClass": "K",
                        "adultPrice": 60000,
                        "childPrice": 0,
                        "infantPrice": 0
                    }
                ]
            }
        ]
    }
}