| GET | /signup/api/nat/{nationalId}/group/{groupId}/templateType/{workflowTemplateTypeId}/key/{workflowCategoryKey}/type/{workflowTypeId}/revenue/{revenue}/subscription/{subscriptionInvoiceId}/years/{yearsOfService}/term/{termTypeId} |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| nationalId | path | int | No | |
| groupId | path | int? | No | |
| workflowTemplateTypeId | path | int | No | |
| workflowCategoryKey | path | string | No | |
| workflowTypeId | path | int | No | |
| revenue | path | string | No | |
| subscriptionInvoiceId | path | string | No | |
| yearsOfService | path | string | No | |
| termTypeId | path | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| workflowId | form | long | No | |
| isValid | form | bool | No | |
| hasServerError | form | bool | No | |
| hasClientError | form | bool | No | |
| hasWarningError | form | bool | No | |
| clientErrors | form | string | No | |
| warningErrors | form | string | No | |
| outputs | form | List<BhWorkflowOutputDto> | No | |
| components | form | List<BhWorkflowComponentDto> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| name | form | string | No | |
| value | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ComponentName | form | string | No | |
| HasServerError | form | bool | No | |
| HasClientError | form | bool | No | |
| HasWarningError | form | bool | No | |
| Warnings | form | List<string> | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /signup/api/nat/{nationalId}/group/{groupId}/templateType/{workflowTemplateTypeId}/key/{workflowCategoryKey}/type/{workflowTypeId}/revenue/{revenue}/subscription/{subscriptionInvoiceId}/years/{yearsOfService}/term/{termTypeId} HTTP/1.1
Host: devapi.billhighway.com
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
workflowId: 0,
isValid: False,
hasServerError: False,
hasClientError: False,
hasWarningError: False,
clientErrors: String,
warningErrors: String,
outputs:
[
{
name: String,
value: String
}
],
components:
[
{
ComponentName: String,
HasServerError: False,
HasClientError: False,
HasWarningError: False,
Warnings:
[
String
]
}
]
}