Documentation for GET api/Party/PartyOrders/display

GET api/Party/PartyOrders/display

Allows the user to retrieve information for a party Dashboard, including Orders and Payment. ///

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
PartyId		integer	None.
OrderId		integer	None.

Request Formats

application/xml, text/xml

Sample:

<PartyRequestVM>
  <PartyId>1</PartyId>
  <OrderId>1</OrderId>
</PartyRequestVM>

application/json, text/json

Sample:

{
  "PartyId": 1,
  "OrderId": 1
}

application/x-www-form-urlencoded

Sample:

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

Response Information

Resource Description

PartyDashboardViewModel

None.

Response Formats

application/xml, text/xml

Sample:

<PartyDashboardViewModel>
  <PartyDashboard>
    <PartyID>1</PartyID>
    <PartyDescription>sample string 2</PartyDescription>
    <PartyDate>07/18/2025 21:32:25</PartyDate>
    <PartyCloseDate>07/18/2025 21:32:25</PartyCloseDate>
    <PartyStatus>sample string 5</PartyStatus>
    <HostCustomerDID>sample string 6</HostCustomerDID>
    <HostFirstName>sample string 7</HostFirstName>
    <HostLastName>sample string 8</HostLastName>
    <IsHostRep>True</IsHostRep>
    <IsVoided>True</IsVoided>
    <IsClosed>True</IsClosed>
    <Orders>
      <OrderVM>
        <OrderID>1</OrderID>
        <RepDID>sample string 2</RepDID>
        <RepFirstName>sample string 3</RepFirstName>
        <RepLastName>sample string 4</RepLastName>
        <CustomerDID>sample string 5</CustomerDID>
        <CustomerFirstName>sample string 6</CustomerFirstName>
        <CustomerLastName>sample string 7</CustomerLastName>
        <OrderStatus>sample string 8</OrderStatus>
        <OrderTotal>9</OrderTotal>
        <PaymentTotal>10</PaymentTotal>
        <BalanceDue>11</BalanceDue>
        <CurrencyTypeID>1</CurrencyTypeID>
        <BillingAddress>
          <Name1>sample string 1</Name1>
          <Name2>sample string 2</Name2>
          <Street1>sample string 3</Street1>
          <Street2>sample string 4</Street2>
          <City>sample string 5</City>
          <State>sample string 6</State>
          <PostalCode>sample string 7</PostalCode>
          <County>sample string 8</County>
          <Country>sample string 9</Country>
          <Phone>sample string 10</Phone>
          <Email>sample string 11</Email>
        </BillingAddress>
        <ShippingAddress>
          <Name1>sample string 1</Name1>
          <Name2>sample string 2</Name2>
          <Street1>sample string 3</Street1>
          <Street2>sample string 4</Street2>
          <City>sample string 5</City>
          <State>sample string 6</State>
          <PostalCode>sample string 7</PostalCode>
          <County>sample string 8</County>
          <Country>sample string 9</Country>
          <Phone>sample string 10</Phone>
          <Email>sample string 11</Email>
        </ShippingAddress>
        <LineItemDetails />
        <Payments>
          <PaymentVM>
            <PaymentId>1</PaymentId>
            <PaymentTypeId>2</PaymentTypeId>
            <PaymentType>sample string 3</PaymentType>
            <PaymentDate>07/18/2025 21:32:25</PaymentDate>
            <Amount>5</Amount>
          </PaymentVM>
          <PaymentVM>
            <PaymentId>1</PaymentId>
            <PaymentTypeId>2</PaymentTypeId>
            <PaymentType>sample string 3</PaymentType>
            <PaymentDate>07/18/2025 21:32:25</PaymentDate>
            <Amount>5</Amount>
          </PaymentVM>
        </Payments>
        <OrderGiftMessage>
          <OrdersGiftMessageViewModel>
            <Message>sample string 1</Message>
            <ID>2</ID>
            <OrderID>1</OrderID>
            <OnlineOrderID>1</OnlineOrderID>
            <Sequence>3</Sequence>
          </OrdersGiftMessageViewModel>
          <OrdersGiftMessageViewModel>
            <Message>sample string 1</Message>
            <ID>2</ID>
            <OrderID>1</OrderID>
            <OnlineOrderID>1</OnlineOrderID>
            <Sequence>3</Sequence>
          </OrdersGiftMessageViewModel>
        </OrderGiftMessage>
      </OrderVM>
      <OrderVM>
        <OrderID>1</OrderID>
        <RepDID>sample string 2</RepDID>
        <RepFirstName>sample string 3</RepFirstName>
        <RepLastName>sample string 4</RepLastName>
        <CustomerDID>sample string 5</CustomerDID>
        <CustomerFirstName>sample string 6</CustomerFirstName>
        <CustomerLastName>sample string 7</CustomerLastName>
        <OrderStatus>sample string 8</OrderStatus>
        <OrderTotal>9</OrderTotal>
        <PaymentTotal>10</PaymentTotal>
        <BalanceDue>11</BalanceDue>
        <CurrencyTypeID>1</CurrencyTypeID>
        <BillingAddress>
          <Name1>sample string 1</Name1>
          <Name2>sample string 2</Name2>
          <Street1>sample string 3</Street1>
          <Street2>sample string 4</Street2>
          <City>sample string 5</City>
          <State>sample string 6</State>
          <PostalCode>sample string 7</PostalCode>
          <County>sample string 8</County>
          <Country>sample string 9</Country>
          <Phone>sample string 10</Phone>
          <Email>sample string 11</Email>
        </BillingAddress>
        <ShippingAddress>
          <Name1>sample string 1</Name1>
          <Name2>sample string 2</Name2>
          <Street1>sample string 3</Street1>
          <Street2>sample string 4</Street2>
          <City>sample string 5</City>
          <State>sample string 6</State>
          <PostalCode>sample string 7</PostalCode>
          <County>sample string 8</County>
          <Country>sample string 9</Country>
          <Phone>sample string 10</Phone>
          <Email>sample string 11</Email>
        </ShippingAddress>
        <LineItemDetails />
        <Payments>
          <PaymentVM>
            <PaymentId>1</PaymentId>
            <PaymentTypeId>2</PaymentTypeId>
            <PaymentType>sample string 3</PaymentType>
            <PaymentDate>07/18/2025 21:32:25</PaymentDate>
            <Amount>5</Amount>
          </PaymentVM>
          <PaymentVM>
            <PaymentId>1</PaymentId>
            <PaymentTypeId>2</PaymentTypeId>
            <PaymentType>sample string 3</PaymentType>
            <PaymentDate>07/18/2025 21:32:25</PaymentDate>
            <Amount>5</Amount>
          </PaymentVM>
        </Payments>
        <OrderGiftMessage>
          <OrdersGiftMessageViewModel>
            <Message>sample string 1</Message>
            <ID>2</ID>
            <OrderID>1</OrderID>
            <OnlineOrderID>1</OnlineOrderID>
            <Sequence>3</Sequence>
          </OrdersGiftMessageViewModel>
          <OrdersGiftMessageViewModel>
            <Message>sample string 1</Message>
            <ID>2</ID>
            <OrderID>1</OrderID>
            <OnlineOrderID>1</OnlineOrderID>
            <Sequence>3</Sequence>
          </OrdersGiftMessageViewModel>
        </OrderGiftMessage>
      </OrderVM>
    </Orders>
  </PartyDashboard>
</PartyDashboardViewModel>

application/json, text/json

Sample:

{}