Trendsic Platform Service

<back to all web services

AvailabilityListRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/Rfp/Availability
AvailabilityListResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
RowsformList<AvailabilityRowView>No
EquipmentNamesformList<string>No
CrewRolesformList<string>No
SummaryformAvailabilityRefreshSummaryNo
AvailabilityRowView Parameters:
NameParameterData TypeRequiredDescription
ResourceAvailabilityIDformintNo
ResourceTypeformstringNo
LabelformstringNo
EquipmentNameformstringNo
RolesCsvformstringNo
InternalRateformdecimal?No
RentalRateformdecimal?No
PremiumPerHourformdecimal?No
AvailableFromformDateTimeNo
FreedFromProjectLabelformstringNo
SourceformstringNo
AvailabilityRefreshSummary Parameters:
NameParameterData TypeRequiredDescription
DerivedformintNo
DeactivatedStaleformintNo
SkippedManualPrecedenceformintNo
SkippedNoRentalSourceformintNo
SkippedNoDayRateformintNo
NotesformList<string>No

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 /v1/Rfp/Availability HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Rows: 
	[
		{
			ResourceAvailabilityID: 0,
			ResourceType: String,
			Label: String,
			EquipmentName: String,
			RolesCsv: String,
			InternalRate: 0,
			RentalRate: 0,
			PremiumPerHour: 0,
			AvailableFrom: 0001-01-01,
			FreedFromProjectLabel: String,
			Source: String
		}
	],
	EquipmentNames: 
	[
		String
	],
	CrewRoles: 
	[
		String
	],
	Summary: 
	{
		Derived: 0,
		DeactivatedStale: 0,
		SkippedManualPrecedence: 0,
		SkippedNoRentalSource: 0,
		SkippedNoDayRate: 0,
		Notes: 
		[
			String
		]
	}
}