Trendsic Platform Service

<back to all web services

AvailabilityUpsertRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
POST,OPTIONS/v1/Rfp/Availability
AvailabilityUpsertRequest Parameters:
NameParameterData TypeRequiredDescription
ResourceTypebodystringNo
LabelbodystringNo
EquipmentNamebodystringNo
RolesCsvbodystringNo
InternalRatebodydecimal?No
RentalRatebodydecimal?No
PremiumPerHourbodydecimal?No
AvailableFrombodyDateTime?No
FreedFromProjectLabelbodystringNo
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 .xml suffix or ?format=xml

HTTP + XML

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

POST /v1/Rfp/Availability HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AvailabilityUpsertRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AvailableFrom>0001-01-01T00:00:00</AvailableFrom>
  <EquipmentName>String</EquipmentName>
  <FreedFromProjectLabel>String</FreedFromProjectLabel>
  <InternalRate>0</InternalRate>
  <Label>String</Label>
  <PremiumPerHour>0</PremiumPerHour>
  <RentalRate>0</RentalRate>
  <ResourceType>String</ResourceType>
  <RolesCsv>String</RolesCsv>
</AvailabilityUpsertRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AvailabilityListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <CrewRoles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CrewRoles>
  <EquipmentNames xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </EquipmentNames>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Rows>
    <AvailabilityRowView>
      <AvailableFrom>0001-01-01T00:00:00</AvailableFrom>
      <EquipmentName>String</EquipmentName>
      <FreedFromProjectLabel>String</FreedFromProjectLabel>
      <InternalRate>0</InternalRate>
      <Label>String</Label>
      <PremiumPerHour>0</PremiumPerHour>
      <RentalRate>0</RentalRate>
      <ResourceAvailabilityID>0</ResourceAvailabilityID>
      <ResourceType>String</ResourceType>
      <RolesCsv>String</RolesCsv>
      <Source>String</Source>
    </AvailabilityRowView>
  </Rows>
  <Summary>
    <DeactivatedStale>0</DeactivatedStale>
    <Derived>0</Derived>
    <Notes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </Notes>
    <SkippedManualPrecedence>0</SkippedManualPrecedence>
    <SkippedNoDayRate>0</SkippedNoDayRate>
    <SkippedNoRentalSource>0</SkippedNoRentalSource>
  </Summary>
</AvailabilityListResponse>