GET api/Destinations

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of Destination

Name	Type	Additional information
AuthorizationID	string	Required String length: inclusive between 0 and 50
TypeofDestination	string	String length: inclusive between 0 and 50
RInitiationDate	date	None.
BInitiationDate	date	None.
RCancelDate	date	None.
BCancelDate	date	None.
ROnHold	integer	None.
BOnHold	integer	None.
CInitiationDate	date	None.
BLowerPrice	decimal number	None.
RUpperPrice	decimal number	None.
RLowerPrice	decimal number	None.
BUpperPrice	decimal number	None.
RBedrooms	integer	None.
RBathrooms	integer	None.
RSchoolInfo	string	String length: inclusive between 0 and 5
BBedrooms	integer	None.
BBathrooms	integer	None.
BSchoolInfo	string	String length: inclusive between 0 and 5
TypeHome	string	String length: inclusive between 0 and 50
StyleHome	string	String length: inclusive between 0 and 50
Urban	string	String length: inclusive between 0 and 50
AgeHome	string	String length: inclusive between 0 and 50
PurchasePrice	decimal number	None.
ContractDate	date	None.
ScheduleClose	date	None.
HHTripsBegin	string	String length: inclusive between 0 and 150
HHTripsEnd	string	String length: inclusive between 0 and 150
NoChildren	integer	None.
Ages	string	String length: inclusive between 0 and 50
Pets	string	String length: inclusive between 0 and 50
SpecialNeeds	string	None.
DestinationStatus	string	String length: inclusive between 0 and 50
DateRentalNeeded	date	None.
LeaseLength	string	String length: inclusive between 0 and 50
Furnished	string	String length: inclusive between 0 and 50
LeaseAdd1	string	String length: inclusive between 0 and 100
LeaseAdd2	string	String length: inclusive between 0 and 100
LeaseCity	string	String length: inclusive between 0 and 50
LeaseState	string	String length: inclusive between 0 and 50
LeaseZip	string	String length: inclusive between 0 and 50
LeaseStart	date	None.
LeaseEnd	date	None.
LeaseAmount	decimal number	None.
LeaseBreakPenalty	decimal number	None.
ReloClause	string	String length: inclusive between 0 and 50
CanSwitchBuyer	date	None.
CanSwitchRenter	date	None.
CanDeclined	date	None.
AreaInitiationdate	date	None.
AreaCancelled	date	None.
AreaCompleted	date	None.
AreaOnHold	integer	None.
DestUser1	string	String length: inclusive between 0 and 50
DestUser2	string	String length: inclusive between 0 and 50
DestUser3	string	String length: inclusive between 0 and 50
DestUser4	string	String length: inclusive between 0 and 50
DestUser5	string	String length: inclusive between 0 and 50
DestUser6	decimal number	None.
DestUser7	decimal number	None.
DestUser8	decimal number	None.
DestUser9	decimal number	None.
DestUser10	decimal number	None.
DestUser11	date	None.
DestUser12	date	None.
DestUser13	date	None.
DestUser14	date	None.
DestUser15	date	None.
AddedBy	string	String length: inclusive between 0 and 50
AddedOn	date	None.
ModifiedBy	string	String length: inclusive between 0 and 50
ModifiedOn	date	None.
AcloseDate	date	None.
DestinationBrokerID	integer	None.
DestinationBrokerName	string	String length: inclusive between 0 and 100
DSReferralDue	string	String length: inclusive between 0 and 50
DSBrokerMasterRec	string	String length: inclusive between 0 and 10
LeaseCountry	string	String length: inclusive between 0 and 25
BuyerCurrencyCode	string	String length: inclusive between 0 and 10
RenterCurrencyCode	string	String length: inclusive between 0 and 10
LeaseCurrCode	string	String length: inclusive between 0 and 10
CandidateService	string	String length: inclusive between 0 and 50
BuyerServiceStartDate	date	None.
RenterServiceStartDate	date	None.
AreaOrientationServiceStartDate	date	None.
CandidateServiceStartDate	date	None.
ID	integer	None.
Item	Object	None.

Response Formats

application/json, text/json

Sample:

