Bridge

<back to all web services

EnquiriesLive

Enquiries
The following routes are available for this service:
GET/Enquiries/Live
EnquiriesLive Parameters:
NameParameterData TypeRequiredDescription
JustMyEnquiriesqueryboolNo
LiveEnquiriesForContactAndEntityViewModel Parameters:
NameParameterData TypeRequiredDescription
JustMyEnquiriesformboolNo
CanViewCompanyEnquiriesformboolNo
EntityContactGuidformGuidNo
ShowCreateNewEnquiryButtonformboolNo
EntityContactformEntityContactViewModelNo
GetLiveEnquiriesForContactAndEntityformList<GetLiveEnquiriesForContactAndEntityViewModel>No
EntityContactViewModel Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
GuidformGuidNo
EntityIdformintNo
FirstNameformstringNo
LastNameformstringNo
InitialsformstringNo
PasswordformstringNo
EmailAddressformstringNo
DarkModeformboolNo
EntityformEntityViewModelNo
LastActiveformDateTime?No
ImageGuidformGuidNo
DialingCodeCountryIdformint?No
TelephoneNumberformstringNo
IsBridgeClientformboolNo
AccessLevelsformList<GetAllAccessLevelsForEntityContactIdViewModel>No
EntityViewModel Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
GuidformGuidNo
TypeformstringNo
NameformstringNo
SuperTraderformboolNo
CompanyDomainformstringNo
KYCStartedByformintNo
KYCCompletedByformintNo
ETSMOHAAccountformstringNo
GetAllAccessLevelsForEntityContactIdViewModel Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
AllowedformboolNo
NameformstringNo
DescriptionformstringNo
PrettyTextformstringNo
GetLiveEnquiriesForContactAndEntityViewModel Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
GuidformGuidNo
FlagRoundformbyte[]No
CountryNameformstringNo
PortNameformstringNo
LatitudeformdoubleNo
LongitudeformdoubleNo
VesselNameformstringNo
IMONumberformintNo
DeliveryDateformstringNo
CompaniesformstringNo
GetLiveEnquiriesForContactAndEntityCompaniesListformList<GetLiveEnquiriesForContactAndEntityCompaniesListViewModel>No
GetLiveEnquiriesForContactAndEntityBeingWorkedOnByListformList<GetLiveEnquiriesForContactAndEntityBeingWorkedOnByListViewModel>No
GetEnquiryChatListForContactIdformList<GetEnquiryChatListForContactIdViewModel>No
GetLiveEnquiriesForContactAndEntityVolumeDescriptionformList<GetLiveEnquiriesForContactAndEntityVolumeDescriptionViewModel>No
GetLiveEnquiriesForContactAndEntityCompaniesListViewModel Parameters:
NameParameterData TypeRequiredDescription
CompanyNameformstringNo
ChatGuidformGuidNo
EntityContactGuidformGuidNo
EntityContactImageGuidformGuidNo
EntityContactNameformstringNo
UnreadMessagesForEntityContactformintNo
GetLiveEnquiriesForContactAndEntityBeingWorkedOnByListViewModel Parameters:
NameParameterData TypeRequiredDescription
HandlingEnquiryNameformstringNo
GetEnquiryChatListForContactIdViewModel Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
GuidformGuidNo
ChatGuidformGuidNo
EntityIdformintNo
EntityNameformstringNo
EntityContactIdformintNo
EntityContactFirstNameformstringNo
EntityContactLastNameformstringNo
EntityContactNameformstringNo
EntityContactRoleInChatformstringNo
ChattingWithEntityIdformintNo
ChattingWithEntityNameformstringNo
ChattingWithEntityContactIdformintNo
ChattingWithEntityContactFirstNameformstringNo
ChattingWithEntityContactLastNameformstringNo
ChattingWithEntityContactNameformstringNo
ChattingWithEntityContactNameAndEntityformstringNo
ChattingWithEntityContactRoleInChatformstringNo
UnreadMessagesForEntityContactformintNo
LastMessageDateTimeformstringNo
LastMessageTextformstringNo
ChatIdformintNo
LastMessageWasFromMeformboolNo
LastMessageDeliveredformboolNo
LastMessageReadformboolNo
ChattingWithEntityContactGuidformGuidNo
DealRecapCodeformintNo
BannerTextformstringNo
ChattingWithEntityContactImageGuidformGuidNo
GetLiveEnquiriesForContactAndEntityVolumeDescriptionViewModel Parameters:
NameParameterData TypeRequiredDescription
VolDescriptionformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /Enquiries/Live HTTP/1.1 
Host: internal.thebunkerbridge.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	JustMyEnquiries: False,
	CanViewCompanyEnquiries: False,
	EntityContactGuid: 00000000000000000000000000000000,
	ShowCreateNewEnquiryButton: False,
	EntityContact: 
	{
		Id: 0,
		Guid: 00000000000000000000000000000000,
		EntityId: 0,
		FirstName: String,
		LastName: String,
		Initials: String,
		Password: String,
		EmailAddress: String,
		DarkMode: False,
		Entity: 
		{
			Id: 0,
			Guid: 00000000000000000000000000000000,
			Type: String,
			Name: String,
			SuperTrader: False,
			CompanyDomain: String,
			KYCStartedBy: 0,
			KYCCompletedBy: 0,
			ETSMOHAAccount: String
		},
		LastActive: 0001-01-01,
		ImageGuid: 00000000000000000000000000000000,
		DialingCodeCountryId: 0,
		TelephoneNumber: String,
		IsBridgeClient: False,
		AccessLevels: 
		[
			{
				Id: 0,
				Allowed: False,
				Name: String,
				Description: String,
				PrettyText: String
			}
		]
	},
	GetLiveEnquiriesForContactAndEntity: 
	[
		{
			Id: 0,
			Guid: 00000000000000000000000000000000,
			FlagRound: AA==,
			CountryName: String,
			PortName: String,
			Latitude: 0,
			Longitude: 0,
			VesselName: String,
			IMONumber: 0,
			DeliveryDate: String,
			Companies: String,
			GetLiveEnquiriesForContactAndEntityCompaniesList: 
			[
				{
					CompanyName: String,
					ChatGuid: 00000000000000000000000000000000,
					EntityContactGuid: 00000000000000000000000000000000,
					EntityContactImageGuid: 00000000000000000000000000000000,
					EntityContactName: String,
					UnreadMessagesForEntityContact: 0
				}
			],
			GetLiveEnquiriesForContactAndEntityBeingWorkedOnByList: 
			[
				{
					HandlingEnquiryName: String
				}
			],
			GetEnquiryChatListForContactId: 
			[
				{
					Id: 0,
					Guid: 00000000000000000000000000000000,
					ChatGuid: 00000000000000000000000000000000,
					EntityId: 0,
					EntityName: String,
					EntityContactId: 0,
					EntityContactFirstName: String,
					EntityContactLastName: String,
					EntityContactName: String,
					EntityContactRoleInChat: String,
					ChattingWithEntityId: 0,
					ChattingWithEntityName: String,
					ChattingWithEntityContactId: 0,
					ChattingWithEntityContactFirstName: String,
					ChattingWithEntityContactLastName: String,
					ChattingWithEntityContactName: String,
					ChattingWithEntityContactNameAndEntity: String,
					ChattingWithEntityContactRoleInChat: String,
					UnreadMessagesForEntityContact: 0,
					LastMessageDateTime: String,
					LastMessageText: String,
					ChatId: 0,
					LastMessageWasFromMe: False,
					LastMessageDelivered: False,
					LastMessageRead: False,
					ChattingWithEntityContactGuid: 00000000000000000000000000000000,
					DealRecapCode: 0,
					BannerText: String,
					ChattingWithEntityContactImageGuid: 00000000000000000000000000000000
				}
			],
			GetLiveEnquiriesForContactAndEntityVolumeDescription: 
			[
				{
					VolDescription: String
				}
			]
		}
	]
}