GET api/Party/PartyOrders/display?partyId={partyId}&orderId={orderId}
Allows the user to retrieve information for a party Dashboard, including Orders and Payment. ///
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| partyId | integer |
Required |
|
| orderId | integer |
Default value is 0 |
Body Parameters
None.
Response Information
Resource Description
PartyDashboardViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| partyDashboard |
None. |
Response Formats
application/xml, text/xml
Sample:
<PartyDashboardViewModel>
<PartyDashboard>
<PartyID>1</PartyID>
<PartyDescription>sample string 2</PartyDescription>
<PartyDate>03/31/2026 04:46:58</PartyDate>
<PartyCloseDate>03/31/2026 04:46:58</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>03/31/2026 04:46:58</PaymentDate>
<Amount>5</Amount>
</PaymentVM>
<PaymentVM>
<PaymentId>1</PaymentId>
<PaymentTypeId>2</PaymentTypeId>
<PaymentType>sample string 3</PaymentType>
<PaymentDate>03/31/2026 04:46:58</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>03/31/2026 04:46:58</PaymentDate>
<Amount>5</Amount>
</PaymentVM>
<PaymentVM>
<PaymentId>1</PaymentId>
<PaymentTypeId>2</PaymentTypeId>
<PaymentType>sample string 3</PaymentType>
<PaymentDate>03/31/2026 04:46:58</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:
{
"partyDashboard": {
"partyID": 1,
"partyDescription": "sample string 2",
"partyDate": "2026-03-31T04:46:58.3425566-04:00",
"partyCloseDate": "2026-03-31T04:46:58.3425566-04:00",
"partyStatus": "sample string 5",
"hostCustomerDID": "sample string 6",
"hostFirstName": "sample string 7",
"hostLastName": "sample string 8",
"isHostRep": true,
"isVoided": true,
"isClosed": true,
"orders": [
{
"orderID": 1,
"repDID": "sample string 2",
"repFirstName": "sample string 3",
"repLastName": "sample string 4",
"customerDID": "sample string 5",
"customerFirstName": "sample string 6",
"customerLastName": "sample string 7",
"orderStatus": "sample string 8",
"orderTotal": 9.0,
"paymentTotal": 10.0,
"balanceDue": 11.0,
"currencyTypeID": 1,
"billingAddress": {
"name1": "sample string 1",
"name2": "sample string 2",
"street1": "sample string 3",
"street2": "sample string 4",
"city": "sample string 5",
"state": "sample string 6",
"postalCode": "sample string 7",
"county": "sample string 8",
"country": "sample string 9",
"phone": "sample string 10",
"email": "sample string 11"
},
"shippingAddress": {
"name1": "sample string 1",
"name2": "sample string 2",
"street1": "sample string 3",
"street2": "sample string 4",
"city": "sample string 5",
"state": "sample string 6",
"postalCode": "sample string 7",
"county": "sample string 8",
"country": "sample string 9",
"phone": "sample string 10",
"email": "sample string 11"
},
"payments": [
{
"paymentId": 1,
"paymentTypeId": 2,
"paymentType": "sample string 3",
"paymentDate": "2026-03-31T04:46:58.3425566-04:00",
"amount": 5.0
},
{
"paymentId": 1,
"paymentTypeId": 2,
"paymentType": "sample string 3",
"paymentDate": "2026-03-31T04:46:58.3425566-04:00",
"amount": 5.0
}
],
"orderGiftMessage": [
{
"Message": "sample string 1",
"ID": 2,
"OrderID": 1,
"OnlineOrderID": 1,
"Sequence": 3
},
{
"Message": "sample string 1",
"ID": 2,
"OrderID": 1,
"OnlineOrderID": 1,
"Sequence": 3
}
]
},
{
"orderID": 1,
"repDID": "sample string 2",
"repFirstName": "sample string 3",
"repLastName": "sample string 4",
"customerDID": "sample string 5",
"customerFirstName": "sample string 6",
"customerLastName": "sample string 7",
"orderStatus": "sample string 8",
"orderTotal": 9.0,
"paymentTotal": 10.0,
"balanceDue": 11.0,
"currencyTypeID": 1,
"billingAddress": {
"name1": "sample string 1",
"name2": "sample string 2",
"street1": "sample string 3",
"street2": "sample string 4",
"city": "sample string 5",
"state": "sample string 6",
"postalCode": "sample string 7",
"county": "sample string 8",
"country": "sample string 9",
"phone": "sample string 10",
"email": "sample string 11"
},
"shippingAddress": {
"name1": "sample string 1",
"name2": "sample string 2",
"street1": "sample string 3",
"street2": "sample string 4",
"city": "sample string 5",
"state": "sample string 6",
"postalCode": "sample string 7",
"county": "sample string 8",
"country": "sample string 9",
"phone": "sample string 10",
"email": "sample string 11"
},
"payments": [
{
"paymentId": 1,
"paymentTypeId": 2,
"paymentType": "sample string 3",
"paymentDate": "2026-03-31T04:46:58.3425566-04:00",
"amount": 5.0
},
{
"paymentId": 1,
"paymentTypeId": 2,
"paymentType": "sample string 3",
"paymentDate": "2026-03-31T04:46:58.3425566-04:00",
"amount": 5.0
}
],
"orderGiftMessage": [
{
"Message": "sample string 1",
"ID": 2,
"OrderID": 1,
"OnlineOrderID": 1,
"Sequence": 3
},
{
"Message": "sample string 1",
"ID": 2,
"OrderID": 1,
"OnlineOrderID": 1,
"Sequence": 3
}
]
}
]
}
}