AddressBook
AddressBook Api Controller
| API | Description |
|---|---|
| DELETE api/v1/AddressBook/{id} |
Deletes the Agent's Addressbook identified by id for current logged-in |
| GET api/v1/AddressBook |
Retrieves an array of agent available in WIN bases on the following criteria AgentName: Agent Name.(Option) NetworksName: Networks Name or Networks Code.(Option) CountryName: Country name or ISO code. Minimum length is 2 characters. (Option) CityName: City name or UN Location code. Minimum length is 2 characters. (optional) Type: If type = agents then get agent only, If type = AddressBooks then get addressbook only, If type = null then get agents + addressbooks(option) SortBy: Field to sort on. prepend + or - to indicate ascending or descending. Defalult to +AgentName (optional) Context: Action Page : RFQ, Airfreight or Admin (requried) ContactType: Contact Type for filter WINID Service: |
| GET api/v1/AddressBook/{id} |
Retrieves an array of Address book identified by current agent |
| GET api/v1/AddressBook/Export |
DownloadAddressBook |
| POST api/v1/AddressBook/Import |
UploadAddressBook |
| POST api/v1/AddressBook?context={context} |
Creates a new Agent's Addressbook for current logged-in |
| PUT api/v1/AddressBook/{id} |
Updates the Agent's Addressbook identified by id for current logged-in |
AgentAirCarriers
Agent Air Carriers Api Controller
| API | Description |
|---|---|
| DELETE api/v1/AirCarriers/{agentId}/{id} |
Deletes the air carrier identified by id |
| GET api/v1/AirCarriers/{agentId}/{id} |
Retrieves the list of air carriers identified by AgentID or an air carrier identified by ID (IATACode or AWBPrefix). |
| GET api/v1/AirCarriers/{agentId}?eAWB={eAWB} |
Retrieves the list of air carriers identified by AgentID or an air carrier identified by ID (IATACode or AWBPrefix). |
| GET api/v1/AirCarriers?eAWB={eAWB}&booking={booking}&search={search}&sort={sort} |
Retrieves the carrier of currently logged in agent. |
| POST api/v1/AirCarriers/{agentId} |
Creates a new agent's air carrier |
| PUT api/v1/AirCarriers/{agentId}/{id} |
Updates the air carrier identified by id |
AgentChatContacts
AgentChatContacts Api Controller
| API | Description |
|---|---|
| GET api/v1/Chat/Agents/{AgentID}/Users |
Retrieves the array of agent contacts for the currently logged in agent. |
| GET api/v1/Chat/Users/{ContactID} |
Retrive a agent contact by contact id. |
AgentContactBlockNotifications
AgentContact Block Notifications Controller
| API | Description |
|---|---|
| DELETE api/v1/Agents/{AgentID}/Users/{ContactID}/MyShipments/Awbs/{MawbID} |
Delete Awb Block Notification |
| DELETE api/v1/Agents/{AgentID}/Users/{ContactID}/MyShipments/Jobs/{JobMasterID} |
Delete Job Block Notification |
| POST api/v1/Agents/{AgentID}/Users/{ContactID}/MyShipments/Awbs/{MawbID} |
Add |
| POST api/v1/Agents/{AgentID}/Users/{ContactID}/MyShipments/Jobs/{JobMasterID} |
Add |
AgentContactNestedV2
Agent Contact Nested V2 Controller
| API | Description |
|---|---|
| DELETE api/v2/Agents/{agentId}/Users/{contactId} |
Delete Contact |
| GET api/v2/Agents/{agentId}/Users |
Find By AgentID |
| GET api/v2/Agents/{agentId}/Users/{contactId} |
Find By ContactID |
| GET api/v2/Agents/{agentId}/Users/Customers |
Find only ContactType=Customer contacts By AgentID |
| POST api/v2/Agents/{agentId}/Users |
Create Contact |
| PUT api/v2/Agents/{agentId}/Users/{contactId} |
Create Contact |
AgentContacts
Agent Contact Controller
| API | Description |
|---|---|
| DELETE api/v1/Agents/{agentId}/Users/{contactId} |
Delete Contact |
| GET api/v1/Agents/{agentId}/Users |
Find By AgentID |
| GET api/v1/Agents/{agentId}/Users/{contactId} |
Find By ContactID |
| GET api/v1/Agents/{agentId}/Users?contactType={contactType}&addressbookId={addressbookId} |
Find only ContactType=Customer contacts By AgentID |
| POST api/v1/Agents/{agentId}/Users |
Create Contact |
| PUT api/v1/Agents/{agentId}/Users/{contactId} |
Create Contact |
| PUT api/v1/Agents/{agentId}/Users/{contactId}/GDPR |
Update GDPRflag of Contact |
AgentContactSetting
AgentContactSettingController
| API | Description |
|---|---|
| GET api/v1/Users/{contactID}/Preferences/Notification |
GetAgentContactSetting |
| POST api/v1/Users/{contactID}/Preferences/Notification |
SaveAgentContactSetting |
AgentContactV2
Agent Contact V2 Controller
| API | Description |
|---|---|
| DELETE api/v2/Users/{contactId} |
Delete Contact |
| GET api/v2/Users/{contactId} |
Find By ContactID |
| POST api/v2/Users |
Create Contact |
| PUT api/v2/Users/{contactId} |
Create Contact |
AgentHolidays
AgentHolidays Api Controller
| API | Description |
|---|---|
| DELETE api/v1/Agents/{AgentID}/Holidays/id?id={id} |
Deletes the agent’s holiday identified by id. |
| GET api/v1/Agents/{AgentID}/Holidays |
Retrieves an array of holidays for current logged in agent. |
| POST api/v1/Agents/{AgentID}/Holidays |
Creates a new agent’s holiday. |
| PUT api/v1/Agents/{AgentID}/Holidays |
Updates the agent’s holiday identified by id. |
AgentList
AgentsList Api Controller
| API | Description |
|---|---|
| GET api/v1/AgentList/{agentId} |
Get AgentViewDTO by agentID |
| GET api/v1/AgentList?context={context}&AgentName={AgentName}&Country={Country}&City={City}&Network={Network}&Service={Service}&SpatialFilter={SpatialFilter} |
Get an array of AgentViewDTO |
| GET api/v1/AgentList?CountryCode={CountryCode} |
Get an array of AgentViewDTO by country code |
AgentListV2
AgentList V2 Controller
| API | Description |
|---|---|
| GET api/v2/AgentList |
Find By Filter |
| GET api/v2/AgentList/{AgentID} |
Find By AgentID |
| GET api/v2/AgentList/{AgentID}/async |
Find By AgentID |
| GET api/v2/AgentList/async |
Find By Filter |
| GET api/v2/AgentList/async?CountryCode={CountryCode} |
Find an array of AgentViewDTO by country code |
| GET api/v2/AgentList?CountryCode={CountryCode} |
Find an array of AgentViewDTO by country code |
AgentNetwork
AgentNetwork Api Controller
| API | Description |
|---|---|
| DELETE api/v1/Agents/{AgentID}/Networks/{id} |
Delete a AgentNetwork by AgentID and NetworkID |
| GET api/v1/Agents/{AgentID}/Networks |
Gets the list of AgentNetwork |
| GET api/v1/Agents/{AgentID}/Networks/{id} |
Get a AgentNetwork by id |
| POST api/v1/Agents/{AgentID}/Networks |
Create a AgentNetwork |
| PUT api/v1/Agents/{AgentID}/Networks/{id} |
Update a AgentNetwork |
AgentNetworkUser
AgentNetwork Api Controller
| API | Description |
|---|---|
| DELETE api/v1/Network/Agents/{AgentID}/User/{id} |
Delete a User of specific Network Agent |
| GET api/v1/Network/Agents/{AgentID}/Users |
Gets the list of Users of Network Agent |
| POST api/v1/Network/Agents/{AgentID}/User/{network} |
Create a Network User |
| POST api/v1/Network/Agents/{AgentID}/User/ChangePassword |
To send request to change password |
| PUT api/v1/Network/Agents/{AgentID}/User/{UserID}/ResetPassword/{network} |
Reset user's password |
AgentNotifications
Agent Notifications Controller
| API | Description |
|---|---|
| DELETE api/v1/Agents/{AgentID}/Notifications |
Dismiss all records with the specified 'AgentID' will taking disappearance from visibility |
| DELETE api/v1/Agents/{AgentID}/Notifications/{id} |
Dismiss record with the specified 'id' will taking disappearance from visibility |
| GET api/v1/Agents/{AgentID}/Notifications |
FindByAgentId Retrive a list of Notifications by AgentID Endpoint tested api/v1/Agents/80183/notifications?$filter=Status/Type eq 'Quotes' Endpoint tested api/v1/Agents/80183/notifications?$filter=Status/Type eq 'AirFreight' |
| GET api/v1/Agents/{AgentID}/Notifications/{EventID} | |
| PUT api/v1/Agents/{AgentID}/Notifications |
Dismiss all records with the specified 'AgentID' will taking disappearance from visibility |
| PUT api/v1/Agents/{AgentID}/Notifications/{id} |
Dismiss record with the specified 'id' will taking disappearance from visibility |
AgentPreferences
AgentPreferences Api Controller
| API | Description |
|---|---|
| GET api/v1/Agents/{AgentID}/Preferences |
Retrieves the preferences setting of current logged in agent. |
| PUT api/v1/Agents/{AgentID}/Preferences |
Agents
Agent Api Controller
| API | Description |
|---|---|
| DELETE api/v1/Agents/{id} |
Deletes the agent profile identified by id |
| GET api/v1/Agents/{agentID}/LoginHistory |
Retrieves an array of user's login history in agent specified by AgentID and available to administrator permission. |
| GET api/v1/Agents/{id} |
Retrieves the profile identified by agent id |
| GET api/v1/Agents/{timestamp} |
GetAgentUpdates |
| GET api/v1/Agents?AgentName={AgentName}&Networks={Networks}&Country={Country}&City={City}&SortBy={SortBy}&RegType={RegType} |
Find By Filter |
| POST api/v1/Agents |
Create the agent profile. |
| PUT api/v1/Agents/{id} |
Updates the profile of currently logged in agent. |
| PUT api/v1/Agents/Agents/{id}?wop={wop} |
Activates or deactivates the agent profile identified by id |
AgentSeaCarriers
AgentSeaCarriers Api Controller
| API | Description |
|---|---|
| GET api/v1/Agents/{AgentID}/SeaCarriers/{id} |
Retrieves a ocean carriers of Agent by sea carrier id |
| GET api/v1/Agents/{AgentID}/SeaCarriers?name={name}&scac={scac} |
Search a ocean carriers by sea carrier id |
| POST api/v1/Agents/{AgentID}/SeaCarriers |
POST Agent |
AgentSettingQuota
AgentSetting Quota Controller
| API | Description |
|---|---|
| DELETE api/v1/Agents/{agentId}/Quota/{groupId}?key={key} |
Delete Quota |
| GET api/v1/Agents/{agentId}/Quota |
FindQuotaUSR |
| POST api/v1/Agents/{agentId}/Quota |
Create Quota |
| PUT api/v1/Agents/{agentId}/Quota |
UpdateQuota |
AgentV2
Agent V2 Controller
| API | Description |
|---|---|
| DELETE api/v2/Agents/{agentId} |
Deletes the agent profile identified by id |
| GET api/v2/Agents/{AgentID} |
Find Current Agent |
| GET api/v2/Agents/{agentId}/LoginHistory |
Retrieves an array of user's login history in agent specified by AgentID and available to administrator permission. |
| GET api/v2/Agents/{timestamp} |
Find Agent Updates Timestamp : [ "yyyyMMddHHmmss", "yyyyMMddTHHmm", "yyyyMMddTHHmmss" ] |
| GET api/v2/Agents?AgentName={AgentName}&Networks={Networks}&Country={Country}&City={City}&SortBy={SortBy}&RegType={RegType} |
Find By Filter |
| POST api/v2/Agents |
Create the agent profile. |
| PUT api/v2/Agents/{agentId} |
Updates the profile of currently logged in agent. |
| PUT api/v2/Agents/{agentId}?wop={wop} |
Activates or deactivates the agent profile identified by id |
AirBooking
Air Booking Api Controller
AirBookingStatus
Air Booking Status Api Controller
| API | Description |
|---|---|
| PUT api/v1/AirBookingStatus |
Update Air Booking Roouting Status |
AirCards
Air Way Bill Card
| API | Description |
|---|---|
| GET api/v1/AirCards?Class={Class}&type={type}&awbStatus={awbStatus}&awbNo={awbNo}&party={party}&port={port}&from={from}&to={to}&bookingStatus={bookingStatus} |
Get AWB Card filter by MAWB Status |
Airlines
Airlines Api Controller
| API | Description |
|---|---|
| GET api/pub/Airlines |
Retrieves an array of IATA Airlines. |
| GET api/pub/Airlines/{code} |
Retrieves the IATA Airline identified by IATA 2-Character designator or 3-Numeric Airline Accounting & Prefix Code. |
AirlinesMaster
AirlinesMaster Api Controller
| API | Description |
|---|---|
| DELETE api/v1/AirlinesMaster/{id} |
Deletes the AirlinesMaster identified by id. |
| GET api/v1/AirlinesMaster/{id} |
Retrieves the airline identified by id (IATACode or AWBPrefix). |
| GET api/v1/AirlinesMaster?search={search}&sort={sort} |
Retrieves an array of airlines. |
| POST api/v1/AirlinesMaster |
Add new airline with Airline DTO provided. |
| PUT api/v1/AirlinesMaster/{id} |
Edit airline according to the Airline ID provided with Airline DTO provided. |
AirportsMaster
AirportsMaster Api Controller
| API | Description |
|---|---|
| GET api/v1/AirportsMaster/{id} |
Retrieves the IATA airport identified by id. Where id is IATA airport code. |
| GET api/v1/AirportsMaster?search={search}&sort={sort} |
Retrieves an array of IATA airports based on the following criteria. |
AirSchedules
OAG Air schedules
AirStats
AWBStats Api Controller
| API | Description |
|---|---|
| GET api/v1/AirStats?from={from}&to={to} |
Retreives all of AWB Stats |
AirTracking
AirTracking Api Controller
| API | Description |
|---|---|
| GET api/v1/MAWB/{id}/Tracking |
Retrieves an array of Tracking message with ID of MAWB |
| POST api/v1/Air/Tracking |
Create Tracking |
AirValuesMaster
AirValuesMaster Api Constroller
| API | Description |
|---|---|
| GET api/v1/AirValuesMaster |
Retrieves an array of identifier available for air values. |
| GET api/v1/AirValuesMaster/{id} |
Retrieves an array of air values identified by id. Where id is identifier. |
Awb
| API | Description |
|---|---|
| GET api/v1/Agent/{AgentID}/Awb/{id} | |
| GET api/v1/Agents/{AgentID}/Awb/{id} | |
| POST api/v1/Awb |
Create Airway Bill |
| POST api/v1/Awb2 |
Create Airway Bill and Send it Later |
| POST api/v1/SenderAgent/{SenderAgentID}/Awb |
Create Airway Bill through FTP |
| PUT api/v1/Awb/{id} | |
| PUT api/v1/Awb2/{id} |
Update Airway Bill and Send it Later |
| PUT api/v1/SenderAgent/{SenderAgentID}/Awb/{id} |
Update Airway Bill through FTP |
AwbsCustomerVisibility
Awbs Customer Visibility Controller
| API | Description |
|---|---|
| DELETE api/v1/Agents/{AgentID}/Awbs/{MawbID}/CustomerVisibility |
Delete Customer Visibility |
| GET api/v1/Agents/{AgentID}/Awbs/{MawbID}/CustomerVisibility/{id} |
Get Visible Shipments |
| POST api/v1/Agents/{AgentID}/Awbs/{MawbID}/CustomerVisibility |
Create Multiple Customer Visibility |
AwbStatus
AwbStatus API Controller: api/v{version}/Pouch/getLatestStatus api/v{version}/Pouch/getLatestStatus/Agent/{AgentID} api/v{version}/Pouch/getLatestStatus/Agent/{AgentID}/MAWB/{MawbId} api/v{version}/Pouch/getLatestStatus/Agent/{AgentID}/MAWB/{MawbId}/{Timestamp}
| API | Description |
|---|---|
| GET api/v1/Pouch/getLatestStatus/{Timestamp} |
Retrieve all: api/v{version}/Pouch/getLatestStatus |
| GET api/v1/Pouch/getLatestStatus/Agent/{AgentID}/{Timestamp} |
GetByAgentID: api/v{version}/Pouch/getLatestStatus/Agent/{AgentID}/{Timestamp} |
| GET api/v1/Pouch/getLatestStatus/Agent/{AgentID}/MAWB/{MawbId} |
GetByMAWB: api/v{version}/Pouch/getLatestStatus/Agent/{AgentID}/MAWB/{MawbId} |
| GET api/v1/Pouch/getLatestStatus/Agent/{AgentID}/MAWB/{MawbId}/{Timestamp} |
GET api/v{version}/Pouch/getLatestStatus/Agent/{AgentID}/MAWB/{MawbId}/{Timestamp} Example: /api/v1/Pouch/getLatestStatus/Agent/184107/MAWB/2100/20131018092131 |
| PUT api/v1/Pouch/getLatestStatus/FTPAgent/{AgentID} |
PutAwbStatusToFTP: api/v{version}/Pouch/getLatestStatus/FTPAgent/{AgentID} |
BatchListAgent
BatchListAgentController
| API | Description |
|---|---|
| DELETE api/v1/UCTApi/BatchList/Agents/{AgentID} |
UpdateBatchList |
| DELETE api/v1/UCTApi/BatchList/Agents/{AgentID}/{carrier}/{searchKey}/{searchValue} |
DeleteBatchList |
| GET api/v1/UCTApi/BatchList/Agents/{AgentID} |
GetBatchList |
| GET api/v1/UCTApi/BatchList/Agents/{AgentID}/{carrier}/{searchKey}/{searchValue} |
GetBatchList |
| POST api/v1/UCTApi/BatchList/Agents/{AgentID} |
CreateBatchList |
| PUT api/v1/UCTApi/BatchList/Agents/{AgentID} |
UpdateBatchList |
BookingRequests
BookingRequestsController
| API | Description |
|---|---|
| DELETE api/v1/BookingRequests?id={id} |
Deletes the Booking identified by id. |
| GET api/v1/BookingRequests |
Retrieves a list of Booking |
| GET api/v1/BookingRequests/{id} |
Retrieves the Booking identified by id |
| GET api/v1/BookingRequests/Agent/{agentID} |
Retrieves a list of Bookings identified by agent id. |
| GET api/v1/BookingRequests/Agent/{agentID}/Booking/{bookingID} |
Retrieves the Booking identified by id and agent id. |
| POST api/v1/BookingRequests |
Create new BookingRequest |
| PUT api/v1/BookingRequests?id={id} |
Updates the Booking identified by id. |
BroadcastNotifications
api/{v}/BroadcastNotifications
| API | Description |
|---|---|
| GET api/v1/BroadcastNotifications/{EventID} |
Get a Notification |
BusinessTypeMaster
BusinessTypeMaster Api Controller
| API | Description |
|---|---|
| GET api/v1/BusinessTypeMaster?sortBy={sortBy} |
Retrieves list of BusinessTypeMaster. |
CancelXML
CancelXMLController
| API | Description |
|---|---|
| PUT api/v1/BookingRequests/{id}/CancelXML |
Send cancellation Booking Request XML |
CaptchaImage
Captcha Image API Controller http://blog.arvixe.com/build-a-captcha-using-jquery-and-web-api-part-1/
| API | Description |
|---|---|
| GET api/v1/Captcha |
GetCaptcha |
| POST api/v1/Captcha |
Validate |
CargoReceipt
MAWB Api Controller
| API | Description |
|---|---|
| GET api/v1/MAWB/{MawbID}/PDF/CargoReceipt |
Get AwbPrint as PDF format. |
CarrierMessages
CarrierMessagesController
| API | Description |
|---|---|
| GET api/v1/CarrierMessages/Air |
GET api/v1/CarrierMessages/Air/{MawbID}/{Status} |
| GET api/v1/CarrierMessages/Air/{awbNumber} |
GET api/v1/CarrierMessages/Air/?awbNumber= awbNumber |
| GET api/v1/CarrierMessages/Air/{MawbID} |
GET api/v1/CarrierMessages/Air/{MawbID} |
| GET api/v1/CarrierMessages/Air/{MawbID}/{Status} |
GET api/v1/CarrierMessages/Air/{MawbID}/{Status} |
| GET api/v1/CarrierMessages/Air/{MawbID}/HAWB/{HawbID}/{Status} |
GET api/v1/CarrierMessages/Air/{MawbID}/HAWB/{HawbID}/{Status} |
| GET api/v1/CarrierMessages/AirBooking/{awbNumber} |
GET api/v1/CarrierMessages/Air/?awbNumber= awbNumber |
| GET api/v1/CarrierMessages/AirBooking/{BookingID} |
GET api/v1/CarrierMessages/AirBooking/{BookingID} |
| GET api/v1/CarrierMessages/Sea |
Retrieves an array of Sea bookings |
| GET api/v1/CarrierMessages/Sea/{bookingID} |
GET api/v1/CarrierMessages/Sea/{BookingID} |
| GET api/v1/CarrierMessages/Sea/{BookingID}/{Status} |
GET api/v1/CarrierMessages/Sea/{BookingID}/{Status} |
| POST api/v1/CarrierMessages/Air/{MawbID}/{Status} |
POST api/v1/CarrierMessages/Air/{MawbID}/{Status} |
| POST api/v1/CarrierMessages/Air/{MawbID}/FSU/{eventStatusCode} |
POST api/v1/CarrierMessages/Air/{MawbID}/{Status}/{ReponseMessage} |
| POST api/v1/CarrierMessages/Air/{MawbID}/HAWB/{HawbID}/{Status} |
POST api/v1/CarrierMessages/Air/{MawbID}/HAWB/{HawbID}/{Status} |
| POST api/v1/CarrierMessages/AirBooking/{BookingID}/{Status} |
POST api/v1/CarrierMessages/AirBooking/{BookingID}/{Status} |
| POST api/v1/CarrierMessages/Sea/{BookingID}/{EventStatuscode}/{SeaPort} |
POST api/v1/CarrierMessages/Sea/{BookingID}/{EventStatuscode}/{SeaPort} |
| POST api/v1/CarrierMessages/Sea/{BookingID}/{Status} |
POST api/v1/CarrierMessages/Sea/{BookingID}/{Status} |
ChangePassword
| API | Description |
|---|---|
| POST api/v1/user/do/ChangePassword |
To send request to change password |
ContactCreation
MSDB Controller
| API | Description |
|---|---|
| POST api/v1/msdb/ContactCreation/createContact |
Create a migrated MSDB agent's contacts, from a POST from the UI. Any user can call this in theory, but it will throw BadRequest if not called by an MSDB migrated user. |
ContainerTypes
ContainerTypeController
| API | Description |
|---|---|
| GET api/v1/ContainerTypes/{code} |
Retrieves the Container Type identified by Code. |
| GET api/v1/ContainerTypes?search={search}&sort={sort} |
Retrieves an array of Container Type. |
Countries
Countries
| API | Description |
|---|---|
| GET api/pub/countries |
Retrieves an array of ISO 3166-1 alpha-2 – two-letter country codes |
| GET api/pub/countries/{code} |
Retrieves the ISO 3166-1 alpha-2 – two-letter country codes |
CountriesMaster
CountriesMaster Api Constroller
| API | Description |
|---|---|
| GET api/v1/CountriesMaster |
Retrieves list of countries |
| GET api/v1/CountriesMaster/{id} |
Gets a country by Country Code. |
| GET api/v1/CountriesMaster?search={search}&sort={sort} |
Gets the list of country available. Country name or Country code. Minimum length is 2 characters. (optional)Field to sort on. prepend + or - to indicate ascending or descending. Defalult to +CountryCode (optional) |
CurrenciesMaster
CurrenciesMaster Api Controller
| API | Description |
|---|---|
| GET api/v1/CurrenciesMaster |
Retrieves an array of currencies. |
| GET api/v1/CurrenciesMaster/{id} |
Retrieves the currency identified by id. Where id is currency code. |
| GET api/v1/CurrenciesMaster?search={search}&sort={sort} |
Retrieves an array of currency based on the following criteria. |
Customers
Software company Agent's Customer(Addressbook) Controller
| API | Description |
|---|---|
| DELETE api/v1/Agents/{AgentID}/Customers/{id} |
Deletes the Agent's Addressbook identified by id for current logged-in |
| GET api/v1/Agents/{AgentID}/Customers |
DownloadAddressBook |
| GET api/v1/Agents/{AgentID}/Customers/{id} |
Retrieves an Address book identified by addressbook id |
| POST api/v1/Agents/{AgentID}/Customers |
Here Customer refers to Addressbook, Software agents will create customer(Addressbook) for configured agent. |
| PUT api/v1/Agents/{AgentID}/Customers/{id} |
CustomersUser
Software company AgentContacts Controller AgentID is the ID of agent on which logged in software agent is going to operate. CustomerId is the AddressbookID. UserId is the Agent ID belonging to CustomerId(Addressbook).
| API | Description |
|---|---|
| DELETE api/v1/Agents/{AgentID}/Customers/{CustomerId}/Users/{UserId} |
Delete Customer's User |
| GET api/v1/Agents/{AgentID}/Customers/{CustomerId}/Users |
Find All Users By CustomerId |
| GET api/v1/Agents/{AgentID}/Customers/{CustomerId}/Users/{UserId} |
Find User By UserID |
| POST api/v1/Agents/{AgentID}/Customers/{CustomerId}/Users |
Create Customer's User |
| PUT api/v1/Agents/{AgentID}/Customers/{CustomerId}/Users/{UserId} |
Update Customer's User |
DocumentTypeMaster
DocumentTypeMaster
| API | Description |
|---|---|
| GET api/v1/DocumentTypeMaster/all |
GetAllDocumentTypes |
| GET api/v1/DocumentTypeMaster?Context={Context} |
Get a list of Document Types by the specified Context |
EDocketts
EDocketts
eWeightSlips
| API | Description |
|---|---|
| DELETE api/v1/eWeightSlips/Mawb/{mawbno}/Hawb/{hawbno} |
Delete EWS |
| GET api/v1/eWeightSlips/{AwbNo}/PDF |
Print E-Weight Slips's PDF |
| GET api/v1/eWeightSlips/Agents/{agentID}/{timeStamp} |
Get E-Weight Slip Based on AgentID |
| GET api/v1/eWeightSlips/Agents/{agentID}/AWBs/{awbNumber} |
Get E-Weight Slip Based on AWBNumber |
| POST api/v1/eWeightSlips |
Create E-Weight Slip |
| PUT api/v1/eWeightSlips/Mawb/{mawbno} |
Fetch EWS |
ExtendExpiry
| API | Description |
|---|---|
| PUT api/v1/Shipments/{ShipmentID}/ExtendExpiry |
Extending RFQ date with reason |
ExtendValidity
ExtendValidityController
| API | Description |
|---|---|
| PUT api/v1/Shipments/{ShipmentID}/RFQs/{RFQID}/Quotes/{id}/ExtendValidity |
Update Extend Validity |
Feedback
FeedbackController
| API | Description |
|---|---|
| POST api/v1/Feedback/submitFeedback |
Send lead e-mail |
Geocoding
GeocodingController
| API | Description |
|---|---|
| GET api/v1/Geocoding?address={address} |
GetAddresses |
| GET api/v1/Geocoding?City={City}&Country={Country} |
GetAddresses |
HAWB
| API | Description |
|---|---|
| DELETE api/v1/MAWB/{MawbID}/HAWB/{id} | |
| GET api/v1/MAWB/{MawbID}/HAWB |
Retrieves an array of HAWBs under MAWB for current logged in agent. |
| GET api/v1/MAWB/{MawbID}/HAWB/{HawbID}/PDF |
ExportHawbPDF |
| GET api/v1/MAWB/{MawbID}/HAWB/{id} |
Retrieves an array of HAWBs under MAWB for current logged in agent. |
| POST api/v1/MAWB/{MawbID}/HAWB |
Create HAWB |
| PUT api/v1/MAWB/{MawbID}/HAWB/{id} |
Update HAWB |
HawbV2
| API | Description |
|---|---|
| GET api/v2/MAWB/{MawbID}/HAWB |
FindAllByMawbId |
| GET api/v2/MAWB/{MawbID}/HAWB/{id} |
FindByMawbHawbId |
| POST api/v2/MAWB/{MawbID}/HAWB |
Create HAWB |
HSCodesMaster
HSCodesMaster Api Controller
| API | Description |
|---|---|
| GET api/v1/HSCodesMaster/{id} |
Gets a Harmonized System by Harmonized System Codes. |
| GET api/v1/HSCodesMaster?search={search}&sort={sort} |
Retrieves an array of HS Codes based on the criteria. |
IncomingSITATexLog
IncomingSITATexLogController
| API | Description |
|---|---|
| PUT api/v1/IncomingSITATexLog |
Insert Incoming SITA Tex Log |
JobAgentsStatusEvent
Agents JobStatusEvent Controller RoutePrefix: api/v1/Jobs/Agents/{AgentID:int}/Jobs
| API | Description |
|---|---|
| DELETE api/v1/Jobs/Agents/{AgentID}/Jobs/{JobMasterNo}/StatusEvents/{StatusID} |
Delete /api/v |
| GET api/v1/Jobs/Agents/{AgentID}/Jobs/{JobMasterNo}/House/{JobHouseNo}/StatusEvents/{Timestamp} |
GET /api/v1/Jobs/Agents/{AgentID}/Jobs/{JobMasterNo}/House/{JobHouseNo}/StatusEvents |
| GET api/v1/Jobs/Agents/{AgentID}/Jobs/{JobMasterNo}/StatusEvents/{Timestamp} |
GET /api/v1/Jobs/Agents/{AgentID}/Jobs/{JobMasterNo}/StatusEvents/{Timestamp} |
| POST api/v1/Jobs/Agents/{AgentID}/Jobs/{JobMasterNo}/House/{JobHouseNo}/StatusEvents |
POST /api/v1/Jobs/Agents/{AgentID}/Jobs/{JobMasterNo}/House/{JobHouseNo}/StatusEvents |
| POST api/v1/Jobs/Agents/{AgentID}/Jobs/{JobMasterNo}/StatusEvents |
POSTAgents/{AgentID:int}/Jobs/{JobMasterNo}/StatusEvents/ |
| PUT api/v1/Jobs/Agents/{AgentID}/Jobs/{JobMasterNo}/StatusEvents/{StatusID} |
PUT /api/v1/Jobs/{JobMasterNo}/StatusEvents/{StatusID} |
JobBatchList
JobBatchListController
| API | Description |
|---|---|
| POST api/v1/Agents/{AgentID}/Jobs/{JobMasterNo}/BatchList |
Refresh |
| POST api/v1/Agents/BatchList/SendAll |
RefreshAll |
JobCards
JobCardsController
JobHouse
JobMessaging
Job Messaging Controller
| API | Description |
|---|---|
| POST api/v1/Jobs/Messaging/315 |
315 Status Details |
Jobs
JobsController
| API | Description |
|---|---|
| DELETE api/v1/Jobs/{JobMasterID} |
Delete a Job |
| GET api/v1/Jobs/{id} |
GetById |
| GET api/v1/Jobs/{JobMasterNo} |
GetById |
| GET api/v1/Jobs/Agents/{AgentID}/Jobs/StatusEvents |
GET /api/v1/Jobs/Agents/{AgentID}/Jobs/StatusEvents |
| GET api/v1/Jobs/Agents/{timestamp} |
GetJobAgents by Timestamp |
| GET api/v1/Jobs/Agents?AgentID={AgentID}&NetworkID={NetworkID}&AgentName={AgentName}&CityCode={CityCode}&CityName={CityName}&CountryCode={CountryCode}&CountryName={CountryName} |
Retrieves an array of jobs agent available in WIN bases on the following criteria |
| GET api/v1/Jobs/MyJobs |
GetMyJobs |
| GET api/v1/Jobs/MyJobs/{AgentID} |
GetMyJobs |
| GET api/v1/Jobs/MyJobs/{AgentID}/{Timestamp} |
GetMyJobs |
| GET api/v1/Jobs/MyJobs/{Timestamp} |
GetMyJobs |
| POST api/v1/Jobs |
Post to Create JobMaster |
| POST api/v1/Jobs/notifications |
Email Scheduler Notifications Service |
| POST api/v1/Jobs/SendEmail/{eventID} | |
| PUT api/v1/Jobs/Agents/{AgentID}/Jobs/{JobMasterNo} |
Put to Update JobMaster |
JobSample
Job Sample API Controller
| API | Description |
|---|---|
| GET api/v1/JobSample |
GetAllJobs |
| GET api/v1/JobSample/Types?id={id} |
GetById |
| POST api/v1/JobSample |
Create a new job |
JobsCustomerVisibility
Jobs Customer Visibility Controller
| API | Description |
|---|---|
| DELETE api/v1/Agents/{AgentID}/Jobs/{JobMasterNo}/CustomerVisibility |
DeleteCustomerVisibility |
| GET api/v1/Agents/{AgentID}/Jobs/{JobMasterNo}/CustomerVisibility/{id} |
Get Visible Shipments |
| POST api/v1/Agents/{AgentID}/Jobs/{JobMasterNo}/CustomerVisibility |
Create Customer Visibility |
JobsLite
JobsLiteController
| API | Description |
|---|---|
| DELETE api/v1/JobsLite/{jobMasterNo} |
Delete Job Master |
| GET api/v1/JobsLite/{jobMasterNo} |
Get an object of Job Lite |
| POST api/v1/JobsLite |
Create a JobMaster |
| PUT api/v1/JobsLite/{jobMasterNo} |
Update a JobMaster specified by JobMasterNo |
JobsLiteDashboard
JobsLiteDashboardController
| API | Description |
|---|---|
| GET api/v1/JobsLite/Dashboard/{transportMode}?masterNo={masterNo}&refidno={refidno}&partyname={partyname} |
Get Job Card filter |
JobStats
JobStats API Controller
| API | Description |
|---|---|
| GET api/v1/JobStats?from={from}&to={to} |
Get Job Stats filter |
JobStatusEvent
Job Sample API Controller
| API | Description |
|---|---|
| DELETE api/v1/Jobs/{JobMasterNo}/StatusEvents/{StatusID} |
Delete /api/v1/Jobs/{JobMasterNo}/StatusEvents/{StatusID} |
| GET api/v1/Jobs/{JobMasterNo}/House/{JobHouseNo}/StatusEvents/{Timestamp} |
GET /api/v1/Jobs/{JobMasterNo}/House/{JobHouseNo}/StatusEvents |
| GET api/v1/Jobs/{JobMasterNo}/StatusEvents/{Timestamp} |
GET /api/v1/Jobs/{JobMasterNo}/StatusEvents/ |
| POST api/v1/Jobs/{JobMasterNo}/StatusEvents |
POST /api/v1/Jobs/{JobMasterNo}/StatusEvents |
| PUT api/v1/Jobs/{JobMasterNo}/StatusEvents/{StatusID} |
PUT /api/v1/Jobs/{JobMasterNo}/StatusEvents/{StatusID} |
JobUCTCarrier
Job UCT Carriers Controller
| API | Description |
|---|---|
| POST api/v1/UCTApi/Job |
Call a UCT API |
| POST api/v1/UCTApi/Job/{jobMasterNo} |
Call a UCT API with Reference No |
JobValuesMaster
JobValuesMasterController
| API | Description |
|---|---|
| GET api/v1/JobValuesMaster |
Get key identifiers |
| GET api/v1/JobValuesMaster/{KeyIdentifier} |
Get JobValuesMaster by KeyIdentifier. |
| GET api/v1/JobValuesMaster/StatusEvents |
Get status's event. |
ListofAWBs
| API | Description |
|---|---|
| GET api/v1/ListofAWBs |
Get AWB's list. |
| GET api/v1/ListofAWBs/{AgentID} |
Get AWB's list by agent id. |
ListofBookings
Air Booking Status Api Controller
| API | Description |
|---|---|
| GET api/v1/Agent/{AgentID}/ListofBookings/{Timestamp} |
Get list of bookings by AgentId and Timestamp |
ListValuesMaster
ListValuesMaster Api Controller
| API | Description |
|---|---|
| GET api/v1/ListValuesMaster |
Retrieves an array of identifier available for list values. |
| GET api/v1/ListValuesMaster/{id} |
Retrieves an array of list values identified by id. Where id is identifier. |
Login
Login Api Controller
| API | Description |
|---|---|
| GET api/v1/login |
Retrieves user |
| GET api/v1/login/validateToken?authToken={authToken}&returnUrl={returnUrl} |
ValidateToken |
| GET api/v1/msdb/generateauthtoken/{msdbid} |
Retrieves MSDB user |
| POST api/v1/login/{brand}?returnUrl={returnUrl} |
whitelabelcustomerlogin |
| POST api/v1/login/Network/{network} |
Login for Network users. |
| POST api/v1/login?returnUrl={returnUrl} |
Login |
| POST api/v1/LoginForm?returnUrl={returnUrl} |
LoginForm - handle login by form submission instead of RESTful API call. |
Logout
Logout Api Controller
| API | Description |
|---|---|
| GET api/v1/Logout?returnUrl={returnUrl} |
Logout |
Manifest
Manifest Api Controller
| API | Description |
|---|---|
| GET api/v1/MAWB/{id}/Manifest |
Retrieves the ManifestDTO. |
| GET api/v1/MAWB/{id}/Manifest/PDF |
Print Manifest's PDF |
MAWB
MAWB Api Controller
| API | Description |
|---|---|
| DELETE api/v1/MAWB/{id}?ForceDelete={ForceDelete} |
Deletes a MAWB. |
| GET api/v1/MAWB |
Gets a MAWB by MAWBID. |
| GET api/v1/MAWB/{mawbId} |
Gets a MAWB by MAWBID. |
| GET api/v1/MAWB/{MawbID}/PDF |
Get AwbPrint as PDF format. |
| GET api/v1/MAWB/{MawbID}/PDF/eCSD |
Get eCSD as PDF format. |
| POST api/v1/MAWB |
Saves a MAWB and returns the saved object. |
| PUT api/v1/MAWB/{id} |
Updates a MAWB. |
MawbV2
| API | Description |
|---|---|
| GET api/v2/MAWB/{mawbId} |
FindMawbById |
| POST api/v2/MAWB |
Create a new Master Airway Bill |
MobileWhiteLabel
Mobile White Label Controller
| API | Description |
|---|---|
| GET api/v1/Agents/{AgentID}/MobileWhiteLabel/MOTD |
Get Message of the day - kept for backward compatibility |
| GET api/v1/Agents/{AgentID}/MobileWhiteLabel/MOTD?brand={brand} |
Get Message of the day |
| GET api/v1/brands |
Get Message of the day |
| POST api/v1/Agents/{AgentID}/MobileWhiteLabel/RateRequest |
Rate Request |
MSDB
MSDB Controller
| API | Description |
|---|---|
| PUT api/v1/msdb/Agents/{msdbId} |
Update Agent from MSDB |
| PUT api/v1/msdb/Agents/{msdbId}/membership |
Add/Update MSDB username |
| PUT api/v1/msdb/Agents/{msdbId}/networks |
Add,Update and Delete WCA Network in WIN Agent |
| PUT api/v1/msdb/Agents/{msdbId}/services |
Add,Update and Delete WCA Service in WIN Agent |
MSDBNetwork
MSDB Network Controller
| API | Description |
|---|---|
| PUT api/v1/msdb/Agents/msdbNetworkSyncSchedular/{networkId} |
Sync msdb network for mobile network users |
MyBookingRequests
MyBookingRequestsController
| API | Description |
|---|---|
| GET api/v1/MyBookingRequests/{AgentID} |
Retrieves a list of My Booking |
MyShipment
My Shipment Controller
MyShipmentTracking
| API | Description |
|---|---|
| GET api/v1/Agents/{AgentID}/Awbs/{MawbID}/Tracking |
No documentation available. |
| GET api/v1/Agents/{AgentID}/Jobs/{JobMasterNo}/Houses/Tracking |
No documentation available. |
| GET api/v1/Agents/{AgentID}/Jobs/{JobMasterNo}/Tracking |
No documentation available. |
NetworksMaster
NetworksMaster Api Constroller
| API | Description |
|---|---|
| DELETE api/v1/NetworksMaster/{id} |
Delete the network master by id |
| GET api/v1/NetworksMaster |
Retrieves an array of networks. |
| GET api/v1/NetworksMaster/{code} |
Retrieves a network master by network code |
| GET api/v1/NetworksMaster/{id} |
Retrieves a network master by id. |
| POST api/v1/NetworksMaster |
Create a Network Master |
| PUT api/v1/NetworksMaster/{id} |
Update a Network Master |
Notifications
api/{v}/Notifications
| API | Description |
|---|---|
| POST api/v1/Notifications/{EventID} |
Post notitfication to send an email services |
| POST api/v1/Notifications/Dismiss/{EventID} |
Email Dismiss Dismiss email notification after 3days. |
| POST api/v2/Notifications/{EventID} |
Post notitfication to send an email services |
OBC
OBC (On Board Courier) Controller
| API | Description |
|---|---|
| GET api/v1/wca/timecritical/obc/list |
Get WCA Time Critical OBC List |
OceanPortsMaster
OceanportsMaster Api Controller
| API | Description |
|---|---|
| GET api/v1/OceanPortsMaster/{code} |
Retrieves the ocean port identified by id. Where id is ocean port code. |
| GET api/v1/OceanPortsMaster?search={search}&sort={sort} |
Retrieves an array of ocean ports based on the following criteria. |
Offers
OffersController
| API | Description |
|---|---|
| DELETE api/v1/Offers/{offerID} |
Delete offer |
| GET api/v1/Offers |
Get offers |
| GET api/v1/Offers/{id} |
Get offer by specific offer ID |
| POST api/v1/Offers |
Create offer |
| POST api/v1/Offers/SendLead/{offerID} |
Send lead e-mail |
| POST api/v1/Offers/UpdateStatistic/{offerID} |
Update statistic |
| PUT api/v1/Offers/{offerID} |
Update offer |
OrganizationMaster
Organisation Master Controller
| API | Description |
|---|---|
| GET api/v1/OrganizationMaster?Search={Search} |
Get Organization List |
PackageTypes
PackageTypesController
| API | Description |
|---|---|
| GET api/v1/PackageTypes/{code} |
Retrieves the Package Type identified by id (Code). |
| GET api/v1/PackageTypes?search={search}&sortby={sortby} |
Retrieves an array of Package Type. |
PouchAgents
PouchAgentsController
| API | Description |
|---|---|
| GET api/v1/Air/Agents/{timestamp} |
Get Air Agents by Timestamp |
| GET api/v1/Air/Agents?AgentID={AgentID}&NetworkID={NetworkID}&AgentName={AgentName}&CityCode={CityCode}&CityName={CityName}&CountryCode={CountryCode}&CountryName={CountryName} |
Retrieves an array of airfreight agent available in WIN bases on the following criteria |
| GET api/v1/Pouch/agents |
Retrieves the profile of currently logged in agent. |
PouchLogin
Pouch Login
| API | Description |
|---|---|
| POST api/v1/Pouch/Login?returnUrl={returnUrl} |
Login |
Profiles
MSDB Controller
| API | Description |
|---|---|
| GET api/v1/msdb/profiles/{id} |
Get WCA Members profile |
PublicAgents
Public Agents Api Controller
| API | Description |
|---|---|
| GET api/pub/Agents |
Retrieves an array of IATA Airlines. |
| GET api/pub/Agents/{countryCode} |
Retrieves an array of WIN agents |
PushMessagingConf
PushMessagingConfController
| API | Description |
|---|---|
| DELETE api/v1/Users/{userId}/PushMessagingConf/{deviceId} |
Delete agent contact's device by user ID, device ID |
| GET api/v1/Users/{userId}/PushMessagingConf |
Get AgentContactDevices by user ID |
| GET api/v1/Users/{userId}/PushMessagingConf/{id} |
Get AgentContactDevice by user ID and ID |
| POST api/v1/Users/{userId}/PushMessagingConf |
Add AgentContactDevices |
| PUT api/v1/Users/{userId}/PushMessagingConf |
Update AgentContactDevices |
PushSample
Push Notification Sample
| API | Description |
|---|---|
| POST api/v1/PushSample |
Push |
Quotes
Quotes Api Controller
| API | Description |
|---|---|
| GET api/v1/Quotes/Agents |
Retrieves an array of agent available in WIN by login user with sales permission and bases on the following criteria agentName: Agent Name.(Option) networksName: Networks Name or Networks Code.(Option) countryName: Country name or ISO code. Minimum length is 2 characters. (Option) cityName: City name or UN Location code. Minimum length is 2 characters. (optional) type: If type = agents then get agent only, If type = AddressBooks then get addressbook only, If type = null then get agents + addressbooks(option) sortBy: Field to sort on. prepend + or - to indicate ascending or descending. Defalult to +AgentName (optional) context: Action Page : RFQ, Airfreight or Admin (requried) contactType: Contact Type for filter WINID service |
| GET api/v1/Quotes?ShipmentID={ShipmentID}&RFQID={RFQID} |
Get a Quote by RFQ ID. |
| GET api/v1/Shipments/{ShipmentID}/Quotes |
Gets a list of Quotes by ShipmentId. |
| GET api/v1/Shipments/{ShipmentID}/RFQs/{RFQID}/Quotes |
Get a Quote by RFQ ID. |
| GET api/v1/Shipments/{ShipmentID}/RFQs/{RFQID}/Quotes/{id} |
Get a Quote by Quote ID. |
| POST api/v1/Quotes |
Saves a Quote. and returns the saved object. |
| POST api/v1/Shipments/{ShipmentID}/AwaitConfirmationAll |
Await Confirmation All |
| POST api/v1/Shipments/{ShipmentID}/DeclineAll |
Decline all quotes |
| POST api/v1/Shipments/{ShipmentID}/RFQs/{RFQID}/Quotes |
Saves a Quote. and returns the saved object. |
| POST api/v1/Shipments/{ShipmentID}/RFQs/{RFQID}/Quotes/{id}/Status/{Status} |
Updates a Quote status, It requires feedbacks of quotes which needs to be marked as declined in case of status as Awarded. |
| PUT api/v1/Shipments/{ShipmentID}/RFQs/{RFQID}/Quotes |
Updates a Quote. |
QuotesFeedback
Quotes Feedback Api Controller
| API | Description |
|---|---|
| GET api/v1/Shipments/{ShipmentID}/RFQs/{RFQID}/Quotes/{QuoteID}/Feedback/{id} |
Retrives a Quotes Feedback based on QuoteID. |
| POST api/v1/Shipments/{ShipmentID}/RFQs/{RFQID}/Quotes/{QuoteID}/Feedback |
Saves a Quotes Feedback. and returns the saved object. |
RateRequest
RateRequest Controller
| API | Description |
|---|---|
| GET api/v1/Agents/{AgentID}/RateRequest/{ID} |
GetRateRequest |
| GET api/v1/Agents/{AgentID}/RateRequest/Dashboard |
GetRateRequestDashboard |
| POST api/v1/Agents/{AgentID}/RateRequest |
CreateRateRequest |
| PUT api/v1/Agents/{AgentID}/RateRequest/{ID}/Status/{Status} |
UpdateRateRequestStatus |
Rates
Special Rates Controller
| API | Description |
|---|---|
| GET api/v1/EYBookingAvailable |
EYBookingAvailable - returns true if the calling agent has EY as a carrier with EBooking enabled. |
| GET api/v1/Rates?carrierCode={carrierCode}&fromPort={fromPort}&toPort={toPort} |
GetPorts |
| GET api/v1/RatesPorts?carrierCode={carrierCode}&direction={direction}&Name={Name}&otherPort={otherPort} |
GetPorts |
| PUT api/v1/Rates/Update |
Update rates |
Report
Report
ResendAWB
SendFWB Api Controller
| API | Description |
|---|---|
| GET api/v1/Awb/ResendFHLList |
No documentation available. |
| PUT api/v1/Awb/Resend |
Resend failed MAWB and HAWB |
ResetPassword
| API | Description |
|---|---|
| POST api/v1/user/do/ResetPassword |
To send request to reset password |
RFQDiscussions
| API | Description |
|---|---|
| GET api/v1/Shipments/{ShipmentID}/RFQs/{RFQID}/Discussions |
Retrieves the discussion identified by id. |
| GET api/v1/Shipments/{ShipmentID}/RFQs/{RFQID}/Discussions/{id} |
Retrieves an array of discussions identified by RFQ ID. |
| POST api/v1/Shipments/{ShipmentID}/RFQs/{RFQid}/Discussions |
Create a new discussion |
RFQFeedback
| API | Description |
|---|---|
| GET api/v1/Shipments/{ShipmentID}/RFQs/{RFQID}/Feedback/{id} |
Retrieves the feedback identified by RFQ ID. |
| POST api/v1/Shipments/{ShipmentID}/RFQs/{RFQid}/Feedback |
Create a feedback of RFQ. |
RFQs
| API | Description |
|---|---|
| GET api/v1/Shipments/{ShipmentID}/RFQs |
Retrieves the RFQ identified by ShipmentID |
| GET api/v1/Shipments/{shipmentid}/RFQs/{id} |
Retrieves the RFQ identified by id. |
| POST api/v1/Shipments/{ShipmentID}/RFQs |
Create a New RFQ. |
RolesMaster
RolesMaster Api Constroller
| API | Description |
|---|---|
| DELETE api/v1/RolesMaster/{id} |
Delete a role master by id |
| GET api/v1/RolesMaster |
Retrieves an array of role available for rolw master. |
| GET api/v1/RolesMaster/{id} |
Retrieves a role master identified by id. |
| POST api/v1/RolesMaster |
Create a role master. |
| PUT api/v1/RolesMaster |
Update a role master. |
Schedules
OAG Air schedules
SeaAgents
SeaAgentsController
| API | Description |
|---|---|
| GET api/v1/Sea/Agents?AgentID={AgentID}&NetworkID={NetworkID}&AgentName={AgentName}&CityCode={CityCode}&CityName={CityName}&CountryCode={CountryCode}&CountryName={CountryName} |
Retrieves an array of seafreight agent available in WIN bases on the following criteria |
SEACards
Air Way Bill Card
| API | Description |
|---|---|
| GET api/v1/SEACards?type={type}&status={status}&blNumber={blNumber}&party={party}&port={port} |
Get SEA Card filter by Booking Status |
SeaCarrierMaster
SeaCarrierMaster Api Constroller
| API | Description |
|---|---|
| GET api/v1/SeaCarrierMaster/{scac} |
Retrieves a ocean carriers specified by SCAC Code |
| GET api/v1/SeaCarrierMaster?search={search}&sort={sort}&activated={activated} |
Retrieves an array of ocean carriers. |
Sealines
Sealines Api Constroller
| API | Description |
|---|---|
| GET api/pub/Sealines/{scac} |
Retrieves a Sealine identified by SCAC Code |
| GET api/pub/Sealines?search={search}&sort={sort}&activated={activated} |
Retrieves an array of Sealine. |
SeaSchedules
Sea Schedules access from the Web and Mobile.
SEAStats
AWBStats Api Controller
| API | Description |
|---|---|
| GET api/v1/SEAStats?bookingOrigin={bookingOrigin} |
Retreives all of SEA Stats Optional query param: bookingOrigin=All|WIN|INTTRA |
SeaTracking
Sea Tracking API Controller Endpoints: Get api/v1/SeaTracking/Agents/{AgentID} Get api/v1/SeaTracking/BLNumber/{BLNumber} Get api/v1/SeaTracking/Bookings/{BookingNumber} Get api/v1/SeaTracking/Containers/{ContainerNumber} Get api/v1/SeaTracking/Agents/{AgentID}/Bookings/{BookingID} Get api/v1/SeaTracking/Agents/{AgentID}/Bookings/{BookingID}/Containers/{ContainerNo}
| API | Description |
|---|---|
| GET api/v1/BookingRequests/{BookingID}/Tracking |
Retrieve tracking by Booking ID |
| GET api/v1/SeaTracking/Agents/{AgentID}/{Timestamp} |
Retrieve tracking by Agent ID |
| GET api/v1/SeaTracking/Agents/{AgentID}/Bookings/{BookingID}/{Timestamp} |
Retrieve tracking by Booking ID |
| GET api/v1/SeaTracking/Agents/{AgentID}/Bookings/{BookingID}/Containers/{ContainerNo}/{Timestamp} |
Retrieve tracking by Container No. |
| GET api/v1/SeaTracking/BLNumber/{BLNumber}/{Timestamp} |
Retrieve tracking by BL Number |
| GET api/v1/SeaTracking/Bookings/{BookingNumber}/{Timestamp} |
Retrieve tracking by Booking Number |
| GET api/v1/SeaTracking/Containers/{ContainerNumber}/{Timestamp} |
Retrieve tracking by Container Number |
SeaTrackingOI
SeaTrackingOI API Controller
| API | Description |
|---|---|
| GET api/v1/SeaTrackingOI?Operator={Operator}&No={No}&Type={Type} |
GetOceanInsights |
SeaValuesMaster
SeaValuesMaster Api Constroller
| API | Description |
|---|---|
| GET api/v1/SeaValuesMaster |
Retrieves an array of identifier available for sea values. |
| GET api/v1/SeaValuesMaster/{id} |
Retrieves an array of sea values identified by id. Where id is identifier. |
SendFHL
| API | Description |
|---|---|
| GET api/v1/MAWB/{MawbId}/SendFHL/{id} |
Retrieves the FHLMessageDTO. HawbID is needed. |
| PUT api/v1/MAWB/{MawbID}/SendFHL |
Send FHL message. |
| PUT api/v1/MAWB/{MawbID}/SendFHL2 |
Send FHL message. |
SendFWB
SendFWB Api Controller
| API | Description |
|---|---|
| PUT api/v1/MAWB/{id}/SendFWB |
Sends a MAWB to carrier. |
SendXML
SendXMLController
| API | Description |
|---|---|
| PUT api/v1/BookingRequests/{id}/SendXML |
Send Booking Request to Carrier |
Shipments
ShipmentsController
| API | Description |
|---|---|
| DELETE api/v1/Shipments/{shipmentId} |
Deletes (or Cancel) the Shipment identified by id. |
| GET api/v1/Shipments/{shipmentId} |
Retrieves the Shipment identified by id |
| GET api/v1/Shipments?sortBy={sortBy}&service={service}&searchField={searchField}&search={search} |
Retrieves an array of shipments available in WIN bases on the following criteria |
| POST api/v1/Shipments |
Create new shipment |
| PUT api/v1/Shipments/{shipmentId} |
Updates the shipment identified by ShipmentID. |
ShipmentsCards
ShipmentsCards Api Controller
ShipmentsCargos
Shipment Cargos Controllers
| API | Description |
|---|---|
| GET api/v1/ShipmentsCargos/{id} |
Get a ShipmentsCargos according to the cargoID |
| GET api/v1/ShipmentsCargos?shipmentID={shipmentID} |
Get a list of ShipmentsCargosDTO according to the shipmentID |
ShipmentsStats
ShipmentsStats Api Controller
| API | Description |
|---|---|
| GET api/v1/ShipmentsStats?transportMode={transportMode} |
Retreives all of ShipmentsStats |
Store
Store Api Controller
| API | Description |
|---|---|
| DELETE api/v1/Store/{id} |
Delete specific item by ID |
| GET api/v1/Store |
GET a list of Store By Context and Label, owned by the Current Agent |
| GET api/v1/Store/{id} |
Get a specific item by id |
| POST api/v1/Store |
Create Store by Context and Label to the current Agent |
| PUT api/v1/Store/{id} |
Update Store by Context and Label to the current Agent |
Subdivisions
SubdivisionsController
| API | Description |
|---|---|
| GET api/v1/Subdivisions/{id} |
Retrieves the Subdivision identified by id. |
| GET api/v1/Subdivisions?search={search}&country={country}&sort={sort} |
Retrieves an array of Subdivisions. |
Transaction
Transaction
| API | Description |
|---|---|
| GET api/v1/Transaction/AirBooking/{Timestamp} |
Get Booking based on timestamp |
| GET api/v1/Transaction/awb/{timestamp}/count/{count} |
Get List of Awbs by Timestamp |
| GET api/v1/Transaction/awb/{timestamp}?count={count} |
Get List of Awbs by Timestamp |
| GET api/v1/Transaction/Job/{Timestamp} |
GetJobs |
| GET api/v1/Transaction/parallelawb/{timestamp} |
Get List of Awbs by Timestamp |
| GET api/v1/Transaction/parallelawb/{timestamp}/count/{count} |
Get List of Awbs by Timestamp |
TSC
TSC Controller
| API | Description |
|---|---|
| POST api/v1/TSC/{AgentID} |
Create Subscription with WIN Services |
UAT
UATController
| API | Description |
|---|---|
| GET api/v1/UAT/Carriers |
GetCarriers |
| GET api/v1/UAT/Search |
GetTrack |
UATApi
UAT Api Controller
| API | Description |
|---|---|
| GET api/v1/UATApi/Carriers |
GetCarriers |
| GET api/v1/UATApi/Search |
GetTrack |
UATBatchList
BatchListController
| API | Description |
|---|---|
| DELETE api/v1/UATApi/BatchList/Agents/{AgentID} |
DeleteBatchList |
| DELETE api/v1/UATApi/BatchList/Agents/{AgentID}/{carrier}/{searchKey}/{searchValue} |
DeleteBatchList |
| GET api/v1/UATApi/BatchList/Agents/{AgentID} |
GetBatchList |
| GET api/v1/UATApi/BatchList/Agents/{AgentID}/{carrier}/{searchKey}/{searchValue} |
GetBatchList |
| POST api/v1/UATApi/BatchList/Agents/{AgentID} |
CreateBatchList |
UATWhiteLabel
UAT White Label Controller api/v1/UAT/WhiteLabel api/v1/UAT/WhiteLabel/Search?AwbNo={AwbNo} api/v1/UAT/WhiteLabel/Search?AwbNo={AwbNo}&AllowAllCarriers api/v1/UAT/WhiteLabel/Carriers
| API | Description |
|---|---|
| GET api/v1/UAT/WhiteLabel |
Checking authorize with Referer Allow user with Contacttype="API", Role="airtrackingwhitelabel" & has UATReferer |
| GET api/v1/UAT/WhiteLabel/Carriers |
GetCarriers |
| GET api/v1/UAT/WhiteLabel/Search?AwbNo={AwbNo}&captchaText={captchaText} |
Get Tracking |
UCT
SeaTracking API Controller api/v1/UCT/Operators api/v1/UCT/TrackOptions api/v1/UCT/Search?Operator={Operator}&No={No}&Type={Type} api/v1/UCT/Search?Operator={Operator}&No={No}&Type={Type}&AllowAllCarriers api/v1/UCT/Carriers
| API | Description |
|---|---|
| GET api/v1/UCT/Carriers |
Retrieves an array of ocean insights's carrier |
| GET api/v1/UCT/Search?Operator={Operator}&No={No}&Type={Type} |
Search oceaninsights track & trace |
| GET api/v1/UCT/Search?Operator={Operator}&No={No}&Type={Type}&AllowAllCarriers={AllowAllCarriers} |
Search oceaninsights track & trace |
UCTApi
SeaTracking API Controller api/v1/UCTApi api/v1/UCTApi/Operators api/v1/UCTApi/TrackOptions api/v1/UCTApi/Search?Operator={Operator}&No={No}&Type={Type} api/v1/UCTApi/Search?Operator={Operator}&No={No}&Type={Type}&AllowAllCarriers api/v1/UCTApi/Carriers
| API | Description |
|---|---|
| GET api/v1/UCTApi/Carriers |
Retrieves an array of ocean insights's carrier |
| GET api/v1/UCTApi/Search?Operator={Operator}&No={No}&Type={Type} |
Search oceaninsights track & trace |
| GET api/v1/UCTApi/Search?Operator={Operator}&No={No}&Type={Type}&AllowAllCarriers={AllowAllCarriers} |
Search oceaninsights track & trace |
UNLocodes
UNLocodesController Api Controller
| API | Description |
|---|---|
| GET api/v1/UNLocodes/{code} |
Retrieves the UN Location identified by code. |
| GET api/v1/UNLocodes/{id} |
Retrieves the UN Location identified by id. |
| GET api/v1/UNLocodes?search={search}&sort={sort} |
Get a list of all UNLocation master by search string |
| PUT api/v1/UNLocodes/{id} |
Update the UNLocode |
Users
User Api Controller
| API | Description |
|---|---|
| GET api/vX/Users/{userID}/LoginHistory |
Retrieves a user's aggregated login history specified by UserID and available to administrator permission. |
WAS
WASController - WIN Air Schedules Controller - quick hack until Universal Proxy (WUP) is ready.
| API | Description |
|---|---|
| GET api/v1/WAS |
Get Air Schedules |
| GET api/v1/WAS/alternativePorts |
Get Air Schedules |
| GET api/v1/WAS/ports |
Get Air Schedules |
| GET api/v1/WASapi |
Get Air Schedules |
| GET api/v1/WASapi/alternativePorts |
Get Air Schedules |
| GET api/v1/WASapi/ports |
Get Air Schedules |
WhiteLabel
WhiteLabel API Controller api/v1/UCT/WhiteLabel api/v1/UCT/WhiteLabel/Operators api/v1/UCT/WhiteLabel/TrackOptions api/v1/UCT/WhiteLabel/Search?Operator={Operator}&No={No}&Type={Type} api/v1/UCT/WhiteLabel/Search?Operator={Operator}&No={No}&Type={Type}&AllowAllCarriers api/v1/UCT/WhiteLabel/Carriers
| API | Description |
|---|---|
| GET api/v1/UCT/WhiteLabel |
Checking authorize with Referer Allow user with Contacttype="API", Role="seatrackingwhitelabel" & has UCTReferer |
| GET api/v1/UCT/WhiteLabel/Carriers |
Retrieves an array of ocean insights's carrier |
| GET api/v1/UCT/WhiteLabel/Search?Operator={Operator}&No={No}&Type={Type}&AllowAllCarriers={AllowAllCarriers}&captchaText={captchaText} |
Search oceaninsights track & trace |
| GET api/v1/UCT/WhiteLabel/Search?Operator={Operator}&No={No}&Type={Type}&captchaText={captchaText} |
Search oceaninsights track & trace |
WUTScheduler
WUTSchedulerController