Admin API (1.6.0)

APIs for InsuranceSuite administration objects

Create a new permission on this role

Create a new permission on this role (Since 1.4.0)

gw-childResourceType: RolePermission

gw-resourceType: RolePermissions

gw-sinceVersion: 1.4.0

Authorizations:

basicAuth

path Parameters

roleId

required

string

gw-sinceVersion: 1.4.0

The REST identifier for the role (Since 1.4.0)

query Parameters

fields

Array of strings

gw-allowForCompositeApi: true

Allows the caller to specify the set of fields that should be included on the response. This can be used to limit the set of fields returned as well as to include optional fields that otherwise wouldn't normally be returned. The parameter is either of the form fields=<field list> or fields=<include>:<field list>, where <field list> consists of a comma-separated list of field or field set names. See the documentation for more information.

Request Body schema: application/json

required	object (RolePermissionData)
	object (AdminInclusions)

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"permission": {"code": "string",
"name": "string"
}
},
"checksum": "string",
"id": "string",
"links": {"property1": {"href": "string",
"methods": ["string"
]
},
"property2": {"href": "string",
"methods": ["string"
]
}
},
"method": "post",
"refid": "string",
"related": {"property1": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
},
"property2": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
}
},
"uri": "string"
},
"included": {"PolicyHold": [{"attributes": {"createUser": {"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
},
"description": "string",
"endDate": "2019-08-24",
"holdType": {"code": "string",
"name": "string"
},
"policyHoldCode": "string",
"startDate": "2019-08-24",
"updateUser": {"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
},
"uwIssueLongDescription": "string",
"uwIssueType": {"code": "string",
"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
},
"checksum": "string",
"id": "string",
"links": {"property1": {"href": "string",
"methods": ["string"
]
},
"property2": {"href": "string",
"methods": ["string"
]
}
},
"method": "post",
"refid": "string",
"related": {"property1": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
},
"property2": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
}
},
"uri": "string"
}
],
"PolicyHoldRule": [{"attributes": {"coveragePattern": {"displayName": "string",
"id": "string",
"type": "string"
},
"jobDateType": {"code": "string",
"name": "string"
},
"jobType": {"code": "string",
"name": "string"
},
"policyLineType": {"code": "string",
"name": "string"
}
},
"checksum": "string",
"id": "string",
"links": {"property1": {"href": "string",
"methods": ["string"
]
},
"property2": {"href": "string",
"methods": ["string"
]
}
},
"method": "post",
"refid": "string",
"related": {"property1": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
},
"property2": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
}
},
"uri": "string"
}
],
"PolicyHoldZone": [{"attributes": {"country": {"code": "string",
"name": "string"
},
"geographicZone": {"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
},
"zoneType": {"code": "string",
"name": "string"
}
},
"checksum": "string",
"id": "string",
"links": {"property1": {"href": "string",
"methods": ["string"
]
},
"property2": {"href": "string",
"methods": ["string"
]
}
},
"method": "post",
"refid": "string",
"related": {"property1": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
},
"property2": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
}
},
"uri": "string"
}
],
"ProducerCode": [{"attributes": {"address": {"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"addressType": {"code": "string",
"name": "string"
},
"city": "string",
"country": "AE",
"description": "string",
"emirate": {"code": "string",
"name": "string"
},
"spatialPoint": {"latitude": "string",
"longitude": "string"
},
"validUntil": "2019-08-24T14:15:22Z"
},
"appointmentDate": "2019-08-24T14:15:22Z",
"branch": {"branchCode": "string",
"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
},
"code": "string",
"commissionPlans": [{"currency": {"code": "string",
"name": "string"
}
}
],
"description": "string",
"organization": {"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
},
"parent": {"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
},
"preferredUnderwriter": {"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
},
"producerStatus": {"code": "string",
"name": "string"
},
"roles": [{"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"terminationDate": "2019-08-24T14:15:22Z"
},
"checksum": "string",
"id": "string",
"links": {"property1": {"href": "string",
"methods": ["string"
]
},
"property2": {"href": "string",
"methods": ["string"
]
}
},
"method": "post",
"refid": "string",
"related": {"property1": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
},
"property2": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
}
},
"uri": "string"
}
],
"RolePermission": [{"attributes": {"permission": {"code": "string",
"name": "string"
}
},
"checksum": "string",
"id": "string",
"links": {"property1": {"href": "string",
"methods": ["string"
]
},
"property2": {"href": "string",
"methods": ["string"
]
}
},
"method": "post",
"refid": "string",
"related": {"property1": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
},
"property2": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
}
},
"uri": "string"
}
],
"UWAuthorityGrant": [{"attributes": {"approveAnyValue": true,
"comparator": {"code": "string",
"name": "string"
},
"decimalValue": "string",
"integerValue": "string",
"issueType": {"code": "string",
"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
},
"moneyValue": {"amount": "string",
"currency": "string"
},
"stateSetValue": {"inclusionType": "exclusive",
"states": ["string"
]
}
},
"checksum": "string",
"id": "string",
"links": {"property1": {"href": "string",
"methods": ["string"
]
},
"property2": {"href": "string",
"methods": ["string"
]
}
},
"method": "post",
"refid": "string",
"related": {"property1": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
},
"property2": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
}
},
"uri": "string"
}
],
"UserProducerCode": [{"attributes": {"producerCode": {"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
},
"checksum": "string",
"id": "string",
"links": {"property1": {"href": "string",
"methods": ["string"
]
},
"property2": {"href": "string",
"methods": ["string"
]
}
},
"method": "post",
"refid": "string",
"related": {"property1": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
},
"property2": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
}
},
"uri": "string"
}
]
}
}

