GET api/JobSeeker/Message/GetConversations
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
JobSeekerConversationRequestOutput| Name | Description | Type | Additional information |
|---|---|---|---|
| Success | boolean |
None. |
|
| FailMessage | string |
None. |
|
| SelectedConversationId | string |
None. |
|
| Conversations | Collection of MessageCenterConversation |
None. |
Response Formats
application/json, text/json
Sample:
{
"success": true,
"failMessage": "sample string 2",
"selectedConversationId": "sample string 3",
"conversations": [
{
"id": "sample string 1",
"name": "sample string 2",
"subject": "sample string 3",
"date": "sample string 4",
"isNew": true,
"doNotReply": true,
"messages": [
{
"id": "sample string 1",
"conversationId": "sample string 2",
"body": "sample string 3",
"date": "sample string 4",
"fromLoginId": 5,
"fromName": "sample string 6",
"shortBody": "sample string 7",
"didSendMessage": true,
"attachedOpportunities": [
{
"id": 1,
"opportunityTypeName": "sample string 2",
"title": "sample string 3"
},
{
"id": 1,
"opportunityTypeName": "sample string 2",
"title": "sample string 3"
}
],
"attachedDocuments": [
{
"id": "sample string 1",
"districtDocumentID": 2,
"title": "sample string 3"
},
{
"id": "sample string 1",
"districtDocumentID": 2,
"title": "sample string 3"
}
]
},
{
"id": "sample string 1",
"conversationId": "sample string 2",
"body": "sample string 3",
"date": "sample string 4",
"fromLoginId": 5,
"fromName": "sample string 6",
"shortBody": "sample string 7",
"didSendMessage": true,
"attachedOpportunities": [
{
"id": 1,
"opportunityTypeName": "sample string 2",
"title": "sample string 3"
},
{
"id": 1,
"opportunityTypeName": "sample string 2",
"title": "sample string 3"
}
],
"attachedDocuments": [
{
"id": "sample string 1",
"districtDocumentID": 2,
"title": "sample string 3"
},
{
"id": "sample string 1",
"districtDocumentID": 2,
"title": "sample string 3"
}
]
}
]
},
{
"id": "sample string 1",
"name": "sample string 2",
"subject": "sample string 3",
"date": "sample string 4",
"isNew": true,
"doNotReply": true,
"messages": [
{
"id": "sample string 1",
"conversationId": "sample string 2",
"body": "sample string 3",
"date": "sample string 4",
"fromLoginId": 5,
"fromName": "sample string 6",
"shortBody": "sample string 7",
"didSendMessage": true,
"attachedOpportunities": [
{
"id": 1,
"opportunityTypeName": "sample string 2",
"title": "sample string 3"
},
{
"id": 1,
"opportunityTypeName": "sample string 2",
"title": "sample string 3"
}
],
"attachedDocuments": [
{
"id": "sample string 1",
"districtDocumentID": 2,
"title": "sample string 3"
},
{
"id": "sample string 1",
"districtDocumentID": 2,
"title": "sample string 3"
}
]
},
{
"id": "sample string 1",
"conversationId": "sample string 2",
"body": "sample string 3",
"date": "sample string 4",
"fromLoginId": 5,
"fromName": "sample string 6",
"shortBody": "sample string 7",
"didSendMessage": true,
"attachedOpportunities": [
{
"id": 1,
"opportunityTypeName": "sample string 2",
"title": "sample string 3"
},
{
"id": 1,
"opportunityTypeName": "sample string 2",
"title": "sample string 3"
}
],
"attachedDocuments": [
{
"id": "sample string 1",
"districtDocumentID": 2,
"title": "sample string 3"
},
{
"id": "sample string 1",
"districtDocumentID": 2,
"title": "sample string 3"
}
]
}
]
}
]
}
application/xml, text/xml
Sample:
<JobSeekerConversationRequestOutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIService.Models.JobSeeker">
<Conversations>
<MessageCenterConversation>
<Date>sample string 4</Date>
<DoNotReply>true</DoNotReply>
<Id>sample string 1</Id>
<IsNew>true</IsNew>
<Messages>
<MessageCenterMessage>
<AttachedDocuments>
<MessageAttachedDocument>
<DistrictDocumentID>2</DistrictDocumentID>
<ID>sample string 1</ID>
<Title>sample string 3</Title>
</MessageAttachedDocument>
<MessageAttachedDocument>
<DistrictDocumentID>2</DistrictDocumentID>
<ID>sample string 1</ID>
<Title>sample string 3</Title>
</MessageAttachedDocument>
</AttachedDocuments>
<AttachedOpportunities>
<MessageAttachedOpportunity>
<ID>1</ID>
<OpportunityTypeName>sample string 2</OpportunityTypeName>
<Title>sample string 3</Title>
</MessageAttachedOpportunity>
<MessageAttachedOpportunity>
<ID>1</ID>
<OpportunityTypeName>sample string 2</OpportunityTypeName>
<Title>sample string 3</Title>
</MessageAttachedOpportunity>
</AttachedOpportunities>
<Body>sample string 3</Body>
<ConversationId>sample string 2</ConversationId>
<Date>sample string 4</Date>
<DidSendMessage>true</DidSendMessage>
<FromLoginId>5</FromLoginId>
<FromName>sample string 6</FromName>
<Id>sample string 1</Id>
<ShortBody>sample string 7</ShortBody>
</MessageCenterMessage>
<MessageCenterMessage>
<AttachedDocuments>
<MessageAttachedDocument>
<DistrictDocumentID>2</DistrictDocumentID>
<ID>sample string 1</ID>
<Title>sample string 3</Title>
</MessageAttachedDocument>
<MessageAttachedDocument>
<DistrictDocumentID>2</DistrictDocumentID>
<ID>sample string 1</ID>
<Title>sample string 3</Title>
</MessageAttachedDocument>
</AttachedDocuments>
<AttachedOpportunities>
<MessageAttachedOpportunity>
<ID>1</ID>
<OpportunityTypeName>sample string 2</OpportunityTypeName>
<Title>sample string 3</Title>
</MessageAttachedOpportunity>
<MessageAttachedOpportunity>
<ID>1</ID>
<OpportunityTypeName>sample string 2</OpportunityTypeName>
<Title>sample string 3</Title>
</MessageAttachedOpportunity>
</AttachedOpportunities>
<Body>sample string 3</Body>
<ConversationId>sample string 2</ConversationId>
<Date>sample string 4</Date>
<DidSendMessage>true</DidSendMessage>
<FromLoginId>5</FromLoginId>
<FromName>sample string 6</FromName>
<Id>sample string 1</Id>
<ShortBody>sample string 7</ShortBody>
</MessageCenterMessage>
</Messages>
<Name>sample string 2</Name>
<Subject>sample string 3</Subject>
</MessageCenterConversation>
<MessageCenterConversation>
<Date>sample string 4</Date>
<DoNotReply>true</DoNotReply>
<Id>sample string 1</Id>
<IsNew>true</IsNew>
<Messages>
<MessageCenterMessage>
<AttachedDocuments>
<MessageAttachedDocument>
<DistrictDocumentID>2</DistrictDocumentID>
<ID>sample string 1</ID>
<Title>sample string 3</Title>
</MessageAttachedDocument>
<MessageAttachedDocument>
<DistrictDocumentID>2</DistrictDocumentID>
<ID>sample string 1</ID>
<Title>sample string 3</Title>
</MessageAttachedDocument>
</AttachedDocuments>
<AttachedOpportunities>
<MessageAttachedOpportunity>
<ID>1</ID>
<OpportunityTypeName>sample string 2</OpportunityTypeName>
<Title>sample string 3</Title>
</MessageAttachedOpportunity>
<MessageAttachedOpportunity>
<ID>1</ID>
<OpportunityTypeName>sample string 2</OpportunityTypeName>
<Title>sample string 3</Title>
</MessageAttachedOpportunity>
</AttachedOpportunities>
<Body>sample string 3</Body>
<ConversationId>sample string 2</ConversationId>
<Date>sample string 4</Date>
<DidSendMessage>true</DidSendMessage>
<FromLoginId>5</FromLoginId>
<FromName>sample string 6</FromName>
<Id>sample string 1</Id>
<ShortBody>sample string 7</ShortBody>
</MessageCenterMessage>
<MessageCenterMessage>
<AttachedDocuments>
<MessageAttachedDocument>
<DistrictDocumentID>2</DistrictDocumentID>
<ID>sample string 1</ID>
<Title>sample string 3</Title>
</MessageAttachedDocument>
<MessageAttachedDocument>
<DistrictDocumentID>2</DistrictDocumentID>
<ID>sample string 1</ID>
<Title>sample string 3</Title>
</MessageAttachedDocument>
</AttachedDocuments>
<AttachedOpportunities>
<MessageAttachedOpportunity>
<ID>1</ID>
<OpportunityTypeName>sample string 2</OpportunityTypeName>
<Title>sample string 3</Title>
</MessageAttachedOpportunity>
<MessageAttachedOpportunity>
<ID>1</ID>
<OpportunityTypeName>sample string 2</OpportunityTypeName>
<Title>sample string 3</Title>
</MessageAttachedOpportunity>
</AttachedOpportunities>
<Body>sample string 3</Body>
<ConversationId>sample string 2</ConversationId>
<Date>sample string 4</Date>
<DidSendMessage>true</DidSendMessage>
<FromLoginId>5</FromLoginId>
<FromName>sample string 6</FromName>
<Id>sample string 1</Id>
<ShortBody>sample string 7</ShortBody>
</MessageCenterMessage>
</Messages>
<Name>sample string 2</Name>
<Subject>sample string 3</Subject>
</MessageCenterConversation>
</Conversations>
<FailMessage>sample string 2</FailMessage>
<SelectedConversationId>sample string 3</SelectedConversationId>
<Success>true</Success>
</JobSeekerConversationRequestOutput>