GET PlanCare2Api/Contracts/ContractTypes

Fetches the available contract types. A contract type is only supported when licenses for the corresponding module are available.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

List of />s

Collection of ContractType
NameDescriptionTypeAdditional information
Id

Id of the contract type

integer

None.

Code

Code of the contract type

string

None.

Description

Description of the contract type

string

None.

IsActive

Is the contract type active

boolean

None.

Source

Source of the contract type

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "$id": "1",
    "Id": 1,
    "Code": "sample string 2",
    "Description": "sample string 3",
    "IsActive": true,
    "Source": "sample string 5"
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:
<ArrayOfContractType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface">
  <ContractType>
    <Code>sample string 2</Code>
    <Description>sample string 3</Description>
    <Id>1</Id>
    <IsActive>true</IsActive>
    <Source>sample string 5</Source>
  </ContractType>
  <ContractType>
    <Code>sample string 2</Code>
    <Description>sample string 3</Description>
    <Id>1</Id>
    <IsActive>true</IsActive>
    <Source>sample string 5</Source>
  </ContractType>
</ArrayOfContractType>