GET Claims?apikey={apikey}&NDC_Claim_ID={NDC_Claim_ID}
Returns a specific Claim by its Claim ID.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
apikey |
The apikey used for authentication. Required. |
string |
Required |
NDC_Claim_ID |
The ID of the Claim requested. Required. |
string |
Required |
Response Information
Response Schema Document
Resource Description
A single Claim object
ClaimName | Description | Type | Additional information |
---|---|---|---|
Claim_Num | string |
None. |
|
ClaimDescription | string |
None. |
|
ClaimLevel | string |
None. |
|
Comments | string |
None. |
|
AccountNumber | string |
None. |
|
Creditor_PK | string |
None. |
|
CreditorName | string |
None. |
|
CreditorAddressLine1 | string |
None. |
|
CreditorAddressLine2 | string |
None. |
|
CreditorCity | string |
None. |
|
CreditorContactName | string |
None. |
|
CreditorPhone | string |
None. |
|
CreditorNumber | string |
None. |
|
ClaimAMT | string |
None. |
|
ScheduleAMT | string |
None. |
|
MonthlyPaymentAMT | string |
None. |
|
CollateralValueAMT | string |
None. |
|
PrincipalPaidToDate | string |
None. |
|
PrincipalOwedAMT | string |
None. |
|
PrincipalDueAMT | string |
None. |
|
InterestRate | string |
None. |
|
InterestPaidAMT | string |
None. |
|
InterestDueAMT | string |
None. |
|
TrusteePercent | string |
None. |
|
NoCheck | string |
None. |
|
StopDisbursement | string |
None. |
|
Continuing | string |
None. |
|
Reserve | string |
None. |
|
MaxPayAMT | string |
None. |
|
Service_Provider | string |
None. |
|
NDC_Case_ID | string |
None. |
|
NDC_Claim_ID | string |
None. |
Response Formats
application/xml, text/xml
Sample:
<Claim xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NDCapi.Models"> <AccountNumber>sample string 5</AccountNumber> <ClaimAMT>sample string 14</ClaimAMT> <ClaimDescription>sample string 2</ClaimDescription> <ClaimLevel>sample string 3</ClaimLevel> <Claim_Num>sample string 1</Claim_Num> <CollateralValueAMT>sample string 17</CollateralValueAMT> <Comments>sample string 4</Comments> <Continuing>sample string 27</Continuing> <CreditorAddressLine1>sample string 8</CreditorAddressLine1> <CreditorAddressLine2>sample string 9</CreditorAddressLine2> <CreditorCity>sample string 10</CreditorCity> <CreditorContactName>sample string 11</CreditorContactName> <CreditorName>sample string 7</CreditorName> <CreditorNumber>sample string 13</CreditorNumber> <CreditorPhone>sample string 12</CreditorPhone> <Creditor_PK>sample string 6</Creditor_PK> <InterestDueAMT>sample string 23</InterestDueAMT> <InterestPaidAMT>sample string 22</InterestPaidAMT> <InterestRate>sample string 21</InterestRate> <MaxPayAMT>sample string 29</MaxPayAMT> <MonthlyPaymentAMT>sample string 16</MonthlyPaymentAMT> <NDC_Case_ID>sample string 31</NDC_Case_ID> <NDC_Claim_ID>sample string 32</NDC_Claim_ID> <NoCheck>sample string 25</NoCheck> <PrincipalDueAMT>sample string 20</PrincipalDueAMT> <PrincipalOwedAMT>sample string 19</PrincipalOwedAMT> <PrincipalPaidToDate>sample string 18</PrincipalPaidToDate> <Reserve>sample string 28</Reserve> <ScheduleAMT>sample string 15</ScheduleAMT> <Service_Provider>sample string 30</Service_Provider> <StopDisbursement>sample string 26</StopDisbursement> <TrusteePercent>sample string 24</TrusteePercent> </Claim>
application/json, text/json
Sample:
{ "Claim_Num": "sample string 1", "ClaimDescription": "sample string 2", "ClaimLevel": "sample string 3", "Comments": "sample string 4", "AccountNumber": "sample string 5", "Creditor_PK": "sample string 6", "CreditorName": "sample string 7", "CreditorAddressLine1": "sample string 8", "CreditorAddressLine2": "sample string 9", "CreditorCity": "sample string 10", "CreditorContactName": "sample string 11", "CreditorPhone": "sample string 12", "CreditorNumber": "sample string 13", "ClaimAMT": "sample string 14", "ScheduleAMT": "sample string 15", "MonthlyPaymentAMT": "sample string 16", "CollateralValueAMT": "sample string 17", "PrincipalPaidToDate": "sample string 18", "PrincipalOwedAMT": "sample string 19", "PrincipalDueAMT": "sample string 20", "InterestRate": "sample string 21", "InterestPaidAMT": "sample string 22", "InterestDueAMT": "sample string 23", "TrusteePercent": "sample string 24", "NoCheck": "sample string 25", "StopDisbursement": "sample string 26", "Continuing": "sample string 27", "Reserve": "sample string 28", "MaxPayAMT": "sample string 29", "Service_Provider": "sample string 30", "NDC_Case_ID": "sample string 31", "NDC_Claim_ID": "sample string 32" }