GET api/v{version}/PlanCodes/GetCustomerVisible?key={key}

Retrieves the customer visible plancodes.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
key

The key associated with the login.

string

Required

version

string

None.

Body Parameters

None.

Response Information

Resource Description

The customer visible plancodes

Collection of PlanCodeOutDTO
NameDescriptionTypeAdditional information
Code

string

None.

Color

string

None.

Description

string

None.

ExternalID

string

None.

NumberOfHours

decimal number

None.

OABCategoryId

integer

None.

PlanCodeID

integer

None.

Sequence

integer

None.

SpecializationID

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Code": "sample string 1",
    "Color": "sample string 2",
    "Description": "sample string 3",
    "ExternalID": "sample string 4",
    "NumberOfHours": 1.0,
    "OABCategoryId": 1,
    "PlanCodeID": 1,
    "Sequence": 1,
    "SpecializationID": 1
  },
  {
    "Code": "sample string 1",
    "Color": "sample string 2",
    "Description": "sample string 3",
    "ExternalID": "sample string 4",
    "NumberOfHours": 1.0,
    "OABCategoryId": 1,
    "PlanCodeID": 1,
    "Sequence": 1,
    "SpecializationID": 1
  }
]