POST api/RetrieveStatus
Retrieve Account Status by Date Range
Request Information
URI Parameters
None.
Body Parameters
DateRangeApiModel| Name | Description | Type | Additional information |
|---|---|---|---|
| StartDate |
Start Date |
date |
Required |
| EndDate |
End Date |
date |
Required |
Request Formats
application/json, text/json
Sample:
{
"StartDate": "2026-01-07T22:32:31.3868111+00:00",
"EndDate": "2026-01-07T22:32:31.3868111+00:00"
}
application/xml, text/xml
Sample:
<DateRangeApiModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EFG.Models"> <EndDate>2026-01-07T22:32:31.3868111+00:00</EndDate> <StartDate>2026-01-07T22:32:31.3868111+00:00</StartDate> </DateRangeApiModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Collection of ClaimReturnViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| FirstName |
John |
string |
Required |
| LastName |
Doe |
string |
Required |
|
johndoe@domain.com |
string |
None. |
|
| Phone |
1234567890 |
string |
None. |
| Address1 |
123 Main St |
string |
Required |
| Address2 | string |
None. |
|
| City |
Anytown |
string |
Required |
| State |
FL |
string |
Required |
| Zip |
12345 |
string |
None. |
| TextOption | boolean |
None. |
|
| InstallDate | date |
None. |
|
| Amount |
225 |
decimal number |
Required |
| AccountNumber |
Account Number |
string |
Required |
| Country |
US/CA/PR |
string |
None. |
| Provider |
Gift Card Provider |
string |
None. |
| ClaimStatus | string |
None. |
|
| StatusDate | date |
None. |
|
| Shipdate | string |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"FirstName": "sample string 1",
"LastName": "sample string 2",
"Email": "sample string 3",
"Phone": "sample string 4",
"Address1": "sample string 5",
"Address2": "sample string 6",
"City": "sample string 7",
"State": "sample string 8",
"Zip": "sample string 9",
"TextOption": true,
"InstallDate": "2026-01-07T22:32:31.6212242+00:00",
"Amount": 12.0,
"AccountNumber": "sample string 13",
"Country": "sample string 14",
"Provider": "sample string 15",
"ClaimStatus": "sample string 16",
"StatusDate": "2026-01-07T22:32:31.6212242+00:00",
"Shipdate": "sample string 18"
},
{
"FirstName": "sample string 1",
"LastName": "sample string 2",
"Email": "sample string 3",
"Phone": "sample string 4",
"Address1": "sample string 5",
"Address2": "sample string 6",
"City": "sample string 7",
"State": "sample string 8",
"Zip": "sample string 9",
"TextOption": true,
"InstallDate": "2026-01-07T22:32:31.6212242+00:00",
"Amount": 12.0,
"AccountNumber": "sample string 13",
"Country": "sample string 14",
"Provider": "sample string 15",
"ClaimStatus": "sample string 16",
"StatusDate": "2026-01-07T22:32:31.6212242+00:00",
"Shipdate": "sample string 18"
}
]
application/xml, text/xml
Sample:
<ArrayOfClaimReturnViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EFG.Models.ViewModels">
<ClaimReturnViewModel>
<AccountNumber>sample string 13</AccountNumber>
<Address1>sample string 5</Address1>
<Address2>sample string 6</Address2>
<Amount>12</Amount>
<City>sample string 7</City>
<ClaimStatus>sample string 16</ClaimStatus>
<Country>sample string 14</Country>
<Email>sample string 3</Email>
<FirstName>sample string 1</FirstName>
<InstallDate>2026-01-07T22:32:31.6212242+00:00</InstallDate>
<LastName>sample string 2</LastName>
<Phone>sample string 4</Phone>
<Provider>sample string 15</Provider>
<Shipdate>sample string 18</Shipdate>
<State>sample string 8</State>
<StatusDate>2026-01-07T22:32:31.6212242+00:00</StatusDate>
<TextOption>true</TextOption>
<Zip>sample string 9</Zip>
</ClaimReturnViewModel>
<ClaimReturnViewModel>
<AccountNumber>sample string 13</AccountNumber>
<Address1>sample string 5</Address1>
<Address2>sample string 6</Address2>
<Amount>12</Amount>
<City>sample string 7</City>
<ClaimStatus>sample string 16</ClaimStatus>
<Country>sample string 14</Country>
<Email>sample string 3</Email>
<FirstName>sample string 1</FirstName>
<InstallDate>2026-01-07T22:32:31.6212242+00:00</InstallDate>
<LastName>sample string 2</LastName>
<Phone>sample string 4</Phone>
<Provider>sample string 15</Provider>
<Shipdate>sample string 18</Shipdate>
<State>sample string 8</State>
<StatusDate>2026-01-07T22:32:31.6212242+00:00</StatusDate>
<TextOption>true</TextOption>
<Zip>sample string 9</Zip>
</ClaimReturnViewModel>
</ArrayOfClaimReturnViewModel>