Response samples

Content type

application/json

{"data": {"attributes": {"id": "string",
"permission": {"code": "string",
"name": "string"
}
},
"checksum": "string",
"id": "string",
"links": {"property1": {"href": "string",
"methods": ["string"
]
},
"property2": {"href": "string",
"methods": ["string"
]
}
},
"method": "post",
"refid": "string",
"related": {"property1": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
},
"property2": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
}
},
"type": "string",
"uri": "string"
},
"included": {"PolicyHold": [{"attributes": {"createTime": "2019-08-24T14:15:22Z",
"createUser": {"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
},
"description": "string",
"displayName": "string",
"endDate": "2019-08-24",
"holdType": {"code": "string",
"name": "string"
},
"id": "string",
"policyHoldCode": "string",
"startDate": "2019-08-24",
"updateTime": "2019-08-24T14:15:22Z",
"updateUser": {"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
},
"uwIssueLongDescription": "string",
"uwIssueType": {"code": "string",
"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
},
"checksum": "string",
"id": "string",
"links": {"property1": {"href": "string",
"methods": ["string"
]
},
"property2": {"href": "string",
"methods": ["string"
]
}
},
"method": "post",
"refid": "string",
"related": {"property1": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
},
"property2": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
}
},
"type": "string",
"uri": "string"
}
],
"PolicyHoldRule": [{"attributes": {"coveragePattern": {"displayName": "string",
"id": "string",
"type": "string"
},
"id": "string",
"jobDateType": {"code": "string",
"name": "string"
},
"jobType": {"code": "string",
"name": "string"
},
"policyLineType": {"code": "string",
"name": "string"
}
},
"checksum": "string",
"id": "string",
"links": {"property1": {"href": "string",
"methods": ["string"
]
},
"property2": {"href": "string",
"methods": ["string"
]
}
},
"method": "post",
"refid": "string",
"related": {"property1": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
},
"property2": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
}
},
"type": "string",
"uri": "string"
}
],
"PolicyHoldZone": [{"attributes": {"code": "string",
"country": {"code": "string",
"name": "string"
},
"geographicZone": {"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
},
"id": "string",
"zoneType": {"code": "string",
"name": "string"
}
},
"checksum": "string",
"id": "string",
"links": {"property1": {"href": "string",
"methods": ["string"
]
},
"property2": {"href": "string",
"methods": ["string"
]
}
},
"method": "post",
"refid": "string",
"related": {"property1": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
},
"property2": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
}
},
"type": "string",
"uri": "string"
}
],
"ProducerCode": [{"attributes": {"address": {"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"addressType": {"code": "string",
"name": "string"
},
"city": "string",
"country": "AE",
"description": "string",
"displayName": "string",
"emirate": {"code": "string",
"name": "string"
},
"id": "string",
"spatialPoint": {"latitude": "string",
"longitude": "string"
},
"validUntil": "2019-08-24T14:15:22Z"
},
"appointmentDate": "2019-08-24T14:15:22Z",
"branch": {"branchCode": "string",
"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
},
"code": "string",
"commissionPlans": [{"commissionPlanId": "string",
"currency": {"code": "string",
"name": "string"
}
}
],
"description": "string",
"displayName": "string",
"id": "string",
"organization": {"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
},
"parent": {"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
},
"preferredUnderwriter": {"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
},
"producerStatus": {"code": "string",
"name": "string"
},
"roles": [{"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"terminationDate": "2019-08-24T14:15:22Z"
},
"checksum": "string",
"id": "string",
"links": {"property1": {"href": "string",
"methods": ["string"
]
},
"property2": {"href": "string",
"methods": ["string"
]
}
},
"method": "post",
"refid": "string",
"related": {"property1": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
},
"property2": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
}
},
"type": "string",
"uri": "string"
}
],
"RolePermission": [{"attributes": {"id": "string",
"permission": {"code": "string",
"name": "string"
}
},
"checksum": "string",
"id": "string",
"links": {"property1": {"href": "string",
"methods": ["string"
]
},
"property2": {"href": "string",
"methods": ["string"
]
}
},
"method": "post",
"refid": "string",
"related": {"property1": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
},
"property2": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
}
},
"type": "string",
"uri": "string"
}
],
"UWAuthorityGrant": [{"attributes": {"approveAnyValue": true,
"comparator": {"code": "string",
"name": "string"
},
"decimalValue": "string",
"id": "string",
"integerValue": "string",
"issueType": {"code": "string",
"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
},
"moneyValue": {"amount": "string",
"currency": "string"
},
"stateSetValue": {"inclusionType": "exclusive",
"states": ["string"
]
},
"valueType": "string"
},
"checksum": "string",
"id": "string",
"links": {"property1": {"href": "string",
"methods": ["string"
]
},
"property2": {"href": "string",
"methods": ["string"
]
}
},
"method": "post",
"refid": "string",
"related": {"property1": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
},
"property2": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
}
},
"type": "string",
"uri": "string"
}
],
"UserProducerCode": [{"attributes": {"id": "string",
"producerCode": {"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
},
"roles": [{"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
]
},
"checksum": "string",
"id": "string",
"links": {"property1": {"href": "string",
"methods": ["string"
]
},
"property2": {"href": "string",
"methods": ["string"
]
}
},
"method": "post",
"refid": "string",
"related": {"property1": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
},
"property2": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
}
},
"type": "string",
"uri": "string"
}
]
}
}

Was this page helpful?