PUT Booking/PutBooking

Updates a Booking

Request Information

URI Parameters

Body Parameters

The Booking object used to update a Booking.

Name	Description	Type	Additional Information
NewBookDate	The updated date of the booking. Only updated if a value is provided	string	Data type: DateTime Format must be MM/dd/yyyy
SalespersonId	The Agvance salesperson for the booking. Only updated if a value is provided	string	Max length: 15
Comments	Comments. Only updated if a value is provided	string	Max length: 80
AdditionalComments	Additional comments on the booking	string	Max length: 240
ClearAdditionalComments	Set to true to clear additional comments	boolean
Term	Payment term assigned to the booking - "(None)" removes the current term from the booking	string	Max length: 15
VoidedTF	Value set to void the booking	boolean	Must be 0, 1, True, or False
ExpireDate	Date the booking will expire	string	Data type: DateTime Format must be MM/dd/yyyy
StartDate	Date the booking will be available	string	Data type: DateTime Format must be MM/dd/yyyy
BookGuid	Global Unique Identifier for the booking	globally unique identifier	Required Do not modify existing value.
ContractFormat	The format of the booking contract assigned to this transaction. Will only update if populated	string	Max length: 40
AgvanceUserIdToAssignSellerSignatureFrom	Agvance user ID to assign to the seller signature	string
SellerSignatureDateSignedToPrint	Date the sellers signature was applied to the contract (only if the signature is valid)	date
SellerSignatureDateTimeSignedUtc	Date and time the sellers signature was captured in UTC (only if the signature is valid)	date
BookSplitUpdate	Details of what may be updated on the booking split	Collection of ClsBookSplitUpdate

Request Formats

application/json, text/json

Sample:

