POST api/program/form

Back to API Documentation

Host and Post partners can use this method to get back the field names and Types for a program. The list of possible input type property values are "Text Box","Text Area","Radio Buttons","Multi Check Box List","Drop-Down","Label","Check Box","Date", and "Hidden"

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type
APIKey	Required \| Partner Credentials. This value will be provided by the EDDY Account Management team.	globally unique identifier
ProgramId	Required \| Program Id.	integer

Request Format

Conten-Type: application/json

            {
                 "APIKey": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                 "ProgramId": "7243"
            }

Response Information

Output

        {
                "IsSuccessful": true,
                "Body": {
                    "Fields": [
                         {
                             "Label": "GPA for highest level of education",
                             "Name": "GPA",
                             "Rules": [
                                         {
                                             "RuleName": "GPA 3.0 Minimum",
                                             "RuleValue": 3,
                                             "FieldName": "GPA"
                                         }
                                     ],
                             "InputType": "Drop-Down",
                             "FormTemplateFieldOptions": [
                                             {
                                                 "OptionValue": "Less than 2.0",
                                                 "OptionText": "Less than 2.0",
                                             },
                                             {
                                                 "OptionValue": "2.0-2.4",
                                                 "OptionText": "2.0-2.4",
                                             },
                                             {
                                                 "OptionValue": "2.5-2.74",
                                                 "OptionText": "2.5-2.74",
                                             },
                                             {
                                                 "OptionValue": "2.75-2.9",
                                                 "OptionText": "2.75-2.9",
                                             },
                                             {
                                                 "OptionValue": "3.0-3.4",
                                                 "OptionText": "3.0-3.4",
                                             },
                                             {
                                                "OptionValue": "3.5 or Higher",
                                                "OptionText": "3.5 or Higher",
                                             }
                                         ]
                      }
                    ]
                },
                "ResponseDateTime": "2017-03-15T16:46:22.8626779-04:00",
                "RequestDateTime": "2017-03-15T16:46:05.19354-04:00",
                "ResponseGuid": "5abfb29d-9ea4-4a88-a147-28edd6177fd4",
                "Messages": [
                    {
                        "MessageCode": "msg0038",
                        "Message": "Validation Passed."
                    }
                ],
                "TotalResponseTime": 676
            }