[
  null,
  {
    "AuthorizationID": "sample string 1",
    "TypeofDestination": "sample string 2",
    "RInitiationDate": "2025-05-09T17:37:34.805768+00:00",
    "BInitiationDate": "2025-05-09T17:37:34.805768+00:00",
    "RCancelDate": "2025-05-09T17:37:34.805768+00:00",
    "BCancelDate": "2025-05-09T17:37:34.805768+00:00",
    "ROnHold": 1,
    "BOnHold": 1,
    "CInitiationDate": "2025-05-09T17:37:34.805768+00:00",
    "BLowerPrice": 1.0,
    "RUpperPrice": 1.0,
    "RLowerPrice": 1.0,
    "BUpperPrice": 1.0,
    "RBedrooms": 1,
    "RBathrooms": 1,
    "RSchoolInfo": "sample string 3",
    "BBedrooms": 1,
    "BBathrooms": 1,
    "BSchoolInfo": "sample string 4",
    "TypeHome": "sample string 5",
    "StyleHome": "sample string 6",
    "Urban": "sample string 7",
    "AgeHome": "sample string 8",
    "PurchasePrice": 1.0,
    "ContractDate": "2025-05-09T17:37:34.805768+00:00",
    "ScheduleClose": "2025-05-09T17:37:34.805768+00:00",
    "HHTripsBegin": "sample string 9",
    "HHTripsEnd": "sample string 10",
    "NoChildren": 1,
    "Ages": "sample string 11",
    "Pets": "sample string 12",
    "SpecialNeeds": "sample string 13",
    "DestinationStatus": "sample string 14",
    "DateRentalNeeded": "2025-05-09T17:37:34.805768+00:00",
    "LeaseLength": "sample string 15",
    "Furnished": "sample string 16",
    "LeaseAdd1": "sample string 17",
    "LeaseAdd2": "sample string 18",
    "LeaseCity": "sample string 19",
    "LeaseState": "sample string 20",
    "LeaseZip": "sample string 21",
    "LeaseStart": "2025-05-09T17:37:34.805768+00:00",
    "LeaseEnd": "2025-05-09T17:37:34.805768+00:00",
    "LeaseAmount": 1.0,
    "LeaseBreakPenalty": 1.0,
    "ReloClause": "sample string 22",
    "CanSwitchBuyer": "2025-05-09T17:37:34.805768+00:00",
    "CanSwitchRenter": "2025-05-09T17:37:34.805768+00:00",
    "CanDeclined": "2025-05-09T17:37:34.805768+00:00",
    "AreaInitiationdate": "2025-05-09T17:37:34.805768+00:00",
    "AreaCancelled": "2025-05-09T17:37:34.805768+00:00",
    "AreaCompleted": "2025-05-09T17:37:34.805768+00:00",
    "AreaOnHold": 1,
    "DestUser1": "sample string 23",
    "DestUser2": "sample string 24",
    "DestUser3": "sample string 25",
    "DestUser4": "sample string 26",
    "DestUser5": "sample string 27",
    "DestUser6": 1.0,
    "DestUser7": 1.0,
    "DestUser8": 1.0,
    "DestUser9": 1.0,
    "DestUser10": 1.0,
    "DestUser11": "2025-05-09T17:37:34.805768+00:00",
    "DestUser12": "2025-05-09T17:37:34.805768+00:00",
    "DestUser13": "2025-05-09T17:37:34.805768+00:00",
    "DestUser14": "2025-05-09T17:37:34.805768+00:00",
    "DestUser15": "2025-05-09T17:37:34.805768+00:00",
    "AddedBy": "sample string 28",
    "AddedOn": "2025-05-09T17:37:34.805768+00:00",
    "ModifiedBy": "sample string 29",
    "ModifiedOn": "2025-05-09T17:37:34.805768+00:00",
    "AcloseDate": "2025-05-09T17:37:34.805768+00:00",
    "DestinationBrokerID": 1,
    "DestinationBrokerName": "sample string 30",
    "DSReferralDue": "sample string 31",
    "DSBrokerMasterRec": "sample string 32",
    "LeaseCountry": "sample string 33",
    "BuyerCurrencyCode": "sample string 34",
    "RenterCurrencyCode": "sample string 35",
    "LeaseCurrCode": "sample string 36",
    "CandidateService": "sample string 37",
    "BuyerServiceStartDate": "2025-05-09T17:37:34.805768+00:00",
    "RenterServiceStartDate": "2025-05-09T17:37:34.805768+00:00",
    "AreaOrientationServiceStartDate": "2025-05-09T17:37:34.805768+00:00",
    "CandidateServiceStartDate": "2025-05-09T17:37:34.805768+00:00",
    "ID": 38
  }
]

application/xml, text/xml

Sample:

