GET api/PartyType/{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
IPartyType| Name | Description | Type | Additional information |
|---|---|---|---|
| ID | integer |
None. |
|
| Description | string |
None. |
|
| IsActive | boolean |
None. |
|
| ShouldDisplayHostessName | boolean |
None. |
|
| ShouldHideRepName | boolean |
None. |
|
| ShouldDisplayPartyDate | boolean |
None. |
|
| ShouldDisplayPartyInfo | boolean |
None. |
|
| ShouldAllowCustomersToPlaceOrdersUnderOtherRep | byte |
None. |
|
| ShouldAllowShoppingCartOrders | boolean |
None. |
|
| ShouldPartyPersist | boolean |
None. |
|
| PartyTerm | string |
None. |
|
| PartyTerm_Plural | string |
None. |
|
| BookingTerm | string |
None. |
|
| BookingTerm_Plural | string |
None. |
|
| GuestTerm | string |
None. |
|
| GuestTerm_Plural | string |
None. |
|
| HostessTerm | string |
None. |
|
| HostessTerm_Plural | string |
None. |
|
| IsDefault | boolean |
None. |
|
| DirectShipRep | boolean |
None. |
|
| DirectShipHostess | boolean |
None. |
|
| DirectShipGuest | boolean |
None. |
|
| DefaultPartyFormatID | integer |
None. |
|
| IsPartyFormatHiddenInUI | boolean |
None. |
|
| MaxNumberOfDaysOutForNewPartyDate | integer |
None. |
|
| NumberOfDaysShowCanBeMoved | integer |
None. |
|
| AutoClose | boolean |
None. |
|
| DaysToAutoClose | integer |
None. |
Response Formats
application/xml, text/xml
Sample:
<PartyType> <ID>0</ID> <Description /> <IsActive>False</IsActive> <ShouldDisplayHostessName>False</ShouldDisplayHostessName> <ShouldHideRepName>False</ShouldHideRepName> <ShouldDisplayPartyDate>False</ShouldDisplayPartyDate> <ShouldDisplayPartyInfo>False</ShouldDisplayPartyInfo> <ShouldAllowCustomersToPlaceOrdersUnderOtherRep /> <ShouldAllowShoppingCartOrders>False</ShouldAllowShoppingCartOrders> <ShouldPartyPersist>False</ShouldPartyPersist> <PartyTerm /> <PartyTerm_Plural /> <BookingTerm /> <BookingTerm_Plural /> <GuestTerm /> <GuestTerm_Plural /> <HostessTerm /> <HostessTerm_Plural /> <IsDefault>False</IsDefault> <DirectShipRep>False</DirectShipRep> <DirectShipHostess>False</DirectShipHostess> <DirectShipGuest>False</DirectShipGuest> <DefaultPartyFormatID>0</DefaultPartyFormatID> <IsPartyFormatHiddenInUI>False</IsPartyFormatHiddenInUI> <MaxNumberOfDaysOutForNewPartyDate>0</MaxNumberOfDaysOutForNewPartyDate> <NumberOfDaysShowCanBeMoved>0</NumberOfDaysShowCanBeMoved> <AutoClose>False</AutoClose> <DaysToAutoClose /> </PartyType>
application/json, text/json
Sample:
{
"ID": 0,
"IsActive": false,
"ShouldDisplayHostessName": false,
"ShouldHideRepName": false,
"ShouldDisplayPartyDate": false,
"ShouldDisplayPartyInfo": false,
"ShouldAllowShoppingCartOrders": false,
"ShouldPartyPersist": false,
"IsDefault": false,
"DirectShipRep": false,
"DirectShipHostess": false,
"DirectShipGuest": false,
"DefaultPartyFormatID": 0,
"IsPartyFormatHiddenInUI": false,
"MaxNumberOfDaysOutForNewPartyDate": 0,
"NumberOfDaysShowCanBeMoved": 0
}