Get Entitlements

Get state and product entitlements based on given username.

Securityoauth2
Request
Request Body schema:
code
string or null

Indicates code

id
integer <int32>

Indicates Unique Identifier

Array of objects or null (VAM.DealFoundry.Services.Entities.SearchParameter)

Indicates search parameters

sortParameter
string or null

Indicates sorting parameter.

sortDirection
string or null

Indicates ascending or descending direction

startsWith
string or null

Indicates name that starts with

isLikeSearch
boolean

Set to True for LikeSearch

userName
string or null

Indicate name of the user

policyNumber
string or null

Indiactes policy number

lob
string or null

Indicates line of business

effectiveDate
string <date-time>

Indicates effective date

expiryDate
string <date-time>

Indicates expiry date

customerAccountName
string or null

Indicates Customer account name

state
string or null

Indicates name if state

pageIndex
integer <int32>

Indicates the specific Page

pageSize
integer <int32>

Indicates the page size.

startWith
string or null

Indicates starts with character for filtering.

totalRecords
integer <int32>

Indiactes total number of records

currentDate
string <date-time>

Indicates current date

Responses
200

Success

401

Unauthorized

403

Forbidden

post/api/v1/entitlements/Get
Request samples
{
  • "code": "string",
  • "id": 0,
  • "searchParameters": [
    ],
  • "sortParameter": "string",
  • "sortDirection": "string",
  • "startsWith": "string",
  • "isLikeSearch": true,
  • "userName": "string",
  • "policyNumber": "string",
  • "lob": "string",
  • "effectiveDate": "2019-08-24T14:15:22Z",
  • "expiryDate": "2019-08-24T14:15:22Z",
  • "customerAccountName": "string",
  • "state": "string",
  • "pageIndex": 0,
  • "pageSize": 0,
  • "startWith": "string",
  • "totalRecords": 0,
  • "currentDate": "2019-08-24T14:15:22Z"
}
Response samples
No sample