<ArrayOfDestination xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fabric">
  <Destination i:nil="true" />
  <Destination>
    <AcloseDate>2025-05-09T17:37:34.805768+00:00</AcloseDate>
    <AddedBy>sample string 28</AddedBy>
    <AddedOn>2025-05-09T17:37:34.805768+00:00</AddedOn>
    <AgeHome>sample string 8</AgeHome>
    <Ages>sample string 11</Ages>
    <AreaCancelled>2025-05-09T17:37:34.805768+00:00</AreaCancelled>
    <AreaCompleted>2025-05-09T17:37:34.805768+00:00</AreaCompleted>
    <AreaInitiationdate>2025-05-09T17:37:34.805768+00:00</AreaInitiationdate>
    <AreaOnHold>1</AreaOnHold>
    <AreaOrientationServiceStartDate>2025-05-09T17:37:34.805768+00:00</AreaOrientationServiceStartDate>
    <AuthorizationID>sample string 1</AuthorizationID>
    <BBathrooms>1</BBathrooms>
    <BBedrooms>1</BBedrooms>
    <BCancelDate>2025-05-09T17:37:34.805768+00:00</BCancelDate>
    <BInitiationDate>2025-05-09T17:37:34.805768+00:00</BInitiationDate>
    <BLowerPrice>1</BLowerPrice>
    <BOnHold>1</BOnHold>
    <BSchoolInfo>sample string 4</BSchoolInfo>
    <BUpperPrice>1</BUpperPrice>
    <BuyerCurrencyCode>sample string 34</BuyerCurrencyCode>
    <BuyerServiceStartDate>2025-05-09T17:37:34.805768+00:00</BuyerServiceStartDate>
    <CInitiationDate>2025-05-09T17:37:34.805768+00:00</CInitiationDate>
    <CanDeclined>2025-05-09T17:37:34.805768+00:00</CanDeclined>
    <CanSwitchBuyer>2025-05-09T17:37:34.805768+00:00</CanSwitchBuyer>
    <CanSwitchRenter>2025-05-09T17:37:34.805768+00:00</CanSwitchRenter>
    <CandidateService>sample string 37</CandidateService>
    <CandidateServiceStartDate>2025-05-09T17:37:34.805768+00:00</CandidateServiceStartDate>
    <ContractDate>2025-05-09T17:37:34.805768+00:00</ContractDate>
    <DSBrokerMasterRec>sample string 32</DSBrokerMasterRec>
    <DSReferralDue>sample string 31</DSReferralDue>
    <DateRentalNeeded>2025-05-09T17:37:34.805768+00:00</DateRentalNeeded>
    <DestUser1>sample string 23</DestUser1>
    <DestUser10>1</DestUser10>
    <DestUser11>2025-05-09T17:37:34.805768+00:00</DestUser11>
    <DestUser12>2025-05-09T17:37:34.805768+00:00</DestUser12>
    <DestUser13>2025-05-09T17:37:34.805768+00:00</DestUser13>
    <DestUser14>2025-05-09T17:37:34.805768+00:00</DestUser14>
    <DestUser15>2025-05-09T17:37:34.805768+00:00</DestUser15>
    <DestUser2>sample string 24</DestUser2>
    <DestUser3>sample string 25</DestUser3>
    <DestUser4>sample string 26</DestUser4>
    <DestUser5>sample string 27</DestUser5>
    <DestUser6>1</DestUser6>
    <DestUser7>1</DestUser7>
    <DestUser8>1</DestUser8>
    <DestUser9>1</DestUser9>
    <DestinationBrokerID>1</DestinationBrokerID>
    <DestinationBrokerName>sample string 30</DestinationBrokerName>
    <DestinationStatus>sample string 14</DestinationStatus>
    <Furnished>sample string 16</Furnished>
    <HHTripsBegin>sample string 9</HHTripsBegin>
    <HHTripsEnd>sample string 10</HHTripsEnd>
    <ID>38</ID>
    <LeaseAdd1>sample string 17</LeaseAdd1>
    <LeaseAdd2>sample string 18</LeaseAdd2>
    <LeaseAmount>1</LeaseAmount>
    <LeaseBreakPenalty>1</LeaseBreakPenalty>
    <LeaseCity>sample string 19</LeaseCity>
    <LeaseCountry>sample string 33</LeaseCountry>
    <LeaseCurrCode>sample string 36</LeaseCurrCode>
    <LeaseEnd>2025-05-09T17:37:34.805768+00:00</LeaseEnd>
    <LeaseLength>sample string 15</LeaseLength>
    <LeaseStart>2025-05-09T17:37:34.805768+00:00</LeaseStart>
    <LeaseState>sample string 20</LeaseState>
    <LeaseZip>sample string 21</LeaseZip>
    <ModifiedBy>sample string 29</ModifiedBy>
    <ModifiedOn>2025-05-09T17:37:34.805768+00:00</ModifiedOn>
    <NoChildren>1</NoChildren>
    <Pets>sample string 12</Pets>
    <PurchasePrice>1</PurchasePrice>
    <RBathrooms>1</RBathrooms>
    <RBedrooms>1</RBedrooms>
    <RCancelDate>2025-05-09T17:37:34.805768+00:00</RCancelDate>
    <RInitiationDate>2025-05-09T17:37:34.805768+00:00</RInitiationDate>
    <RLowerPrice>1</RLowerPrice>
    <ROnHold>1</ROnHold>
    <RSchoolInfo>sample string 3</RSchoolInfo>
    <RUpperPrice>1</RUpperPrice>
    <ReloClause>sample string 22</ReloClause>
    <RenterCurrencyCode>sample string 35</RenterCurrencyCode>
    <RenterServiceStartDate>2025-05-09T17:37:34.805768+00:00</RenterServiceStartDate>
    <ScheduleClose>2025-05-09T17:37:34.805768+00:00</ScheduleClose>
    <SpecialNeeds>sample string 13</SpecialNeeds>
    <StyleHome>sample string 6</StyleHome>
    <TypeHome>sample string 5</TypeHome>
    <TypeofDestination>sample string 2</TypeofDestination>
    <Urban>sample string 7</Urban>
  </Destination>
</ArrayOfDestination>