SET.API.Services

<back to all web services

GetService

The following routes are available for this service:
GET/Service/{Id}
GetService Parameters:
NameParameterData TypeRequiredDescription
IdpathGuidNo
ServiceInformation Parameters:
NameParameterData TypeRequiredDescription
DateOfServiceformstringNo
PickupTimeformstringNo
StatusformstringNo
AutoAssignTransportProviderformstringNo
AutoAssignTransportProviderIdformGuid?No
AutoAssignTranslationProviderformstringNo
AutoAssignTranslationProviderIdformGuid?No
FirstLegTransportProviderformstringNo
FirstLegTransportProviderIdformGuid?No
FirstLegTranslationProviderformstringNo
FirstLegTranslationProviderIdformGuid?No
GlueIdformintNo
LegsformList<ServiceLeg>No
ServiceTypeformstringNo
TransportationTypeIdformintNo
TransportationTypeformstringNo
LanguageIdformintNo
LanguageformstringNo
LinkToReferralformstringNo
ReferralNumberformintNo
TransportRatesformTransportProviderRatesNo
TranslationRatesformTranslationProviderRatesNo
ServiceLeg Parameters:
NameParameterData TypeRequiredDescription
LegIdformGuidNo
MilesformintNo
TravelTimeInMinutesformintNo
StartLocationformPlaceNo
EndLocationformPlaceNo
Place Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
Address1formstringNo
Address2formstringNo
CityformstringNo
StateformstringNo
ZipformstringNo
LatitiudeformstringNo
LongitudeformstringNo
TransportProviderRates Parameters:
NameParameterData TypeRequiredDescription
FlatFeeformstringNo
MileageFeeformstringNo
WaitRateformstringNo
NoShowFeeformstringNo
MilesformintNo
LoadFeeformstringNo
TranslationProviderRates Parameters:
NameParameterData TypeRequiredDescription
HourlyRateformstringNo
HoursformstringNo
MilesformstringNo
RatePerMileformstringNo
CancellationRateformstringNo
CancellationHoursformstringNo
NoShowformstringNo

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 /Service/{Id} HTTP/1.1 
Host: set-api-service-prod.azurewebsites.net 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	DateOfService: String,
	PickupTime: String,
	Status: String,
	AutoAssignTransportProvider: String,
	AutoAssignTransportProviderId: 00000000000000000000000000000000,
	AutoAssignTranslationProvider: String,
	AutoAssignTranslationProviderId: 00000000000000000000000000000000,
	FirstLegTransportProvider: String,
	FirstLegTransportProviderId: 00000000000000000000000000000000,
	FirstLegTranslationProvider: String,
	FirstLegTranslationProviderId: 00000000000000000000000000000000,
	GlueId: 0,
	Legs: 
	[
		{
			LegId: 00000000000000000000000000000000,
			Miles: 0,
			TravelTimeInMinutes: 0,
			StartLocation: 
			{
				Name: String,
				Address1: String,
				Address2: String,
				City: String,
				State: String,
				Zip: String,
				Latitiude: String,
				Longitude: String
			},
			EndLocation: 
			{
				Name: String,
				Address1: String,
				Address2: String,
				City: String,
				State: String,
				Zip: String,
				Latitiude: String,
				Longitude: String
			}
		}
	],
	ServiceType: String,
	TransportationTypeId: 0,
	TransportationType: String,
	LanguageId: 0,
	Language: String,
	LinkToReferral: String,
	ReferralNumber: 0,
	TransportRates: 
	{
		FlatFee: String,
		MileageFee: String,
		WaitRate: String,
		NoShowFee: String,
		Miles: 0,
		LoadFee: String
	},
	TranslationRates: 
	{
		HourlyRate: String,
		Hours: String,
		Miles: String,
		RatePerMile: String,
		CancellationRate: String,
		CancellationHours: String,
		NoShow: String
	}
}