TaskYam WebAPI Help Page

Addresses:

Pilot: https://pilot.israports.co.il/TaskYamWebAPI/ Production: https://taskyam.israports.co.il/TaskYamWebAPI/

Transport Level Security (TLS):

1.2

AngularJs call example

$http.post("https://pilot.israports.co.il/TaskYamWebAPI/api/Account/Login", { "UserName": "demoUsername", "Password": "demoPassword"}) .then(function (res) { //success }).catch(function (res) { //error }); $http({ method: "GET", url: "https://pilot.israports.co.il/TaskYamWebAPI/api/Account/Logout", headers: { "X-Session-Token": "123456789" }}) .then(function (res) { //success }).catch(function (res) { //error });

jQuery call example

$.ajax({ url: "https://pilot.israports.co.il/TaskYamWebAPI/api/Account/Login", type: 'POST', contentType: "application/x-www-form-urlencoded; charset=UTF-8", data: { "UserName": "demoUsername", "Password": "demoPassword" }, dataType: 'json' }).done(function (data) { alert(JSON.stringify(data)); }).error(function (jqXHR, textStatus, errorThrown) { alert(jqXHR.responseText || textStatus); }); $.ajax({ url: "ttps://pilot.israports.co.il/TaskYamWebAPI/api/Account/Logout", type: "GET", contentType: 'application/x-www-form-urlencoded; charset=UTF-8', headers: { "X-Session-Token": "123456789" }, }).done(function (data) { alert(JSON.stringify(data)); }).error(function (jqXHR, textStatus, errorThrown) { alert(jqXHR.responseText || textStatus); });

.NET call example

using System; using System.Collections.Generic; using System.Net.Http; using System.Text; using System.Threading.Tasks; using System.Web.Script.Serialization; public class ConnectToTaskYamWebAPI { string baseUrl = "https://pilot.israports.co.il/TaskYamWebAPI/"; public void OperationSample() { string result = string.Empty; StringBuilder sb = new StringBuilder(); System.Net.ServicePointManager.ServerCertificateValidationCallback += (sender, cert, chain, sslPolicyErrors) => true; //bypass certificate erros //if you use lower level security protocol implementations, turn on TLS 1.2 without affecting other protocols //System.Net.ServicePointManager.SecurityProtocol |= SecurityProtocolType.Tls12; //Login sample Task<LoginResult> taskLoginResult = Login("username", "password"); LoginResult loginResult = taskLoginResult.Result; //Calculate Over Weight Task<OverWeight> taskOverWeightResult = CalculateOverWeight(loginResult.Token); OverWeight overWeightResult = taskOverWeightResult.Result; //Logout Task<OperationResult> taskLogoutResult = Logout(loginResult.Token); OperationResult logoutResult = taskLogoutResult.Result; result = sb.ToString(); } private async Task<LoginResult> Login(string userName, string password) { LoginModel loginModel = new LoginModel(); loginModel.UserName = userName; loginModel.Password = password; LoginResult result = new LoginResult(); using (var client = new System.Net.Http.HttpClient()) { client.BaseAddress = new Uri(baseUrl); client.DefaultRequestHeaders.Accept.Clear(); client.DefaultRequestHeaders.Accept.Add(new System.Net.Http.Headers.MediaTypeWithQualityHeaderValue("application/json")); var LoginData = new JavaScriptSerializer().Serialize(loginModel); HttpContent contentPost = new StringContent(LoginData, Encoding.UTF8, "application/json"); HttpResponseMessage response = client.PostAsync(client.BaseAddress + "api/Account/Login", contentPost).Result; if (response.IsSuccessStatusCode) { //Option1: ReadAsAsync() will require installing "Microsoft ASP.NET Web API 2.2 Client libraries" from NuGet //Result = response.Content.ReadAsAsync<LoginResult>().Result; //option2: without any installation (JavaScriptSerializer().Deserialize can have problems with complex objects) string resultAsJson = await response.Content.ReadAsStringAsync(); result = new JavaScriptSerializer().Deserialize<LoginResult>(resultAsJson); } } return result; } private async Task<OverWeight> CalculateOverWeight(string token) { OverWeight result = new OverWeight(); using (var client = new System.Net.Http.HttpClient()) { client.BaseAddress = new Uri(baseUrl); client.DefaultRequestHeaders.Accept.Clear(); client.DefaultRequestHeaders.Accept.Add(new System.Net.Http.Headers.MediaTypeWithQualityHeaderValue("application/json")); client.DefaultRequestHeaders.Add("X-Session-Token", token); string p = "?VehicleID=23920701&TowedID=9033774"; HttpResponseMessage response = client.GetAsync(client.BaseAddress + "api/OverWeight/CalculateOverWeight" + p).Result; if (response.IsSuccessStatusCode) { string resultAsJson = await response.Content.ReadAsStringAsync(); result = new JavaScriptSerializer().Deserialize<OverWeight>(resultAsJson); } } return result; } private async Task<OperationResult> Logout(string token) { OperationResult result = new OperationResult(); using (var client = new System.Net.Http.HttpClient()) { client.BaseAddress = new Uri(baseUrl); client.DefaultRequestHeaders.Accept.Clear(); client.DefaultRequestHeaders.Accept.Add(new System.Net.Http.Headers.MediaTypeWithQualityHeaderValue("application/json")); client.DefaultRequestHeaders.Add("X-Session-Token", token); HttpResponseMessage response = client.GetAsync(client.BaseAddress + "api/Account/Logout").Result; if (response.IsSuccessStatusCode) { string resultAsJson = await response.Content.ReadAsStringAsync(); result = new JavaScriptSerializer().Deserialize<OperationResult>(resultAsJson); } } return result; } public class LoginModel { public string UserName; public string Password; } public class LoginResult { public bool IsSuccess; public string Message; public string Token; public bool NeedToChangePassword; public DateTime LastLoginDate; } public class OperationResult { public bool IsSuccess; public string Message; } public class OverWeight { public string TruckTaraWeight; public string TruckWeight; public string TruckWeightHazard; public string TruckHazardLicence; public string TrailerTaraWeight; public string TrailerWeight; public string TrailerWeightHazard; public string TrailerHazardLicence; public string TotalWeight40Feet; public string TotalWeight; public string TotalWeightHazard; public string TotalHazardLicence; public List<OverWeightComments> Comments; } public class OverWeightComments { public string ID; public string SeverityLevel; public string Message; } }

pseudo code to change password

LoginModel loginModel = new LoginModel(); loginModel.UserName = ReadFromStorage("UserName"); loginModel.Password = ReadFromStorage("Password"); try { LoginResult loginResult = Login(loginModel); if(loginResult.NeedToChangePassword) { string newPassword = GeneratePassword(); ChangePasswordModel changePasswordModel = new ChangePasswordModel(); changePasswordModel.OldPassword = model.Password; changePasswordModel.NewPassword = newPassword; try { string comment = ChangePassword(model); // Save new password to storage for future use WriteToStorage(("Password", changePasswordModel.NewPassword); } catch(Exception changePasswordExecption) { WriteToLog("Change Password Failed!"); } } // Fetch other services… } catch(Exception loginException) { WriteToLog("Login Failed!"); }

Account

API	Description
POST api/Account/Login	Login into TaskYam
POST api/Account/SilentLoginByToken	No documentation available.
POST api/Account/InsertSiteRedirect	No documentation available.
GET api/Account/GetSiteRedirect?guid={guid}	No documentation available.
GET api/Account/GetUserDetails	No documentation available.
POST api/Account/SetAuthorization	No documentation available.
GET api/Account/GeneratePassword	Generate automatic password
POST api/Account/ChangePassword	No documentation available.
GET api/Account/Logout	Logout from TaskYam

CommunityTables

API	Description
GET api/CommunityTables/GetCargoOwners?MisparOsek={MisparOsek}&StartDate={StartDate}&EndDate={EndDate}	טבלת יצואנים - TBLOAD_A12_IZUANIM
GET api/CommunityTables/GetCurrency	No documentation available.
GET api/CommunityTables/GetDangerousMatters?UNCode={UNCode}	טבלת חומרים מסוכנים - TBLOAD_A17_HMRIM_MSUKN
GET api/CommunityTables/GetDangerousGroups?groupID={groupID}	No documentation available.
GET api/CommunityTables/GetContainerTypes?ContainerType={ContainerType}	טבלת סוגי מכולות - TBLOAD_A22_SUG_MHOLA
GET api/CommunityTables/GetContainerA45?LenType={LenType}	טבלת המרת סוג מכולה מישן לחדש - TBLOAD_A45_HCONT_TO_WCO
GET api/CommunityTables/GetContainerA46?WCOType={WCOType}	טבלת המרת סוג מכולה מחדש לישן - TBLOAD_A46_HCONT_FROM_WCO
GET api/CommunityTables/GetWrappings?WrappingID={WrappingID}	טבלת סוגי אריזות - TBLOAD_C01_ARIZOT
GET api/CommunityTables/GetCustomsAgents?AgentCode={AgentCode}&CompanyNum={CompanyNum}&StartDate={StartDate}&EndDate={EndDate}	טבלת סוכני מכס - TBL_M01_CUSTOMS_BROKER
GET api/CommunityTables/GetS03Agents?AgentType={AgentType}&AgentCode={AgentCode}&CompanyNum={CompanyNum}&StartDate={StartDate}&EndDate={EndDate}	טבלת סוכנים- TBLOAD_S03_SOCHNIM
GET api/CommunityTables/GetShipDetails?LloidsNumber={LloidsNumber}&ShipId={ShipId}&StartDate={StartDate}&EndDate={EndDate}	טבלת אוניות - TBLOAD_S14_ONIYOT
GET api/CommunityTables/GetS15Error?systemCode={systemCode}	No documentation available.
GET api/CommunityTables/GetS17Mizharim?Year={Year}&AgentCode={AgentCode}	טבלת תחומי מצהרים - TBLOAD_S17_MIZHARIM
GET api/CommunityTables/GetShippingCompanies?ShipAgentCode={ShipAgentCode}&CompanyCode={CompanyCode}&PortID={PortID}	טבלת קודי התחשבנות- TBLOAD_S19_KOD_HITHSH
GET api/CommunityTables/GetLineCode	טבלת קווים- TBLOAD_S29_KAVIM
GET api/CommunityTables/GetPorts?UnlocodeList[0]={UnlocodeList[0]}&UnlocodeList[1]={UnlocodeList[1]}	רשימת הנמלים בעולם - TBLOAD_U08_NAMAL
GET api/CommunityTables/GetIsraelPorts?siteType={siteType}	רשימת הנמלים במדינת ישראל - TBLOAD_U08_NAMAL
GET api/CommunityTables/GetCountries?CountryID={CountryID}	טבלת קודי מדינות - TBLOAD_U09_MEDINA
GET api/CommunityTables/GetFlags	טבלת דגלי אוניה - TBLOAD_V01_DEGEL_ONIYA
GET api/CommunityTables/GetShipTypes?VesselType={VesselType}	טבלת סוגי אוניה - TBLOAD_V03_SUG_ONIYA
GET api/CommunityTables/GetKodMakom?KodMakom={KodMakom}	TBLOAD_U02_KOD_MAKOM_DL

ContainerStatus

API	Description
GET api/ContainerStatus/GetCargoStatus?ManifestNumber={ManifestNumber}&TransactionID={TransactionID}&Container={Container}&StorageID={StorageID}&Port={Port}&ReceiveNotification={ReceiveNotification}	Get Cargo status From Taskyam system. For General Cargo: must fill ManifestNumber, TransactionID For Containers: must fill Container
POST api/ContainerStatus/AddCargoNotification	Register for Cargo notification. Each notification will be received through the customer's Safe with "CargoNotification" XML message specified here : https://israports.co.il/he/TaskYam/Messaging_Structure_Docs/CARGONOTIFICATION%20%D7%A1%D7%98%D7%98%D7%95%D7%A1%20%D7%9E%D7%98%D7%A2%D7%9F%20%D7%91%D7%93%D7%97%D7%99%D7%A4%D7%94%20.pdf

DangerContDeclaration

API	Description
GET api/DangerContDeclaration/GetDangerousDeclerations	No documentation available.
POST api/DangerContDeclaration/SavePermitAppDry	No documentation available.
POST api/DangerContDeclaration/SavePermitAppForTanker	No documentation available.
POST api/DangerContDeclaration/SavePermitAppTanker	No documentation available.
POST api/DangerContDeclaration/SavePermitAppFile	No documentation available.
POST api/DangerContDeclaration/SavePermitApp	No documentation available.
POST api/DangerContDeclaration/SavePermitApp_new	No documentation available.
POST api/DangerContDeclaration/SavePermitApp_OLD	No documentation available.
POST api/DangerContDeclaration/SaveDeclarationMultimodelFiles	No documentation available.
POST api/DangerContDeclaration/SaveDeclarationAirFiles?schemaVersion={schemaVersion}	No documentation available.
POST api/DangerContDeclaration/SaveDeclarationDryFiles	No documentation available.
POST api/DangerContDeclaration/UpdateDeclaration?schemaVersion={schemaVersion}	No documentation available.
POST api/DangerContDeclaration/CreateDeclaration?schemaVersion={schemaVersion}	No documentation available.
POST api/DangerContDeclaration/DeleteDeclaration	מחיקת הצהרת חומ"ס למכולות
POST api/DangerContDeclaration/GetData	No documentation available.

DeliveryDoc

API	Description
POST api/DeliveryDoc/UpdateDelivery	תעודת משלוח
GET api/DeliveryDoc/OpenHelpGuideDocument	No documentation available.

Messages

API	Description
GET api/Messages/DownloadMessageData?CorrelationID={CorrelationID}	Download TaskYam Message. Search 6 months back. The logged in user must be the sender or the receiver of the message.
GET api/Messages/Get1170?FromDateTime={FromDateTime}&ToDateTime={ToDateTime}&IncludeServiceFamily={IncludeServiceFamily}&SenderID={SenderID}&ReceiverID={ReceiverID}&CorrelationID={CorrelationID}&ExternalID={ExternalID}&MANIFEST_ID={MANIFEST_ID}&TRANSACTION_ID={TRANSACTION_ID}&CONTAINER_ID={CONTAINER_ID}	Get SaveMN_MSG1170_1171_MANIFESTRequest_In meta data. Date range must be as small as possible. Addional parametres provided can expand the date range. The logged in user must be the sender or the receiver of the message.
GET api/Messages/Get2470?FromDateTime={FromDateTime}&ToDateTime={ToDateTime}&IncludeServiceFamily={IncludeServiceFamily}&SenderID={SenderID}&ReceiverID={ReceiverID}&CorrelationID={CorrelationID}&ExternalID={ExternalID}&MANIFEST_ID={MANIFEST_ID}&TRANSACTION_ID={TRANSACTION_ID}&CONTAINER_ID={CONTAINER_ID}&STORAGE_ID={STORAGE_ID}	Get SendDF_MSG2470_ReleaseGoodsMessage_Out or SendDF_MSG2470_ReleaseGoodsMessage_EX_Out meta data. Date range must be as small as possible. Addional parametres provided can expand the date range. The logged in user must be the sender or the receiver of the message.
GET api/Messages/Get8400EX?FromDateTime={FromDateTime}&ToDateTime={ToDateTime}&IncludeServiceFamily={IncludeServiceFamily}&SenderID={SenderID}&ReceiverID={ReceiverID}&CorrelationID={CorrelationID}&ExternalID={ExternalID}&CONTAINER_NUMBER={CONTAINER_NUMBER}&STORAGE_ID={STORAGE_ID}	No documentation available.
GET api/Messages/GetCrgoi1?FromDateTime={FromDateTime}&ToDateTime={ToDateTime}&IncludeServiceFamily={IncludeServiceFamily}&SenderID={SenderID}&ReceiverID={ReceiverID}&CorrelationID={CorrelationID}&ExternalID={ExternalID}&STORAGE_ID={STORAGE_ID}&TRANSACTION_ID={TRANSACTION_ID}	Get Crgoi1 (Storage document for general cargo) meta data. Date range must be as small as possible. Addional parametres provided can expand the date range. The logged in user must be the sender or the receiver of the message.
GET api/Messages/GetCoexit?FromDateTime={FromDateTime}&ToDateTime={ToDateTime}&IncludeServiceFamily={IncludeServiceFamily}&SenderID={SenderID}&ReceiverID={ReceiverID}&CorrelationID={CorrelationID}&ExternalID={ExternalID}&STORAGE_ID={STORAGE_ID}&MANIFEST_ID={MANIFEST_ID}&CONTAINER_NUMBER={CONTAINER_NUMBER}	Get Coexit (Container Exit from gate) meta data. Date range must be as small as possible. Addional parametres provided can expand the date range. The logged in user must be the sender or the receiver of the message.
GET api/Messages/GetCopin5?FromDateTime={FromDateTime}&ToDateTime={ToDateTime}&IncludeServiceFamily={IncludeServiceFamily}&SenderID={SenderID}&ReceiverID={ReceiverID}&CorrelationID={CorrelationID}&ExternalID={ExternalID}&CONTAINER_ID={CONTAINER_ID}&TRUCK_ID={TRUCK_ID}&DRIVER_ID={DRIVER_ID}	Get Copin5 (Transport Details for container exit) meta data. Date range must be as small as possible. Addional parametres provided can expand the date range. The logged in user must be the sender or the receiver of the message.
GET api/Messages/GetPdbck8?FromDateTime={FromDateTime}&ToDateTime={ToDateTime}&IncludeServiceFamily={IncludeServiceFamily}&SenderID={SenderID}&ReceiverID={ReceiverID}&CorrelationID={CorrelationID}&ExternalID={ExternalID}&CONTAINER_ID={CONTAINER_ID}&LIVUIE_ID={LIVUIE_ID}&TRANSMITTER_ID={TRANSMITTER_ID}	Get Copin5 (Feddback to Transport company for container exit) meta data. Date range must be as small as possible. Addional parametres provided can expand the date range. The logged in user must be the sender or the receiver of the message.
GET api/Messages/Get2790?FromDateTime={FromDateTime}&ToDateTime={ToDateTime}&IncludeServiceFamily={IncludeServiceFamily}&SenderID={SenderID}&ReceiverID={ReceiverID}&CorrelationID={CorrelationID}&ExternalID={ExternalID}&STORAGE_ID={STORAGE_ID}&TRANSACTION_ID={TRANSACTION_ID}&MANIFEST_NUMBER={MANIFEST_NUMBER}	Get SaveMN_2790_MSG5_ExportDeliveryDocumentMessage_In meta data. Date range must be as small as possible. Addional parametres provided can expand the date range. The logged in user must be the sender or the receiver of the message.
POST api/Messages/Send1050	Send SaveCC_MSG1050_EntryExitToFromCustomsStorageSitesMessage_In to Customs
POST api/Messages/Send1110	Send SaveMN_MSG_1110_ShipStatusMessage_In to Customs
POST api/Messages/Send20	Send SaveST_MSG20_StorageEntranceUnloading_In to Customs
POST api/Messages/Send204	Send SaveST_MSG204_StorageEntranceUnloadingExport_In to Customs
POST api/Messages/Send2450	Send SaveCC_MSG2450_ContainerizationMessage_In to Customs
POST api/Messages/Send2750	Send SaveDF_MSG2750_2754_ImportDeclarationRequest_In to Customs
POST api/Messages/Send2755	Send GetDF_MSG2755_2754_SubmitImportDeclarationRequest_In to Customs
POST api/Messages/Send2757	Send GetDF_MSG2755_2757_SubmitExportDeclarationRequest_In to Customs
POST api/Messages/Send2751	Send SaveDF_MSG2751_ExportDeclaration_In to Customs
POST api/Messages/Send2790	Send SaveMN_2790_MSG5_ExportDeliveryDocumentMessage_In to Customs
POST api/Messages/Send2715	Send GetDOC_MSG2715_2716_AddAttachmentResponse_In to Customs
POST api/Messages/Send1170	Send SaveMN_MSG1170_1171_MANIFESTRequest_In to Customs
POST api/Messages/Send1200	Send SaveMN_MSG1200_1220_DeliveryOrder_Message_In to Customs
POST api/Messages/Send1030	Send GetGP_MSG1030_1035_GatepassFeedbackMessage_In to Customs
POST api/Messages/Send8240	Send GetMN_MSG_8240_8241_CargoQuery_Message_In to Customs
POST api/Messages/Send8302	Send GetDF_WEB8302_8303_DeclarationPrint_Request_In to Customs
POST api/Messages/Send8410	Send SaveLG_NG_8410_LogisticActionRequestMessage_In to Customs
POST api/Messages/Send8358	Send SaveST_MSG_8358_DFShipSupplies_In to Customs
POST api/Messages/Send8359	Send ST_MSG8359_InventoryMovements to Hani
POST api/Messages/Send9082	Send SaveCC_NG9082_ExportCargoAirWayBillReplacement_In to Customs
GET api/Messages/GetDutyFree?sender={sender}&date={date}	get ST_MSG8359_InventoryMovements summary to Customs

OverWeight

API	Description
GET api/OverWeight/CalculateOverWeight?VehicleID={VehicleID}&TowedID={TowedID}	מאפשר לקבל עבור כל רכב משא את המשקל המקסימלי המותר לו לשאת ע"פ תקנות משרד התחבורה כולל משקל מורשה בחומ"ס. ראה דוגמה מלאה לקריאה באגף הדוגמאות.

PlanOrder

API	Description
POST api/PlanOrder/GetMainPageData	No documentation available.
POST api/PlanOrder/SaveSinglePlanOrder	No documentation available.
POST api/PlanOrder/SaveMultiplePlanOrders	No documentation available.
POST api/PlanOrder/GetPlanOrdersView	No documentation available.

PortOperationalInfo

API	Description
GET api/PortOperationalInfo/GetVesselSchedule?portCode={portCode}&UnLocode[0]={UnLocode[0]}&UnLocode[1]={UnLocode[1]}&vesselScheduleStatus={vesselScheduleStatus}	שליפת סטטוס אוניות
GET api/PortOperationalInfo/GetWorkProgram?portCode={portCode}&language={language}	תוכנית עבודה נמלי
GET api/PortOperationalInfo/GetDocksideOperations?port={port}&manifest={manifest}&shipName={shipName}	Get dockside vessele's operations. Containers loading and unloading status