GET api/Party/Party/{id}

Method to return a specific Party provided the ID.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

Body Parameters

None.

Response Information

Resource Description

PartyResponseViewModel
NameDescriptionTypeAdditional information
ID

integer

None.

BCKey

integer

None.

HostCustomerID

integer

None.

HostCustomerDID

string

None.

PartyTypeID

integer

None.

DistributionTypeID

integer

None.

IsAvailableInCart

boolean

None.

EndDateTime

string

None.

Format

string

None.

Location

string

None.

EventURL

string

None.

ShippingType

string

None.

BillingType

string

None.

Description

string

None.

PartyInfo

string

None.

PartyStatusID

integer

None.

PartyDate

string

None.

PartyStartTime

string

None.

PartyEndTime

string

None.

BillName

string

None.

BillStreet1

string

None.

BillStreet2

string

None.

BillCity

string

None.

BillState

string

None.

BillPostalCode

string

None.

BillCounty

string

None.

BillCountry

string

None.

ShipName

string

None.

ShipStreet1

string

None.

ShipStreet2

string

None.

ShipCity

string

None.

ShipState

string

None.

ShipPostalCode

string

None.

ShipCounty

string

None.

ShipCountry

string

None.

Phone1

string

None.

Phone2

string

None.

Email

string

None.

Directions

string

None.

PartyCloseDateTime

string

None.

RetainedEarningsEarned

decimal number

None.

REBonusPeriodID

integer

None.

REBonusPaidAmount

decimal number

None.

REBonusPaidDate

string

None.

DataRepairNotes

string

None.

DateFinalBooking

string

None.

DateVoided

string

None.

PartyGUID

globally unique identifier

None.

InternalNote

string

None.

ShoppingShortenURL

string

None.

OriginalPartyDate

string

None.

IsMySelfHost

boolean

None.

MiscFields

Dictionary of string [key] and Object [value]

None.

DateCreated

string

None.

CreatedBy

string

None.

DateLastModified

string

None.

LastModifiedBy

string

None.

Response Formats

application/xml, text/xml

Sample:
<PartyResponseViewModel>
  <ID>1</ID>
  <BCKey>1</BCKey>
  <HostCustomerID>1</HostCustomerID>
  <HostCustomerDID>sample string 2</HostCustomerDID>
  <PartyTypeID>3</PartyTypeID>
  <DistributionTypeID>1</DistributionTypeID>
  <IsAvailableInCart>True</IsAvailableInCart>
  <EndDateTime>sample string 5</EndDateTime>
  <Format>sample string 6</Format>
  <Location>sample string 7</Location>
  <EventURL>sample string 8</EventURL>
  <ShippingType>sample string 9</ShippingType>
  <BillingType>sample string 10</BillingType>
  <Description>sample string 11</Description>
  <PartyInfo>sample string 12</PartyInfo>
  <PartyStatusID>13</PartyStatusID>
  <PartyDate>sample string 14</PartyDate>
  <PartyStartTime>sample string 15</PartyStartTime>
  <PartyEndTime>sample string 16</PartyEndTime>
  <BillName>sample string 17</BillName>
  <BillStreet1>sample string 18</BillStreet1>
  <BillStreet2>sample string 19</BillStreet2>
  <BillCity>sample string 20</BillCity>
  <BillState>sample string 21</BillState>
  <BillPostalCode>sample string 22</BillPostalCode>
  <BillCounty>sample string 23</BillCounty>
  <BillCountry>sample string 24</BillCountry>
  <ShipName>sample string 25</ShipName>
  <ShipStreet1>sample string 26</ShipStreet1>
  <ShipStreet2>sample string 27</ShipStreet2>
  <ShipCity>sample string 28</ShipCity>
  <ShipState>sample string 29</ShipState>
  <ShipPostalCode>sample string 30</ShipPostalCode>
  <ShipCounty>sample string 31</ShipCounty>
  <ShipCountry>sample string 32</ShipCountry>
  <Phone1>sample string 33</Phone1>
  <Phone2>sample string 34</Phone2>
  <Email>sample string 35</Email>
  <Directions>sample string 36</Directions>
  <PartyCloseDateTime>sample string 37</PartyCloseDateTime>
  <RetainedEarningsEarned>1</RetainedEarningsEarned>
  <REBonusPeriodID>1</REBonusPeriodID>
  <REBonusPaidAmount>1</REBonusPaidAmount>
  <REBonusPaidDate>sample string 38</REBonusPaidDate>
  <DataRepairNotes>sample string 39</DataRepairNotes>
  <DateFinalBooking>sample string 40</DateFinalBooking>
  <DateVoided>sample string 41</DateVoided>
  <PartyGUID>a098ed07-0835-4276-858e-d8f004d49690</PartyGUID>
  <InternalNote>sample string 43</InternalNote>
  <ShoppingShortenURL>sample string 44</ShoppingShortenURL>
  <OriginalPartyDate>sample string 45</OriginalPartyDate>
  <IsMySelfHost>True</IsMySelfHost>
  <MiscFields>
    <KeyValuePairOfStringObject>
      <Key>sample string 1</Key>
      <Value />
    </KeyValuePairOfStringObject>
    <KeyValuePairOfStringObject>
      <Key>sample string 3</Key>
      <Value />
    </KeyValuePairOfStringObject>
  </MiscFields>
  <DateCreated>sample string 47</DateCreated>
  <CreatedBy>sample string 48</CreatedBy>
  <DateLastModified>sample string 49</DateLastModified>
  <LastModifiedBy>sample string 50</LastModifiedBy>
