POST v1/agentdata/message/search
Request Information
URI Parameters
None.
Body Parameters
MessageSearchOptions| Name | Description | Type | Additional information |
|---|---|---|---|
| FromUTC | date |
None. |
|
| ToUTC | date |
None. |
|
| PageNo | integer |
None. |
|
| XMLAgentID | string |
None. |
|
| MessageType | MessageType |
None. |
Request Formats
application/json, text/json
Sample:
{
"FromUTC": "2024-12-20T12:53:49.8099757+00:00",
"ToUTC": "2024-12-20T12:53:49.8099757+00:00",
"PageNo": 3,
"XMLAgentID": "sample string 4",
"MessageType": 0
}
application/xml, text/xml
Sample:
<MessageSearchOptions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IRE.API.Models.AgentDataNS"> <FromUTC>2024-12-20T12:53:49.8099757+00:00</FromUTC> <MessageType>Email</MessageType> <PageNo>3</PageNo> <ToUTC>2024-12-20T12:53:49.8099757+00:00</ToUTC> <XMLAgentID>sample string 4</XMLAgentID> </MessageSearchOptions>
multipart/form-data
Sample:
<MessageSearchOptions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IRE.API.Models.AgentDataNS"><FromUTC>2024-12-20T12:53:49.8099757+00:00</FromUTC><MessageType>Email</MessageType><PageNo>3</PageNo><ToUTC>2024-12-20T12:53:49.8099757+00:00</ToUTC><XMLAgentID>sample string 4</XMLAgentID></MessageSearchOptions>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
MessageSearchData| Name | Description | Type | Additional information |
|---|---|---|---|
| RequestedData | string |
None. |
|
| MessageSearchOptions | MessageSearchOptions |
None. |
|
| RecordCount | integer |
None. |
|
| DataRecords | Collection of AgentDataMessage |
None. |
Response Formats
application/json, text/json
Sample:
{
"RequestedData": "sample string 1",
"MessageSearchOptions": {
"FromUTC": "2024-12-20T12:53:49.8099757+00:00",
"ToUTC": "2024-12-20T12:53:49.8099757+00:00",
"PageNo": 3,
"XMLAgentID": "sample string 4",
"MessageType": 0
},
"RecordCount": 2,
"DataRecords": [
{
"ID": 1,
"Type": "sample string 2",
"DateSentUTC": "2024-12-20T12:53:49.8099757+00:00",
"To": "sample string 4",
"From": "sample string 5",
"Subject": "sample string 6",
"Body": "sample string 7",
"Attachments": "sample string 8",
"Prospect": {
"ID": 1,
"DateAddedUTC": "2024-12-20T12:53:49.8099757+00:00",
"LastUpdatedUTC": "2024-12-20T12:53:49.8099757+00:00",
"FirstName": "sample string 4",
"LastName": "sample string 5",
"Email": "sample string 6",
"Mobile": "sample string 7",
"HomePhone": "sample string 8",
"Address": "sample string 9",
"TenantNotes": "sample string 10",
"BuyerNotes": "sample string 11",
"BuyerTimeStampedNotes": [
{
"ID": 1,
"TimeStampUTC": "2024-12-20T12:53:49.8099757+00:00",
"Note": "sample string 3",
"Type": 0
},
{
"ID": 1,
"TimeStampUTC": "2024-12-20T12:53:49.8099757+00:00",
"Note": "sample string 3",
"Type": 0
}
],
"BuyerStatus": {
"DateAddedUTC": "2024-12-20T12:53:49.8099757+00:00",
"LastUpdatedUTC": "2024-12-20T12:53:49.8099757+00:00",
"SellerValue": 3,
"BuyerValue": 4,
"InvestorValue": 5,
"FinanceValue": 6,
"SellerComment": "sample string 7",
"BuyerComment": "sample string 8",
"InvestorComment": "sample string 9",
"FinanceComment": "sample string 10",
"TimeStampedComments": [
{
"ID": 1,
"TimeStampUTC": "2024-12-20T12:53:49.8099757+00:00",
"Note": "sample string 3",
"Type": 0
},
{
"ID": 1,
"TimeStampUTC": "2024-12-20T12:53:49.8099757+00:00",
"Note": "sample string 3",
"Type": 0
}
]
}
},
"OfficeDetails": {
"OfficeID": "a7f6c38c-afa7-4b08-bbef-9c7d1ff088c1",
"LoginName": "sample string 2",
"InternalName": "sample string 3",
"ExternalName": "sample string 4",
"Address": {
"StreetNo": "sample string 1",
"Street": "sample string 2",
"Suburb": "sample string 3",
"State": "sample string 4",
"PostCode": "sample string 5",
"Country": "sample string 6"
}
}
},
{
"ID": 1,
"Type": "sample string 2",
"DateSentUTC": "2024-12-20T12:53:49.8099757+00:00",
"To": "sample string 4",
"From": "sample string 5",
"Subject": "sample string 6",
"Body": "sample string 7",
"Attachments": "sample string 8",
"Prospect": {
"ID": 1,
"DateAddedUTC": "2024-12-20T12:53:49.8099757+00:00",
"LastUpdatedUTC": "2024-12-20T12:53:49.8099757+00:00",
"FirstName": "sample string 4",
"LastName": "sample string 5",
"Email": "sample string 6",
"Mobile": "sample string 7",
"HomePhone": "sample string 8",
"Address": "sample string 9",
"TenantNotes": "sample string 10",
"BuyerNotes": "sample string 11",
"BuyerTimeStampedNotes": [
{
"ID": 1,
"TimeStampUTC": "2024-12-20T12:53:49.8099757+00:00",
"Note": "sample string 3",
"Type": 0
},
{
"ID": 1,
"TimeStampUTC": "2024-12-20T12:53:49.8099757+00:00",
"Note": "sample string 3",
"Type": 0
}
],
"BuyerStatus": {
"DateAddedUTC": "2024-12-20T12:53:49.8099757+00:00",
"LastUpdatedUTC": "2024-12-20T12:53:49.8099757+00:00",
"SellerValue": 3,
"BuyerValue": 4,
"InvestorValue": 5,
"FinanceValue": 6,
"SellerComment": "sample string 7",
"BuyerComment": "sample string 8",
"InvestorComment": "sample string 9",
"FinanceComment": "sample string 10",
"TimeStampedComments": [
{
"ID": 1,
"TimeStampUTC": "2024-12-20T12:53:49.8099757+00:00",
"Note": "sample string 3",
"Type": 0
},
{
"ID": 1,
"TimeStampUTC": "2024-12-20T12:53:49.8099757+00:00",
"Note": "sample string 3",
"Type": 0
}
]
}
},
"OfficeDetails": {
"OfficeID": "a7f6c38c-afa7-4b08-bbef-9c7d1ff088c1",
"LoginName": "sample string 2",
"InternalName": "sample string 3",
"ExternalName": "sample string 4",
"Address": {
"StreetNo": "sample string 1",
"Street": "sample string 2",
"Suburb": "sample string 3",
"State": "sample string 4",
"PostCode": "sample string 5",
"Country": "sample string 6"
}
}
}
]
}
application/xml, text/xml
Sample:
<MessageSearchData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IRE.API.Models.AgentDataNS">
<DataRecords>
<AgentDataMessage>
<Attachments>sample string 8</Attachments>
<Body>sample string 7</Body>
<DateSentUTC>2024-12-20T12:53:49.8099757+00:00</DateSentUTC>
<From>sample string 5</From>
<ID>1</ID>
<OfficeDetails>
<Address>
<Country>sample string 6</Country>
<PostCode>sample string 5</PostCode>
<State>sample string 4</State>
<Street>sample string 2</Street>
<StreetNo>sample string 1</StreetNo>
<Suburb>sample string 3</Suburb>
</Address>
<ExternalName>sample string 4</ExternalName>
<InternalName>sample string 3</InternalName>
<LoginName>sample string 2</LoginName>
<OfficeID>a7f6c38c-afa7-4b08-bbef-9c7d1ff088c1</OfficeID>
</OfficeDetails>
<Prospect>
<Address>sample string 9</Address>
<BuyerNotes>sample string 11</BuyerNotes>
<BuyerStatus>
<BuyerComment>sample string 8</BuyerComment>
<BuyerValue>4</BuyerValue>
<DateAddedUTC>2024-12-20T12:53:49.8099757+00:00</DateAddedUTC>
<FinanceComment>sample string 10</FinanceComment>
<FinanceValue>6</FinanceValue>
<InvestorComment>sample string 9</InvestorComment>
<InvestorValue>5</InvestorValue>
<LastUpdatedUTC>2024-12-20T12:53:49.8099757+00:00</LastUpdatedUTC>
<SellerComment>sample string 7</SellerComment>
<SellerValue>3</SellerValue>
<TimeStampedComments>
<AgentDataProspectNote>
<ID>1</ID>
<Note>sample string 3</Note>
<TimeStampUTC>2024-12-20T12:53:49.8099757+00:00</TimeStampUTC>
<Type>General</Type>
</AgentDataProspectNote>
<AgentDataProspectNote>
<ID>1</ID>
<Note>sample string 3</Note>
<TimeStampUTC>2024-12-20T12:53:49.8099757+00:00</TimeStampUTC>
<Type>General</Type>
</AgentDataProspectNote>
</TimeStampedComments>
</BuyerStatus>
<BuyerTimeStampedNotes>
<AgentDataProspectNote>
<ID>1</ID>
<Note>sample string 3</Note>
<TimeStampUTC>2024-12-20T12:53:49.8099757+00:00</TimeStampUTC>
<Type>General</Type>
</AgentDataProspectNote>
<AgentDataProspectNote>
<ID>1</ID>
<Note>sample string 3</Note>
<TimeStampUTC>2024-12-20T12:53:49.8099757+00:00</TimeStampUTC>
<Type>General</Type>
</AgentDataProspectNote>
</BuyerTimeStampedNotes>
<DateAddedUTC>2024-12-20T12:53:49.8099757+00:00</DateAddedUTC>
<Email>sample string 6</Email>
<FirstName>sample string 4</FirstName>
<HomePhone>sample string 8</HomePhone>
<ID>1</ID>
<LastName>sample string 5</LastName>
<LastUpdatedUTC>2024-12-20T12:53:49.8099757+00:00</LastUpdatedUTC>
<Mobile>sample string 7</Mobile>
<TenantNotes>sample string 10</TenantNotes>
</Prospect>
<Subject>sample string 6</Subject>
<To>sample string 4</To>
<Type>sample string 2</Type>
</AgentDataMessage>
<AgentDataMessage>
<Attachments>sample string 8</Attachments>
<Body>sample string 7</Body>
<DateSentUTC>2024-12-20T12:53:49.8099757+00:00</DateSentUTC>
<From>sample string 5</From>
<ID>1</ID>
<OfficeDetails>
<Address>
<Country>sample string 6</Country>
<PostCode>sample string 5</PostCode>
<State>sample string 4</State>
<Street>sample string 2</Street>
<StreetNo>sample string 1</StreetNo>
<Suburb>sample string 3</Suburb>
</Address>
<ExternalName>sample string 4</ExternalName>
<InternalName>sample string 3</InternalName>
<LoginName>sample string 2</LoginName>
<OfficeID>a7f6c38c-afa7-4b08-bbef-9c7d1ff088c1</OfficeID>
</OfficeDetails>
<Prospect>
<Address>sample string 9</Address>
<BuyerNotes>sample string 11</BuyerNotes>
<BuyerStatus>
<BuyerComment>sample string 8</BuyerComment>
<BuyerValue>4</BuyerValue>
<DateAddedUTC>2024-12-20T12:53:49.8099757+00:00</DateAddedUTC>
<FinanceComment>sample string 10</FinanceComment>
<FinanceValue>6</FinanceValue>
<InvestorComment>sample string 9</InvestorComment>
<InvestorValue>5</InvestorValue>
<LastUpdatedUTC>2024-12-20T12:53:49.8099757+00:00</LastUpdatedUTC>
<SellerComment>sample string 7</SellerComment>
<SellerValue>3</SellerValue>
<TimeStampedComments>
<AgentDataProspectNote>
<ID>1</ID>
<Note>sample string 3</Note>
<TimeStampUTC>2024-12-20T12:53:49.8099757+00:00</TimeStampUTC>
<Type>General</Type>
</AgentDataProspectNote>
<AgentDataProspectNote>
<ID>1</ID>
<Note>sample string 3</Note>
<TimeStampUTC>2024-12-20T12:53:49.8099757+00:00</TimeStampUTC>
<Type>General</Type>
</AgentDataProspectNote>
</TimeStampedComments>
</BuyerStatus>
<BuyerTimeStampedNotes>
<AgentDataProspectNote>
<ID>1</ID>
<Note>sample string 3</Note>
<TimeStampUTC>2024-12-20T12:53:49.8099757+00:00</TimeStampUTC>
<Type>General</Type>
</AgentDataProspectNote>
<AgentDataProspectNote>
<ID>1</ID>
<Note>sample string 3</Note>
<TimeStampUTC>2024-12-20T12:53:49.8099757+00:00</TimeStampUTC>
<Type>General</Type>
</AgentDataProspectNote>
</BuyerTimeStampedNotes>
<DateAddedUTC>2024-12-20T12:53:49.8099757+00:00</DateAddedUTC>
<Email>sample string 6</Email>
<FirstName>sample string 4</FirstName>
<HomePhone>sample string 8</HomePhone>
<ID>1</ID>
<LastName>sample string 5</LastName>
<LastUpdatedUTC>2024-12-20T12:53:49.8099757+00:00</LastUpdatedUTC>
<Mobile>sample string 7</Mobile>
<TenantNotes>sample string 10</TenantNotes>
</Prospect>
<Subject>sample string 6</Subject>
<To>sample string 4</To>
<Type>sample string 2</Type>
</AgentDataMessage>
</DataRecords>
<MessageSearchOptions>
<FromUTC>2024-12-20T12:53:49.8099757+00:00</FromUTC>
<MessageType>Email</MessageType>
<PageNo>3</PageNo>
<ToUTC>2024-12-20T12:53:49.8099757+00:00</ToUTC>
<XMLAgentID>sample string 4</XMLAgentID>
</MessageSearchOptions>
<RecordCount>2</RecordCount>
<RequestedData>sample string 1</RequestedData>
</MessageSearchData>
multipart/form-data
Sample:
<MessageSearchData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IRE.API.Models.AgentDataNS"><DataRecords><AgentDataMessage><Attachments>sample string 8</Attachments><Body>sample string 7</Body><DateSentUTC>2024-12-20T12:53:49.8099757+00:00</DateSentUTC><From>sample string 5</From><ID>1</ID><OfficeDetails><Address><Country>sample string 6</Country><PostCode>sample string 5</PostCode><State>sample string 4</State><Street>sample string 2</Street><StreetNo>sample string 1</StreetNo><Suburb>sample string 3</Suburb></Address><ExternalName>sample string 4</ExternalName><InternalName>sample string 3</InternalName><LoginName>sample string 2</LoginName><OfficeID>a7f6c38c-afa7-4b08-bbef-9c7d1ff088c1</OfficeID></OfficeDetails><Prospect><Address>sample string 9</Address><BuyerNotes>sample string 11</BuyerNotes><BuyerStatus><BuyerComment>sample string 8</BuyerComment><BuyerValue>4</BuyerValue><DateAddedUTC>2024-12-20T12:53:49.8099757+00:00</DateAddedUTC><FinanceComment>sample string 10</FinanceComment><FinanceValue>6</FinanceValue><InvestorComment>sample string 9</InvestorComment><InvestorValue>5</InvestorValue><LastUpdatedUTC>2024-12-20T12:53:49.8099757+00:00</LastUpdatedUTC><SellerComment>sample string 7</SellerComment><SellerValue>3</SellerValue><TimeStampedComments><AgentDataProspectNote><ID>1</ID><Note>sample string 3</Note><TimeStampUTC>2024-12-20T12:53:49.8099757+00:00</TimeStampUTC><Type>General</Type></AgentDataProspectNote><AgentDataProspectNote><ID>1</ID><Note>sample string 3</Note><TimeStampUTC>2024-12-20T12:53:49.8099757+00:00</TimeStampUTC><Type>General</Type></AgentDataProspectNote></TimeStampedComments></BuyerStatus><BuyerTimeStampedNotes><AgentDataProspectNote><ID>1</ID><Note>sample string 3</Note><TimeStampUTC>2024-12-20T12:53:49.8099757+00:00</TimeStampUTC><Type>General</Type></AgentDataProspectNote><AgentDataProspectNote><ID>1</ID><Note>sample string 3</Note><TimeStampUTC>2024-12-20T12:53:49.8099757+00:00</TimeStampUTC><Type>General</Type></AgentDataProspectNote></BuyerTimeStampedNotes><DateAddedUTC>2024-12-20T12:53:49.8099757+00:00</DateAddedUTC><Email>sample string 6</Email><FirstName>sample string 4</FirstName><HomePhone>sample string 8</HomePhone><ID>1</ID><LastName>sample string 5</LastName><LastUpdatedUTC>2024-12-20T12:53:49.8099757+00:00</LastUpdatedUTC><Mobile>sample string 7</Mobile><TenantNotes>sample string 10</TenantNotes></Prospect><Subject>sample string 6</Subject><To>sample string 4</To><Type>sample string 2</Type></AgentDataMessage><AgentDataMessage><Attachments>sample string 8</Attachments><Body>sample string 7</Body><DateSentUTC>2024-12-20T12:53:49.8099757+00:00</DateSentUTC><From>sample string 5</From><ID>1</ID><OfficeDetails><Address><Country>sample string 6</Country><PostCode>sample string 5</PostCode><State>sample string 4</State><Street>sample string 2</Street><StreetNo>sample string 1</StreetNo><Suburb>sample string 3</Suburb></Address><ExternalName>sample string 4</ExternalName><InternalName>sample string 3</InternalName><LoginName>sample string 2</LoginName><OfficeID>a7f6c38c-afa7-4b08-bbef-9c7d1ff088c1</OfficeID></OfficeDetails><Prospect><Address>sample string 9</Address><BuyerNotes>sample string 11</BuyerNotes><BuyerStatus><BuyerComment>sample string 8</BuyerComment><BuyerValue>4</BuyerValue><DateAddedUTC>2024-12-20T12:53:49.8099757+00:00</DateAddedUTC><FinanceComment>sample string 10</FinanceComment><FinanceValue>6</FinanceValue><InvestorComment>sample string 9</InvestorComment><InvestorValue>5</InvestorValue><LastUpdatedUTC>2024-12-20T12:53:49.8099757+00:00</LastUpdatedUTC><SellerComment>sample string 7</SellerComment><SellerValue>3</SellerValue><TimeStampedComments><AgentDataProspectNote><ID>1</ID><Note>sample string 3</Note><TimeStampUTC>2024-12-20T12:53:49.8099757+00:00</TimeStampUTC><Type>General</Type></AgentDataProspectNote><AgentDataProspectNote><ID>1</ID><Note>sample string 3</Note><TimeStampUTC>2024-12-20T12:53:49.8099757+00:00</TimeStampUTC><Type>General</Type></AgentDataProspectNote></TimeStampedComments></BuyerStatus><BuyerTimeStampedNotes><AgentDataProspectNote><ID>1</ID><Note>sample string 3</Note><TimeStampUTC>2024-12-20T12:53:49.8099757+00:00</TimeStampUTC><Type>General</Type></AgentDataProspectNote><AgentDataProspectNote><ID>1</ID><Note>sample string 3</Note><TimeStampUTC>2024-12-20T12:53:49.8099757+00:00</TimeStampUTC><Type>General</Type></AgentDataProspectNote></BuyerTimeStampedNotes><DateAddedUTC>2024-12-20T12:53:49.8099757+00:00</DateAddedUTC><Email>sample string 6</Email><FirstName>sample string 4</FirstName><HomePhone>sample string 8</HomePhone><ID>1</ID><LastName>sample string 5</LastName><LastUpdatedUTC>2024-12-20T12:53:49.8099757+00:00</LastUpdatedUTC><Mobile>sample string 7</Mobile><TenantNotes>sample string 10</TenantNotes></Prospect><Subject>sample string 6</Subject><To>sample string 4</To><Type>sample string 2</Type></AgentDataMessage></DataRecords><MessageSearchOptions><FromUTC>2024-12-20T12:53:49.8099757+00:00</FromUTC><MessageType>Email</MessageType><PageNo>3</PageNo><ToUTC>2024-12-20T12:53:49.8099757+00:00</ToUTC><XMLAgentID>sample string 4</XMLAgentID></MessageSearchOptions><RecordCount>2</RecordCount><RequestedData>sample string 1</RequestedData></MessageSearchData>