ASP.NET Web API Help Page

Introduction

Addresses:

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

Transport Level Security (TLS):

1.2

.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; 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: //Result = response.Content.ReadAsAsync<LoginResult>().Result; //option2: 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; } 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"); 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!"); } }

Account

API	Description
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	No documentation available.
POST api/Account/ChangePassword	No documentation available.
GET api/Account/Logout	No documentation available.
POST api/Account/Login	No documentation available.

CommunityTables

API	Description
GET api/CommunityTables/GetCargoOwners?MisparOsek={MisparOsek}&StartDate={StartDate}&EndDate={EndDate}	No documentation available.
GET api/CommunityTables/GetCurrency	No documentation available.
GET api/CommunityTables/GetDangerousMatters?UNCode={UNCode}	No documentation available.
GET api/CommunityTables/GetDangerousGroups?groupID={groupID}	No documentation available.
GET api/CommunityTables/GetContainerTypes?ContainerType={ContainerType}	No documentation available.
GET api/CommunityTables/GetContainerA45?LenType={LenType}	No documentation available.
GET api/CommunityTables/GetContainerA46?WCOType={WCOType}	No documentation available.
GET api/CommunityTables/GetWrappings?WrappingID={WrappingID}	No documentation available.
GET api/CommunityTables/GetCustomsAgents?AgentCode={AgentCode}&CompanyNum={CompanyNum}&StartDate={StartDate}&EndDate={EndDate}	No documentation available.
GET api/CommunityTables/GetS03Agents?AgentType={AgentType}&AgentCode={AgentCode}&CompanyNum={CompanyNum}&StartDate={StartDate}&EndDate={EndDate}	No documentation available.
GET api/CommunityTables/GetShipDetails?LloidsNumber={LloidsNumber}&ShipId={ShipId}&StartDate={StartDate}&EndDate={EndDate}	No documentation available.
GET api/CommunityTables/GetS15Error?systemCode={systemCode}	No documentation available.
GET api/CommunityTables/GetS17Mizharim?Year={Year}&AgentCode={AgentCode}	No documentation available.
GET api/CommunityTables/GetShippingCompanies?ShipAgentCode={ShipAgentCode}&CompanyCode={CompanyCode}&PortID={PortID}	No documentation available.
GET api/CommunityTables/GetLineCode	No documentation available.
GET api/CommunityTables/GetPorts?UnlocodeList[0]={UnlocodeList[0]}&UnlocodeList[1]={UnlocodeList[1]}	No documentation available.
GET api/CommunityTables/GetIsraelPorts?siteType={siteType}	No documentation available.
GET api/CommunityTables/GetCountries?CountryID={CountryID}	No documentation available.
GET api/CommunityTables/GetFlags	No documentation available.
GET api/CommunityTables/GetShipTypes?VesselType={VesselType}	No documentation available.
GET api/CommunityTables/GetKodMakom?KodMakom={KodMakom}	No documentation available.
GET api/CommunityTables/GetS30ErrorCodes	No documentation available.

ContainerStatus

API	Description
GET api/ContainerStatus/GetCargoStatus?ManifestNumber={ManifestNumber}&TransactionID={TransactionID}&Container={Container}&StorageID={StorageID}&Port={Port}&ReceiveNotification={ReceiveNotification}	No documentation available.
POST api/ContainerStatus/AddCargoNotification	No documentation available.

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	No documentation available.
POST api/DangerContDeclaration/GetData	No documentation available.

DeliveryDoc

API	Description
POST api/DeliveryDoc/UpdateDelivery	No documentation available.
GET api/DeliveryDoc/OpenHelpGuideDocument	No documentation available.

Messages

API	Description
GET api/Messages/DownloadMessageData?CorrelationID={CorrelationID}	No documentation available.
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}	No documentation available.
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}	No documentation available.
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}	No documentation available.
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}	No documentation available.
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}	No documentation available.
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}	No documentation available.
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}	No documentation available.
POST api/Messages/Send1050	No documentation available.
POST api/Messages/Send1110	No documentation available.
POST api/Messages/Send20	No documentation available.
POST api/Messages/Send204	No documentation available.
POST api/Messages/Send2450	No documentation available.
POST api/Messages/Send2750	No documentation available.
POST api/Messages/Send2755	No documentation available.
POST api/Messages/Send2757	No documentation available.
POST api/Messages/Send2751	No documentation available.
POST api/Messages/Send2790	No documentation available.
POST api/Messages/Send2715	No documentation available.
POST api/Messages/Send1170	No documentation available.
POST api/Messages/Send1200	No documentation available.
POST api/Messages/Send1030	No documentation available.
POST api/Messages/Send8240	No documentation available.
POST api/Messages/Send8302	No documentation available.
POST api/Messages/Send8410	No documentation available.
POST api/Messages/Send8357	No documentation available.
POST api/Messages/Send8358	No documentation available.
POST api/Messages/Send8359	No documentation available.
POST api/Messages/Send9082	No documentation available.
GET api/Messages/GetDutyFree?sender={sender}&date={date}	No documentation available.

OverWeight

API	Description
GET api/OverWeight/CalculateOverWeight?VehicleID={VehicleID}&TowedID={TowedID}	No documentation available.

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}	No documentation available.
GET api/PortOperationalInfo/GetWorkProgram?portCode={portCode}&language={language}	No documentation available.
GET api/PortOperationalInfo/GetDocksideOperations?port={port}&manifest={manifest}&shipName={shipName}	No documentation available.