</PartyResponseViewModel>

application/json, text/json

Sample:
{
  "ID": 1,
  "BCKey": 1,
  "HostCustomerID": 1,
  "HostCustomerDID": "sample string 2",
  "PartyTypeID": 3,
  "DistributionTypeID": 1,
  "IsAvailableInCart": true,
  "EndDateTime": "sample string 5",
  "Format": "sample string 6",
  "Location": "sample string 7",
  "EventURL": "sample string 8",
  "ShippingType": "sample string 9",
  "BillingType": "sample string 10",
  "Description": "sample string 11",
  "PartyInfo": "sample string 12",
  "PartyStatusID": 13,
  "PartyDate": "sample string 14",
  "PartyStartTime": "sample string 15",
  "PartyEndTime": "sample string 16",
  "BillName": "sample string 17",
  "BillStreet1": "sample string 18",
  "BillStreet2": "sample string 19",
  "BillCity": "sample string 20",
  "BillState": "sample string 21",
  "BillPostalCode": "sample string 22",
  "BillCounty": "sample string 23",
  "BillCountry": "sample string 24",
  "ShipName": "sample string 25",
  "ShipStreet1": "sample string 26",
  "ShipStreet2": "sample string 27",
  "ShipCity": "sample string 28",
  "ShipState": "sample string 29",
  "ShipPostalCode": "sample string 30",
  "ShipCounty": "sample string 31",
  "ShipCountry": "sample string 32",
  "Phone1": "sample string 33",
  "Phone2": "sample string 34",
  "Email": "sample string 35",
  "Directions": "sample string 36",
  "PartyCloseDateTime": "sample string 37",
  "RetainedEarningsEarned": 1.0,
  "REBonusPeriodID": 1,
  "REBonusPaidAmount": 1.0,
  "REBonusPaidDate": "sample string 38",
  "DataRepairNotes": "sample string 39",
  "DateFinalBooking": "sample string 40",
  "DateVoided": "sample string 41",
  "PartyGUID": "a098ed07-0835-4276-858e-d8f004d49690",
  "InternalNote": "sample string 43",
  "ShoppingShortenURL": "sample string 44",
  "OriginalPartyDate": "sample string 45",
  "IsMySelfHost": true,
  "MiscFields": {
    "sample string 1": {},
    "sample string 3": {}
  },
  "DateCreated": "sample string 47",
  "CreatedBy": "sample string 48",
  "DateLastModified": "sample string 49",
  "LastModifiedBy": "sample string 50"
}