Program Applications (GET, POST)
- Resource
-
1/connect/eu-program/applications - Example URI
-
1https://yourInstance.salesforce.com/services/data/67.0/connect/eu-program/applications - Available version
- 58.0
- HTTP methods
- GET, POST
- Request parameters for GET
-
Parameter Name Type Description Required or Optional Available Version accountId String Filters results by account ID. Optional 60.0 appName String Filters results by the client application name. Optional 60.0 enrolleeType String Filters applications by enrollee type. Optional 60.0 locationId String Filters results by location ID. Optional 60.0 offset Integer Skips this number of records before returning results. Optional 60.0 pageSize Integer Maximum number of records returned in one response. Optional 60.0 programId String Filters applications by program ID. Optional 60.0 shouldAggregateByStatus Boolean When true, includes counts grouped by application status. Optional 60.0 sortBy String Field used to sort returned applications. Optional 60.0 sortOrder String Sort direction, such as ascending or descending. Optional 60.0 status String Filters results by application status. Optional 60.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
-
Name Type Description Required or Optional Available Version accountId String A valid ID of an account. Required 58.0 applicationItems Program Application Item Input[] A list of application line items associated with the program. Required 58.0 description String Description of the application. Optional 58.0 files Program Application File Input[] A list of ContentDocument IDs. Optional 58.0 programId String A valid ID of a program. Required 58.0
- Response body for GET
- Program Individual Applications Response
- Response body for POST
- Program Application Output