GET api/lockboxproviders/{providerId}/lockboxformats

This method will get all formats linked to a particular provider

Request Information

URI Parameters

NameDescriptionTypeAdditional information
providerId

The ProviderId to obtain formats for

integer

Required

Body Parameters

None.

Response Information

Resource Description

Collection of Formats

Collection of LockboxFormatViewModel
NameDescriptionTypeAdditional information
FormatId

The format identifier

integer

None.

FormatName

The format name

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "formatId": 1,
    "formatName": "sample string 2"
  },
  {
    "formatId": 1,
    "formatName": "sample string 2"
  }
]

application/xml, text/xml

Sample:
<ArrayOfLockboxFormatViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Lockbox">
  <LockboxFormatViewModel>
    <FormatId>1</FormatId>
    <FormatName>sample string 2</FormatName>
  </LockboxFormatViewModel>
  <LockboxFormatViewModel>
    <FormatId>1</FormatId>
    <FormatName>sample string 2</FormatName>
  </LockboxFormatViewModel>
</ArrayOfLockboxFormatViewModel>