1. Documentation
2. API
3. Forms
4. Test Submit

Test Submitting Forms

Create a test Authorization as if it were submitted using a Form.

HTTP Request

POST https://utilityapi.com/api/v2/forms/form_uid/test-submit

Examples

# Submit a demo authorization
curl -X POST -H 'Authorization: Bearer API_TOKEN_HERE' \
    -d '{"utility": "DEMO", "scenario": "residential"}' \
    'https://utilityapi.com/api/v2/forms/1234/test-submit'

# Submit a commercial demo authorization
curl -X POST -H 'Authorization: Bearer API_TOKEN_HERE' \
    -d '{"utility": "PG&E", "scenario": "commercial"}' \
    'https://utilityapi.com/api/v2/forms/1234/test-submit'

# Submit an authorization with an invalid login
curl -X POST -H 'Authorization: Bearer API_TOKEN_HERE' \
    -d '{"utility": "SDG&E", "scenario": "badlogin"}' \
    'https://utilityapi.com/api/v2/forms/1234/test-submit'

POST Body

The request body must be a valid JSON object. Below are the parameters that must be included.

Test Scenarios

All utilities have some basic demonstration scenarios, which are listed below. Some utilities also have additional test scenarios to help you handle more scenarios gracefully.

Utility-Specific Test Scenarios

Certain utilities have scenarios to demonstrate behavior unique to that utility.

Response

Returns a created Referral object. You can use the referral code to look up the authorization in GET /authorizations.

// Example response
{
    "referral": "12345-56789"
}

Referral Object

This is the object that contains a referral code that you can use to look up the created Authorizations with this test-submit. We return a referral code for the test-submit endpoint because that is the code you would get in the query parameters of your url redirect if someone were to submit an authorization through this authorization form.

// Example Referral object
{
    "referral": "12345-56789"
}

HTTP Response Codes