{
  "NewBookDate": "sample string 1",
  "SalespersonId": "sample string 2",
  "Comments": "sample string 3",
  "AdditionalComments": "sample string 4",
  "ClearAdditionalComments": true,
  "Term": "sample string 6",
  "VoidedTF": true,
  "ExpireDate": "sample string 8",
  "StartDate": "sample string 9",
  "BookGuid": "a289e1a5-a10c-4d66-aa6a-08047077d3a6",
  "ContractFormat": "sample string 10",
  "AgvanceUserIdToAssignSellerSignatureFrom": "sample string 11",
  "SellerSignatureDateSignedToPrint": "2025-05-15T14:08:39.3181651+00:00",
  "SellerSignatureDateTimeSignedUtc": "2025-05-15T14:08:39.3181651+00:00",
  "BookSplitUpdate": [
    {
      "BookDetailUpdate": [
        {
          "DepartmentId": "sample string 3",
          "ProductId": "sample string 4",
          "UnitPrice": 5.1,
          "Quantity": 6.1,
          "UniqueKey": 7,
          "DeletedYN": true
        },
        {
          "DepartmentId": "sample string 3",
          "ProductId": "sample string 4",
          "UnitPrice": 5.1,
          "Quantity": 6.1,
          "UniqueKey": 7,
          "DeletedYN": true
        }
      ]
    },
    {
      "BookDetailUpdate": [
        {
          "DepartmentId": "sample string 3",
          "ProductId": "sample string 4",
          "UnitPrice": 5.1,
          "Quantity": 6.1,
          "UniqueKey": 7,
          "DeletedYN": true
        },
        {
          "DepartmentId": "sample string 3",
          "ProductId": "sample string 4",
          "UnitPrice": 5.1,
          "Quantity": 6.1,
          "UniqueKey": 7,
          "DeletedYN": true
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<BookUpdate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSI.AR">
  <AdditionalComments>sample string 4</AdditionalComments>
  <AgvanceUserIdToAssignSellerSignatureFrom>sample string 11</AgvanceUserIdToAssignSellerSignatureFrom>
  <BookGuid>a289e1a5-a10c-4d66-aa6a-08047077d3a6</BookGuid>
  <BookSplitUpdate>
    <ClsBookAPI.ClsBookUpdate.ClsBookSplitUpdate>
      <BookDetailUpdate>
        <ClsBookAPI.ClsBookUpdate.ClsBookSplitUpdate.ClsBookLIUpdate>
          <DeletedYN>true</DeletedYN>
          <DepartmentId>sample string 3</DepartmentId>
          <ProductId>sample string 4</ProductId>
          <Quantity>6.1</Quantity>
          <UniqueKey>7</UniqueKey>
          <UnitPrice>5.1</UnitPrice>
        </ClsBookAPI.ClsBookUpdate.ClsBookSplitUpdate.ClsBookLIUpdate>
        <ClsBookAPI.ClsBookUpdate.ClsBookSplitUpdate.ClsBookLIUpdate>
          <DeletedYN>true</DeletedYN>
          <DepartmentId>sample string 3</DepartmentId>
          <ProductId>sample string 4</ProductId>
          <Quantity>6.1</Quantity>
          <UniqueKey>7</UniqueKey>
          <UnitPrice>5.1</UnitPrice>
        </ClsBookAPI.ClsBookUpdate.ClsBookSplitUpdate.ClsBookLIUpdate>
      </BookDetailUpdate>
    </ClsBookAPI.ClsBookUpdate.ClsBookSplitUpdate>
    <ClsBookAPI.ClsBookUpdate.ClsBookSplitUpdate>
      <BookDetailUpdate>
        <ClsBookAPI.ClsBookUpdate.ClsBookSplitUpdate.ClsBookLIUpdate>
          <DeletedYN>true</DeletedYN>
          <DepartmentId>sample string 3</DepartmentId>
          <ProductId>sample string 4</ProductId>
          <Quantity>6.1</Quantity>
          <UniqueKey>7</UniqueKey>
          <UnitPrice>5.1</UnitPrice>
        </ClsBookAPI.ClsBookUpdate.ClsBookSplitUpdate.ClsBookLIUpdate>
        <ClsBookAPI.ClsBookUpdate.ClsBookSplitUpdate.ClsBookLIUpdate>
          <DeletedYN>true</DeletedYN>
          <DepartmentId>sample string 3</DepartmentId>
          <ProductId>sample string 4</ProductId>
          <Quantity>6.1</Quantity>
          <UniqueKey>7</UniqueKey>
          <UnitPrice>5.1</UnitPrice>
        </ClsBookAPI.ClsBookUpdate.ClsBookSplitUpdate.ClsBookLIUpdate>
      </BookDetailUpdate>
    </ClsBookAPI.ClsBookUpdate.ClsBookSplitUpdate>
  </BookSplitUpdate>
  <ClearAdditionalComments>true</ClearAdditionalComments>
  <Comments>sample string 3</Comments>
  <ContractFormat>sample string 10</ContractFormat>
  <ExpireDate>sample string 8</ExpireDate>
  <NewBookDate>sample string 1</NewBookDate>
  <SalespersonId>sample string 2</SalespersonId>
  <SellerSignatureDateSignedToPrint>2025-05-15T14:08:39.3181651+00:00</SellerSignatureDateSignedToPrint>
  <SellerSignatureDateTimeSignedUtc>2025-05-15T14:08:39.3181651+00:00</SellerSignatureDateTimeSignedUtc>
  <StartDate>sample string 9</StartDate>
  <Term>sample string 6</Term>
  <VoidedTF>true</VoidedTF>
</BookUpdate>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ClsBookUpdate'.

Response Information

Resource Description

Updates a Booking

AgvBooking

Name	Description	Type
Status	Status of the API call.	string
Message	Message of the API call.	string
ErrorList	List of error messages of the API call.	Collection of string
Count	Count of how many Bookings.	string
BookingRecords	JSON dictionary of BookRecords.	Collection of clsAPIBook

Response Formats

application/json, text/json

Sample:

{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "ErrorList": [
    "sample string 1",
    "sample string 2"
  ],
  "Count": "2",
  "BookingRecords": [
    {
      "BookDate": "sample string 1",
      "BookLocation": "sample string 2",
      "BookNumber": "sample string 3",
      "BookGuid": "9e6fa204-0dec-4c88-b2a1-d5b06a02bb17",
      "BookingRecordHeaderDetails": null,
      "BookingRecordSplitDetails": [],
      "BookingRecordLineItemDetails": [],
      "BookingRecordAnalysisDetails": []
    },
    {
      "BookDate": "sample string 1",
      "BookLocation": "sample string 2",
      "BookNumber": "sample string 3",
      "BookGuid": "9e6fa204-0dec-4c88-b2a1-d5b06a02bb17",
      "BookingRecordHeaderDetails": null,
      "BookingRecordSplitDetails": [],
      "BookingRecordLineItemDetails": [],
      "BookingRecordAnalysisDetails": []
    }
  ]
}

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Cannot serialize the DataTable. DataTable name is not set.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Cannot serialize the DataTable. DataTable name is not set.