GET api/PayoutMethod/{PayoutMethodID}/Captions

Get caption for for a given Payoutmethod, that can be used to create Reps Payout profiles.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
PayoutMethodID

integer

Required

Body Parameters

None.

Response Information

Resource Description

Collection of PayoutMethodCaptionViewModel
NameDescriptionTypeAdditional information
DetailNumber

integer

None.

Caption

string

None.

Response Formats

application/xml, text/xml

Sample:
<ListOfPayoutMethodCaptionViewModel>
  <PayoutMethodCaptionViewModel>
    <DetailNumber>1</DetailNumber>
    <Caption>sample string 2</Caption>
  </PayoutMethodCaptionViewModel>
  <PayoutMethodCaptionViewModel>
    <DetailNumber>1</DetailNumber>
    <Caption>sample string 2</Caption>
  </PayoutMethodCaptionViewModel>
</ListOfPayoutMethodCaptionViewModel>

application/json, text/json

Sample:
[
  {
    "DetailNumber": 1,
    "Caption": "sample string 2"
  },
  {
    "DetailNumber": 1,
    "Caption": "sample string 2"
  }
]