Program Applications (GET, POST)

Get individual program applications or submit a new program application through this resource.

Resource 

1/connect/eu-program/applications

Resource Example 

1https://YOUR_INSTANCE.salesforce.com/services/data/68.0/connect/eu-program/applications

Where YOUR_INSTANCE is a variable.

Available Version 

58.0

HTTP Methods 

GET, POST

Request Parameters for GET 

Parameter NameTypeDescriptionRequired or OptionalAvailable Version
accountIdStringFilters results by account ID.Optional60.0
appNameStringFilters results by the client application name.Optional60.0
enrolleeTypeStringFilters applications by enrollee type.Optional60.0
locationIdStringFilters results by location ID.Optional60.0
offsetIntegerSkips this number of records before returning results.Optional60.0
pageSizeIntegerMaximum number of records returned in one response.Optional60.0
programIdStringFilters applications by program ID.Optional60.0
shouldAggregateByStatusBooleanWhen true, includes counts grouped by application status.Optional60.0
sortByStringField used to sort returned applications.Optional60.0
sortOrderStringSort direction, such as ascending or descending.Optional60.0
statusStringFilters results by application status.Optional60.0

Request Body for POST 

JSON Example 

1{
2  "programId": "11Wxx0000004GkaEAE",
3  "accountId": "001xx000003GlBHAA0",
4  "description": "Individual Application created for Program EV Charger Rebate",
5  "applicationItems": {
6    "records": [
7      {
8        "programProductId": "11mxx0000004PROAA2"
9      }
10    ]
11  },
12  "files": {
13    "records": [
14      {
15        "contentDocumentId": "069xx0000004DWWAA2"
16      }
17    ]
18  }
19}

Properties 

NameTypeDescriptionRequired or OptionalAvailable Version
accountIdStringA valid ID of an account.Required58.0
applicationItemsProgram Application Item Input[]A list of application line items associated with the program.Required58.0
descriptionStringDescription of the application.Optional58.0
filesProgram Application File Input[]A list of ContentDocument IDs.Optional58.0
programIdStringA valid ID of a program.Required58.0

Response Body for GET 

Program Individual Applications Response

Response Body for POST 

Program Application Output