Documentation for GET api/Party/Party/{id}

GET api/Party/Party/{id}

Method to return a specific Party provided the ID.

Request Information

URI Parameters

Name	Description	Type	Additional information
id		integer	Required

Body Parameters

None.

Response Information

Resource Description

IParty

Name	Type	Additional information
ID	integer	None.
BCKey	integer	None.
HostCustomerID	integer	None.
PartyDate	date	None.
PartyInfo	string	None.
PartyTypeID	integer	None.
PartyCloseDateTime	date	None.
PartyStartTime	string	None.
PartyEndTime	string	None.
BillName	string	None.
BillStreet1	string	None.
BillStreet2	string	None.
BillCity	string	None.
BillCounty	string	None.
BillState	string	None.
BillPostalCode	string	None.
BillCountry	string	None.
ShipName	string	None.
ShipStreet1	string	None.
ShipStreet2	string	None.
ShipCity	string	None.
ShipCounty	string	None.
ShipState	string	None.
ShipPostalCode	string	None.
ShipCountry	string	None.
Phone1	string	None.
Phone2	string	None.
Email	string	None.
Directions	string	None.
DistributionTypeID	integer	None.
RetainedEarningsEarned	decimal number	None.
REBonusPeriodID	integer	None.
REBonusPaidAmount	decimal number	None.
REBonusPaidDate	date	None.
DataRepairNotes	string	None.
PartyStatusID	integer	None.
DateFinalBooking	date	None.
DateVoided	date	None.
PartyGUID	globally unique identifier	None.
Format	string	None.
Location	string	None.
IsAvailableInCart	boolean	None.
ShippingType	string	None.
BillingType	string	None.
EventURL	string	None.
EndDateTime	date	None.
InternalNote	string	None.
ShoppingShortenURL	string	None.
OriginalPartyDate	date	None.

Response Formats

application/xml, text/xml

Sample:

<Party>
  <ID>0</ID>
  <BCKey>0</BCKey>
  <HostCustomerID />
  <PartyInfo />
  <PartyTypeID>1</PartyTypeID>
  <PartyStatusID>-1</PartyStatusID>
  <DistributionTypeID />
  <PartyDate>01/01/0001 00:00:00</PartyDate>
  <PartyStartTime />
  <PartyEndTime />
  <BillName />
  <BillStreet1 />
  <BillStreet2 />
  <BillCity />
  <BillCounty />
  <BillState />
  <BillPostalCode />
  <BillCountry />
  <ShipName />
  <ShipStreet1 />
  <ShipStreet2 />
  <ShipCity />
  <ShipCounty />
  <ShipState />
  <ShipPostalCode />
  <ShipCountry />
  <Phone1 />
  <Phone2 />
  <Email />
  <Directions />
  <PartyCloseDateTime />
  <RetainedEarningsEarned />
  <REBonusPeriodID />
  <REBonusPaidAmount />
  <REBonusPaidDate />
  <DataRepairNotes />
  <DateFinalBooking />
  <DateVoided />
  <PartyGUID>00000000-0000-0000-0000-000000000000</PartyGUID>
  <Format />
  <Location />
  <IsAvailableInCart>False</IsAvailableInCart>
  <ShippingType />
  <BillingType />
  <EventURL />
  <EndDateTime />
  <InternalNote />
  <ShoppingShortenURL />
  <OriginalPartyDate />
  <CreatedBy />
  <DateCreated>01/01/0001 00:00:00</DateCreated>
  <LastModifiedBy />
  <DateLastModified />
</Party>

application/json, text/json

Sample:

{
  "ID": 0,
  "BCKey": 0,
  "PartyTypeID": 1,
  "PartyStatusID": -1,
  "PartyDate": "0001-01-01T00:00:00",
  "PartyGUID": "00000000-0000-0000-0000-000000000000",
  "IsAvailableInCart": false,
  "DateCreated": "0001-01-01T00:00:00"
}