POST Member/VerifyFamilyId

Request Information

URI Parameters

None.

Body Parameters

FamilyId
NameDescriptionTypeAdditional information
CompanyPBEntityKey

integer

Required

FamId

string

Required

String length: inclusive between 0 and 16

ExistingPBEntityKey

integer

None.

Status

FamilyIdStatus

None.

Request Formats

application/json, text/json

Sample:
{
  "CompanyPBEntityKey": 1,
  "FamId": "sample string 2",
  "ExistingPBEntityKey": 3,
  "Status": 0
}

application/xml, text/xml

Sample:
<FamilyId xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VHCSAPIModels.Models">
  <CompanyPBEntityKey>1</CompanyPBEntityKey>
  <ExistingPBEntityKey>3</ExistingPBEntityKey>
  <FamId>sample string 2</FamId>
  <Status>Valid</Status>
</FamilyId>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'FamilyId'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.