GET api/GetProgramApplicationNumber?ProgramApplicationId={ProgramApplicationId}&LanguageId={LanguageId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
ProgramApplicationId

integer

Required

LanguageId

integer

Required

Body Parameters

None.

Response Information

Resource Description

ProgramApplicationConfirmationModel
NameDescriptionTypeAdditional information
ProgramApplicationId

integer

None.

BasisId

integer

None.

BasisMessageCodeId

integer

None.

BasisMessageCodeDescription

string

None.

EligibilityId

integer

None.

EligibilityMessageCodeId

integer

None.

EligibilityMessageCodeDescription

string

None.

ProgramApplicationNumber

string

None.

Image

Collection of byte

None.

IsFosHLessMigRAwyUnmatchedStudExists

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "ProgramApplicationId": 1,
  "BasisId": 1,
  "BasisMessageCodeId": 1,
  "BasisMessageCodeDescription": "sample string 1",
  "EligibilityId": 1,
  "EligibilityMessageCodeId": 1,
  "EligibilityMessageCodeDescription": "sample string 2",
  "ProgramApplicationNumber": "sample string 3",
  "Image": "QEA=",
  "IsFosHLessMigRAwyUnmatchedStudExists": true
}

application/xml, text/xml

Sample:
<ProgramApplicationConfirmationModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cybersoft.Primero.OnlineFRE.APIs.Models.ProgramApplication">
  <BasisId>1</BasisId>
  <BasisMessageCodeDescription>sample string 1</BasisMessageCodeDescription>
  <BasisMessageCodeId>1</BasisMessageCodeId>
  <EligibilityId>1</EligibilityId>
  <EligibilityMessageCodeDescription>sample string 2</EligibilityMessageCodeDescription>
  <EligibilityMessageCodeId>1</EligibilityMessageCodeId>
  <Image>QEA=</Image>
  <IsFosHLessMigRAwyUnmatchedStudExists>true</IsFosHLessMigRAwyUnmatchedStudExists>
  <ProgramApplicationId>1</ProgramApplicationId>
  <ProgramApplicationNumber>sample string 3</ProgramApplicationNumber>
</ProgramApplicationConfirmationModel>