GET api/credithistorycodes?onlyActive={onlyActive}

GET: api/credithistorycodes

Request Information

URI Parameters

Name	Description	Type	Additional information
onlyActive		boolean	Default value is True

Body Parameters

None.

Response Information

Resource Description

Collection of CreditHistoryCodeViewModel

Name	Description	Type	Additional information
CreditHistoryCodeId	CreditHistoryCodeId	integer	None.
ReadableCreditHistoryCode	ReadableCreditHistoryCode	string	None.
Description	Description	string	None.
Active	Active	integer	None.
ChOrder	ChOrder	integer	None.
IsCollectionsAgentRequired	IsCollectionsAgentRequired	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "creditHistoryCodeId": 1,
    "readableCreditHistoryCode": "sample string 2",
    "description": "sample string 3",
    "active": 4,
    "chOrder": 1,
    "isCollectionsAgentRequired": true
  },
  {
    "creditHistoryCodeId": 1,
    "readableCreditHistoryCode": "sample string 2",
    "description": "sample string 3",
    "active": 4,
    "chOrder": 1,
    "isCollectionsAgentRequired": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfCreditHistoryCodeViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <CreditHistoryCodeViewModel>
    <Active>4</Active>
    <ChOrder>1</ChOrder>
    <CreditHistoryCodeId>1</CreditHistoryCodeId>
    <Description>sample string 3</Description>
    <IsCollectionsAgentRequired>true</IsCollectionsAgentRequired>
    <ReadableCreditHistoryCode>sample string 2</ReadableCreditHistoryCode>
  </CreditHistoryCodeViewModel>
  <CreditHistoryCodeViewModel>
    <Active>4</Active>
    <ChOrder>1</ChOrder>
    <CreditHistoryCodeId>1</CreditHistoryCodeId>
    <Description>sample string 3</Description>
    <IsCollectionsAgentRequired>true</IsCollectionsAgentRequired>
    <ReadableCreditHistoryCode>sample string 2</ReadableCreditHistoryCode>
  </CreditHistoryCodeViewModel>
</ArrayOfCreditHistoryCodeViewModel>