GET api/Entitlement/Types

Get entitlement types list by user login.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

List of EntitlementTypeDTO

Collection of EntitlementTypeDTO

Name	Type	Additional information
EntitlementTypeCode	string	None.
EntitlementTypeName	string	None.
IsDocumentRequired	boolean	None.
StartDate	date	None.
EndDate	date	None.
IsBalanceCheckRequired	boolean	None.
IsNegativeBalancePermitted	boolean	None.
EntitlementBalance	decimal number	None.
EntitlementUOM	string	None.
EntitlementDailyLimit	decimal number	None.
IsHideProjection	boolean	None.
IsPayrollUseOnly	boolean	None.
Disclaimer	string	None.
IsDisplayBalance	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "EntitlementTypeCode": "sample string 1",
    "EntitlementTypeName": "sample string 2",
    "IsDocumentRequired": true,
    "StartDate": "2024-06-29T07:28:47.3190603+10:00",
    "EndDate": "2024-06-29T07:28:47.3190603+10:00",
    "IsBalanceCheckRequired": true,
    "IsNegativeBalancePermitted": true,
    "EntitlementBalance": 6.0,
    "EntitlementUOM": "sample string 7",
    "EntitlementDailyLimit": 8.0,
    "IsHideProjection": true,
    "IsPayrollUseOnly": true,
    "Disclaimer": "sample string 11",
    "IsDisplayBalance": true
  },
  {
    "EntitlementTypeCode": "sample string 1",
    "EntitlementTypeName": "sample string 2",
    "IsDocumentRequired": true,
    "StartDate": "2024-06-29T07:28:47.3190603+10:00",
    "EndDate": "2024-06-29T07:28:47.3190603+10:00",
    "IsBalanceCheckRequired": true,
    "IsNegativeBalancePermitted": true,
    "EntitlementBalance": 6.0,
    "EntitlementUOM": "sample string 7",
    "EntitlementDailyLimit": 8.0,
    "IsHideProjection": true,
    "IsPayrollUseOnly": true,
    "Disclaimer": "sample string 11",
    "IsDisplayBalance": true
  }
]

text/xml

Sample:

<ArrayOfEntitlementTypeDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RandstadWebAPI.Models.DTO">
  <EntitlementTypeDTO>
    <Disclaimer>sample string 11</Disclaimer>
    <EndDate>2024-06-29T07:28:47.3190603+10:00</EndDate>
    <EntitlementBalance>6</EntitlementBalance>
    <EntitlementDailyLimit>8</EntitlementDailyLimit>
    <EntitlementTypeCode>sample string 1</EntitlementTypeCode>
    <EntitlementTypeName>sample string 2</EntitlementTypeName>
    <EntitlementUOM>sample string 7</EntitlementUOM>
    <IsBalanceCheckRequired>true</IsBalanceCheckRequired>
    <IsDisplayBalance>true</IsDisplayBalance>
    <IsDocumentRequired>true</IsDocumentRequired>
    <IsHideProjection>true</IsHideProjection>
    <IsNegativeBalancePermitted>true</IsNegativeBalancePermitted>
    <IsPayrollUseOnly>true</IsPayrollUseOnly>
    <StartDate>2024-06-29T07:28:47.3190603+10:00</StartDate>
  </EntitlementTypeDTO>
  <EntitlementTypeDTO>
    <Disclaimer>sample string 11</Disclaimer>
    <EndDate>2024-06-29T07:28:47.3190603+10:00</EndDate>
    <EntitlementBalance>6</EntitlementBalance>
    <EntitlementDailyLimit>8</EntitlementDailyLimit>
    <EntitlementTypeCode>sample string 1</EntitlementTypeCode>
    <EntitlementTypeName>sample string 2</EntitlementTypeName>
    <EntitlementUOM>sample string 7</EntitlementUOM>
    <IsBalanceCheckRequired>true</IsBalanceCheckRequired>
    <IsDisplayBalance>true</IsDisplayBalance>
    <IsDocumentRequired>true</IsDocumentRequired>
    <IsHideProjection>true</IsHideProjection>
    <IsNegativeBalancePermitted>true</IsNegativeBalancePermitted>
    <IsPayrollUseOnly>true</IsPayrollUseOnly>
    <StartDate>2024-06-29T07:28:47.3190603+10:00</StartDate>
  </EntitlementTypeDTO>
</ArrayOfEntitlementTypeDTO>

multipart/form-data

Sample:

<ArrayOfEntitlementTypeDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RandstadWebAPI.Models.DTO"><EntitlementTypeDTO><Disclaimer>sample string 11</Disclaimer><EndDate>2024-06-29T07:28:47.3190603+10:00</EndDate><EntitlementBalance>6</EntitlementBalance><EntitlementDailyLimit>8</EntitlementDailyLimit><EntitlementTypeCode>sample string 1</EntitlementTypeCode><EntitlementTypeName>sample string 2</EntitlementTypeName><EntitlementUOM>sample string 7</EntitlementUOM><IsBalanceCheckRequired>true</IsBalanceCheckRequired><IsDisplayBalance>true</IsDisplayBalance><IsDocumentRequired>true</IsDocumentRequired><IsHideProjection>true</IsHideProjection><IsNegativeBalancePermitted>true</IsNegativeBalancePermitted><IsPayrollUseOnly>true</IsPayrollUseOnly><StartDate>2024-06-29T07:28:47.3190603+10:00</StartDate></EntitlementTypeDTO><EntitlementTypeDTO><Disclaimer>sample string 11</Disclaimer><EndDate>2024-06-29T07:28:47.3190603+10:00</EndDate><EntitlementBalance>6</EntitlementBalance><EntitlementDailyLimit>8</EntitlementDailyLimit><EntitlementTypeCode>sample string 1</EntitlementTypeCode><EntitlementTypeName>sample string 2</EntitlementTypeName><EntitlementUOM>sample string 7</EntitlementUOM><IsBalanceCheckRequired>true</IsBalanceCheckRequired><IsDisplayBalance>true</IsDisplayBalance><IsDocumentRequired>true</IsDocumentRequired><IsHideProjection>true</IsHideProjection><IsNegativeBalancePermitted>true</IsNegativeBalancePermitted><IsPayrollUseOnly>true</IsPayrollUseOnly><StartDate>2024-06-29T07:28:47.3190603+10:00</StartDate></EntitlementTypeDTO></ArrayOfEntitlementTypeDTO>