createGroup
post
createGroup
Resource URL
https://api-sandbox.arity.com/drivinginsights/v1/orgs/{orgId}/groups
Header Parameters
| Name | Values | Description |
|---|---|---|
| Content-Type |
|
|
|
Authorization
(required) |
Value should be the word Bearer followed by a space and then the token (e.g., Bearer CW8abh5JkxZ5KYdAQQH0p9fTAicq). To generate a token, use the OAuth API. |
Request Body
{{"modelName": "",
"userIds": [ ""],
"groupId": "",
"stateId": "",
"policyInceptionDate": "",
"policyEndDate": "",
"policyTermLength": ""
}
orgId Unique ID for the organization, provided by Arity. null true
Make a request and see the response.
Make a request and see the response.
Make a request and see the response.
Response Error Details
-
HTTP CodeError CodeDescription
-
400400
400.05.102 - User is not registered to a scoring product
400.05.106 - User's registration status is inactive
400.05.202 - Group must have a valid model name
400.05.203 - Group id not provided
400.05.204 - State not found
400.05.205 - Policy inception date or end date is invalid. Please provide date as 'YYYYMMDD'
400.05.206 - Group already exists
400.05.207 - Please enter a valid policy term length with a number from 1 - 12
400.05.208 - Please provide policy inception date, end date and term length
400.05.209 - Group Id should not exceed 49 characters
400.05.210 - Max number of users (15) has been reached for this group. -
404404
404.05.101 - User not found
-
503503
503.05.103 - Unable to validate user with the registration service. Please try again
503.05.901 - Service is currently under maintenance
Resource Summary |
|
|
Security |
None |
|
Category |
group-controller |
| Name | Type | Description |
|---|---|---|
| modelName | string | Name of the scoring model being used. Provided by Arity. |
| userIds | array | Array of userIds |
| groupId | string | Unique ID of the group. |
| stateId | string | Valid abbreviation of the state (optional). |
| policyInceptionDate | string | Policy start date (optional). |
| policyEndDate | string | Policy end date (optional). |
| policyTermLength | string | Duration of the policy, for example 'six months' or 'one year' (optional). |
| Name | Type | Description |
|---|---|---|
| data .groupId | string | Unique ID of the group. |
| data .modelName | string | Name of the scoring model being used. Provided by Arity. |
| data .orgId | string | Unique ID of the organization. Provided by Arity. |
| data .userIds | array | Array of userIds |
| data .stateId | string | Valid abbreviation of the state. |
| data .policyInceptionDate | string | Policy start date. |
| data .policyEndDate | string | Policy end date. |
| data .policyTermLength | string | Duration of the policy, for example 'six months' or 'one year'. |
Working...