POST apioauth/hirev2/onhirev2

Set equipment on hire

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
equipmentList	A list of equipment to be put on hire	Collection of OnHireV2EquipmentModel	None.

Request Formats

application/json, text/json

Sample:

{
  "equipmentList": [
    {
      "ecode": "sample string 1",
      "commCode": "sample string 2",
      "contractCode": "sample string 3",
      "customerCode": "sample string 4",
      "customerName": "sample string 5",
      "division": "sample string 6",
      "estimatedEndHireDate": "2025-04-27T16:27:29.8037156+00:00",
      "lolerCertificateName": "sample string 8",
      "lolerCertificateFile": "sample string 9",
      "trCertificateName": "sample string 10",
      "trCertificateFile": "sample string 11",
      "subGroupName": "sample string 12"
    },
    {
      "ecode": "sample string 1",
      "commCode": "sample string 2",
      "contractCode": "sample string 3",
      "customerCode": "sample string 4",
      "customerName": "sample string 5",
      "division": "sample string 6",
      "estimatedEndHireDate": "2025-04-27T16:27:29.8037156+00:00",
      "lolerCertificateName": "sample string 8",
      "lolerCertificateFile": "sample string 9",
      "trCertificateName": "sample string 10",
      "trCertificateFile": "sample string 11",
      "subGroupName": "sample string 12"
    }
  ]
}

application/xml, text/xml

Sample:

<OAuthOnHireV2Model xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <equipmentList>
    <OnHireV2EquipmentModel>
      <ecode>sample string 1</ecode>
      <commCode>sample string 2</commCode>
      <contractCode>sample string 3</contractCode>
      <customerCode>sample string 4</customerCode>
      <customerName>sample string 5</customerName>
      <division>sample string 6</division>
      <estimatedEndHireDate>2025-04-27T16:27:29.8037156+00:00</estimatedEndHireDate>
      <lolerCertificateName>sample string 8</lolerCertificateName>
      <lolerCertificateFile>sample string 9</lolerCertificateFile>
      <trCertificateName>sample string 10</trCertificateName>
      <trCertificateFile>sample string 11</trCertificateFile>
      <subGroupName>sample string 12</subGroupName>
    </OnHireV2EquipmentModel>
    <OnHireV2EquipmentModel>
      <ecode>sample string 1</ecode>
      <commCode>sample string 2</commCode>
      <contractCode>sample string 3</contractCode>
      <customerCode>sample string 4</customerCode>
      <customerName>sample string 5</customerName>
      <division>sample string 6</division>
      <estimatedEndHireDate>2025-04-27T16:27:29.8037156+00:00</estimatedEndHireDate>
      <lolerCertificateName>sample string 8</lolerCertificateName>
      <lolerCertificateFile>sample string 9</lolerCertificateFile>
      <trCertificateName>sample string 10</trCertificateName>
      <trCertificateFile>sample string 11</trCertificateFile>
      <subGroupName>sample string 12</subGroupName>
    </OnHireV2EquipmentModel>
  </equipmentList>
</OAuthOnHireV2Model>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A HireResponseModel indicating if the device was associated successfully

HireResponseModel

Name	Description	Type	Additional information
request_status	Status indicating if a web service call was successful	boolean	None.
request_message	Any extra information indicating why a call was not successful	string	None.

Response Formats

application/json, text/json

Sample:

{
  "request_status": true,
  "request_message": "sample string 2"
}

application/xml, text/xml

Sample:

<HireResponseModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <request_status>true</request_status>
  <request_message>sample string 2</request_message>
</HireResponseModel>