Retrieve Entitlements

1min

GET
This endpoint will provide the ability to search for a set of entitlements against the account based on creation date, end date, entitlement Identifier, etc.
            

The following custom headers will be returned in the response of the API
            
X-totalNumberOfRecords
            
X-pageNumber
            
X-resultsPerPage
Authentication
Authorization
Bearer
Path Parameters
accountReference
string
*
Query Parameters
createDateMin
string
createDateMax
string
startDateMin
string
startDateMax
string
endDateMin
string
endDateMax
string
entitlementIdentifier
string
rowsPerPage
integer
currentPage
integer
exactMatch
boolean
displayInactive
boolean
Header Parameters
X-TokenId
string
X-SessionId
string
X-Version
string
*
Origin
string
Responses
200
OK
FictiveGlobal.Api.Rest.ApplicationLayer.Entities.Entitlement[]
Description
Entitlement details
name
string
identifier
string
startDate
string<date-time>
endDate
string<date-time>
204
No entitlements found
FictiveGlobal.Api.Rest.ApplicationLayer.Entities.Entitlement[]
Description
Entitlement details
name
string
identifier
string
startDate
string<date-time>
endDate
string<date-time>
400
Unable to authenticate using the provided session
401
Not Authorized
404
Account could not be found: Account cannot be found. Invalid UKI and PIN or Password.
500
Internal Server Error
﻿
﻿

🤔

Have a question?

Our super-smart AI, knowledgeable support team and an awesome community will get you an answer in a flash.

To ask a question or participate in discussions, you'll need to authenticate first.

﻿

Updated 02 Nov 2023

Did this page help you?

Releases a slot

Create an entitlement