ConnectionDto
A connection between two CIS Manager tenants (an "Interlink"), seen from the viewing tenant's side. A
subcontractor tenant initiates it for one of its contractor contacts, sharing its CIS details with the email
address it gives; the contractor accepts it by creating (or naming) its own contact for the subcontractor.
direction is relative to the viewer: Out means the viewer is the subcontractor that shared its details, In
means the viewer is the contractor they were sent to.
Properties
| Name | Type | Description |
|---|---|---|
| code* | string | The connection's identifier, shared by both sides |
The connection's identifier, shared by both sides | ||
| direction* | enum | The viewer's side: Out = the subcontractor that shared its details, In = the contractor they were sent to |
The viewer's side: Out = the subcontractor that shared its details, In = the contractor they were sent to | ||
| initiatedByMe* | boolean | Whether the viewing tenant initiated the connection |
Whether the viewing tenant initiated the connection | ||
| status* | enum | Pending, Connected or Rejected |
Pending, Connected or Rejected | ||
| contact | string | The viewer's contact for the other party (code); null on the receiving side until accepted |
The viewer's contact for the other party (code); null on the receiving side until accepted | ||
| counterPartyEmail | string | The other party's email address: the one the initiator gave, or the initiating tenant's own |
The other party's email address: the one the initiator gave, or the initiating tenant's own | ||
| counterParty | ConnectionPartyDto | The other party as far as it is known: on a connection sent to the viewer, the initiating tenant's details and |
The other party as far as it is known: on a connection sent to the viewer, the initiating tenant's details and | ||
| matchedToUser* | boolean | Whether the other party was matched to a CIS Manager user by email (rather than, or as well as, to a tenant) |
Whether the other party was matched to a CIS Manager user by email (rather than, or as well as, to a tenant) | ||
| createdDate* | string | When the connection was initiated |
When the connection was initiated | ||
| updatedDate | string | When it last changed |
When it last changed | ||
JSON Example
{
"code": "00000000-0000-0000-0000-000000000000",
"direction": "In",
"initiatedByMe": false,
"status": "Pending",
"contact": "string",
"matchedToUser": false,
"createdDate": "2024-01-01T00:00:00Z"
}