POST api/Message/GetAllMessagesForEntities
Get Messages for Entities
Request Information
URI Parameters
None.
Body Parameters
ClaimsRequestModelName | Description | Type | Additional information |
---|---|---|---|
BeneficiaryName | string |
None. |
|
ClaimReferenceNumber | string |
None. |
|
LoggedInEntity | integer |
None. |
|
ClaimNumber | string |
None. |
|
ClaimAmount | string |
None. |
|
ProductCategory | string |
None. |
|
ClaimStatus | string |
None. |
|
SubmittedDate | string |
None. |
|
ServiceDate | string |
None. |
|
SortParam | integer |
None. |
|
PageNumber | integer |
None. |
|
PageSize | integer |
None. |
|
Entities | Collection of MyClaimEntity |
None. |
Request Formats
application/json, text/json
Sample:
{ "BeneficiaryName": "sample string 1", "ClaimReferenceNumber": "sample string 2", "LoggedInEntity": 3, "ClaimNumber": "sample string 4", "ClaimAmount": "sample string 5", "ProductCategory": "sample string 6", "ClaimStatus": "sample string 7", "SubmittedDate": "sample string 8", "ServiceDate": "sample string 9", "SortParam": 1, "PageNumber": 1, "PageSize": 1, "Entities": [ { "EntityId": 1, "FirstName": "sample string 2", "LastName": "sample string 3", "Initials": "sample string 4", "IndividualId": 5, "DateOfBirth": "2025-05-02T07:09:07.2868493-07:00" }, { "EntityId": 1, "FirstName": "sample string 2", "LastName": "sample string 3", "Initials": "sample string 4", "IndividualId": 5, "DateOfBirth": "2025-05-02T07:09:07.2868493-07:00" } ] }
application/xml, text/xml
Sample:
<ClaimsRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GBG.MemberPortal.Data.Models.Claim"> <BeneficiaryName>sample string 1</BeneficiaryName> <ClaimAmount>sample string 5</ClaimAmount> <ClaimNumber>sample string 4</ClaimNumber> <ClaimReferenceNumber>sample string 2</ClaimReferenceNumber> <ClaimStatus>sample string 7</ClaimStatus> <Entities> <MyClaimEntity> <DateOfBirth>2025-05-02T07:09:07.2868493-07:00</DateOfBirth> <EntityId>1</EntityId> <FirstName>sample string 2</FirstName> <IndividualId>5</IndividualId> <Initials>sample string 4</Initials> <LastName>sample string 3</LastName> </MyClaimEntity> <MyClaimEntity> <DateOfBirth>2025-05-02T07:09:07.2868493-07:00</DateOfBirth> <EntityId>1</EntityId> <FirstName>sample string 2</FirstName> <IndividualId>5</IndividualId> <Initials>sample string 4</Initials> <LastName>sample string 3</LastName> </MyClaimEntity> </Entities> <LoggedInEntity>3</LoggedInEntity> <PageNumber>1</PageNumber> <PageSize>1</PageSize> <ProductCategory>sample string 6</ProductCategory> <ServiceDate>sample string 9</ServiceDate> <SortParam>1</SortParam> <SubmittedDate>sample string 8</SubmittedDate> </ClaimsRequestModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Collection of ClaimMessageResponseName | Description | Type | Additional information |
---|---|---|---|
ClaimId | integer |
None. |
|
ClaimReferenceNumber | string |
None. |
|
TotalCount | integer |
None. |
|
UnReadCount | integer |
None. |
|
MessageType | string |
None. |
|
ID | integer |
None. |
|
Source | string |
None. |
|
EnteredBy | string |
None. |
|
EnteredOn | date |
None. |
|
Content | string |
None. |
|
IsRead | boolean |
None. |
Response Formats
application/json, text/json
Sample:
[ { "ClaimId": 1, "ClaimReferenceNumber": "sample string 2", "TotalCount": 3, "UnReadCount": 4, "MessageType": "Claim", "ID": 5, "Source": "sample string 6", "EnteredBy": "sample string 7", "EnteredOn": "2025-05-02T07:09:07.3024765-07:00", "Content": "sample string 9", "IsRead": true }, { "ClaimId": 1, "ClaimReferenceNumber": "sample string 2", "TotalCount": 3, "UnReadCount": 4, "MessageType": "Claim", "ID": 5, "Source": "sample string 6", "EnteredBy": "sample string 7", "EnteredOn": "2025-05-02T07:09:07.3024765-07:00", "Content": "sample string 9", "IsRead": true } ]
application/xml, text/xml
Sample:
<ArrayOfClaimMessageResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GBG.MemberPortal.API.Models"> <ClaimMessageResponse> <Content>sample string 9</Content> <EnteredBy>sample string 7</EnteredBy> <EnteredOn>2025-05-02T07:09:07.3024765-07:00</EnteredOn> <ID>5</ID> <IsRead>true</IsRead> <Source>sample string 6</Source> <ClaimId>1</ClaimId> <ClaimReferenceNumber>sample string 2</ClaimReferenceNumber> <TotalCount>3</TotalCount> <UnReadCount>4</UnReadCount> </ClaimMessageResponse> <ClaimMessageResponse> <Content>sample string 9</Content> <EnteredBy>sample string 7</EnteredBy> <EnteredOn>2025-05-02T07:09:07.3024765-07:00</EnteredOn> <ID>5</ID> <IsRead>true</IsRead> <Source>sample string 6</Source> <ClaimId>1</ClaimId> <ClaimReferenceNumber>sample string 2</ClaimReferenceNumber> <TotalCount>3</TotalCount> <UnReadCount>4</UnReadCount> </ClaimMessageResponse> </ArrayOfClaimMessageResponse>