Get list of suspenses
get
/PASService/rest/services/v1/suspenses
Gets a list of the latest 100 suspenses. Also, define expand attributes to expand a suspense by its child suspense
Request
Query Parameters
-
expand: string
codes, all
-
limit: integer(int32)
limit value
-
offset: integer(int32)
offset value
-
q: string
Search parameter
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
successful operation
Examples
This example describes how to get a list of latest 100 suspenses. Also, define expand attributes to expand a suspense by its child suspense.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl \
-X GET \
-H "Content-Type: application/json" \
-u 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-L "http://server:port/PASService/rest/services/v1/suspenses" Example Response Body
The following shows an example of the response body in JSON format:
{
"count": 1,
"offset": 0,
"limit": 100,
"suspenses": [
{
"links": [
{
"href": "http://localhost:8081/PASService/rest/services/suspenses/95B63F21-E86D-42AA-B2D0-FDEBF3F9E427",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://localhost:8081/PASService/rest/services/codes?codeName=SuspenseType&codeValue=02",
"rel": "codes/suspenseType",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://localhost:8081/PASService/rest/services/codes?codeName=SuspenseStatus&Codevalue=15",
"rel": "codes/suspenseStatus",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://localhost:8081/PASService/rest/services/companies/51673985-8606-4ABF-9EEE-85328BE03DA5",
"rel": "Companies",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://localhost:8081/PASService/rest/services/suspenses/95B63F21-E86D-42AA-B2D0-FDEBF3F9E427/accounting",
"rel": "accounting",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://localhost:8081/PASService/rest/services/suspenses/95B63F21-E86D-42AA-B2D0-FDEBF3F9E427/childSuspenses",
"rel": "childSuspenses",
"mediaType": "application/json",
"method": "GET"
}
],
"suspenseId": "95B63F21-E86D-42AA-B2D0-FDEBF3F9E427",
"suspenseNumber": 44252,
"typeCode": "02",
"statusCode": "15",
"amount": 349.25,
"currencyCode": "USD",
"attachedAmount": 0,
"companyId": "51673985-8606-4ABF-9EEE-85328BE03DA5",
"policyNumber": "DI0000078255",
"effectiveDate": "1990-01-01T00:00:00Z",
"effectiveFromDate": "1990-01-01T00:00:00Z",
"effectiveToDate": "1990-01-01T00:00:00Z",
"clientNumber": "shubhama",
"firstName": "Jane",
"lastName": "Wagner",
"accountNumber": "01010101325456",
"bankNumber": "010101013254",
"checkNumber": "22222",
"batchNumber": null,
"updatedGMT": "1990-01-01T00:00:00Z",
"masterSuspenseId": null,
"childSuspenses": [
{
"links": [
{
"href": "http://fsgbu-mum-743.snbomprshared1.gbucdsint02bom.oraclevcn.com:7009/PASService/rest/services/v1/suspenses/95B63F21-E86D-42AA-B2D0-FDEBF3F9E427",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
}
]
},
{
"links": [
{
"href": "http://fsgbu-mum-743.snbomprshared1.gbucdsint02bom.oraclevcn.com:7009/PASService/rest/services/v1/suspenses/EA61DC90-0302-4BC9-80D6-C829C344C544",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
}
]
}
],
"multifields": {
"ComboTestMF": [
{
"index": 0,
"ComboTest1": {
"textValue": "00",
"optionText": "No"
},
"ComboTest2": {
"textValue": "00",
"optionText": "No"
},
"ComboTest3": {
"textValue": "00",
"optionText": "No"
},
"ComboTest4": {
"textValue": "00",
"optionText": "No"
},
"ComboTest5": {
"textValue": "00",
"optionText": "No"
},
"ComboTest6": {
"textValue": "00",
"optionText": "No"
}
}
],
"TextTestMF": [
{
"index": 0,
"TextTest1": "Test"
}
],
"RadioTestMF": [
{
"index": 0,
"RadioTest2": {
"textValue": "00",
"optionText": "No"
},
"RadioTest1": {
"textValue": "00",
"optionText": "No"
},
"RadioTest4": {
"textValue": "00",
"optionText": "No"
},
"RadioTest3": {
"textValue": "00",
"optionText": "No"
}
}
],
"CheckTestMF": [
{
"index": 0,
"CheckboxTest2": "UNCHECKED",
"CheckboxTest1": "UNCHECKED",
"CheckboxTest4": "UNCHECKED",
"CheckboxTest3": "UNCHECKED"
}
]
},
"RadioTest": {
"textValue": "01",
"optionText": "Yes"
},
"ComboField": {
"textValue": "01",
"optionText": "Savings"
},
"TaxIDSource": {
"textValue": "01",
"optionText": "Application"
},
"LetterSendDate": "2001-01-01T00:00:00Z",
"TransactionField": "Best",
"TestField": "Test"
}
]
}