IncidentContactLinker APIs
-
Import
Description: import 3rd party data into the pending authorization listUsage:
POST api/Incidents/Data/ContactLinker/Import/{PropertyGuid}
Parameter Type Source Description PropertyGuid String FromUri The unique identifier of the property the entity is authorized for ContactData EntityAuthorizationImport[] FromBody array of 3rd party contact data to place on the authorization pending list Returns:
0 on success
Examples:
//-- Currently no examples for XML --//
-
List All
Description: Returns a list of all entities both authorized and those pending authorization for the given property.Usage:
GET api/Incidents/Data/ContactLinker/List/{PropertyGuid}
Parameter Type Source Description PropertyGuid String FromUri The unique identifier of the property to return both authorized and pending authorization entities for Returns:
List of Entity Authorization Records
Examples:
//-- Currently no examples for XML --//
-
Authorization Count
Description: Returns count of entities currently authorized for the given propertyUsage:
GET api/Incidents/Data/ContactLinker/Authorized/Count/{PropertyGuid}
Parameter Type Source Description PropertyGuid String FromUri The unique identifier of the property to return a count of completed authorizations for Returns:
number of entities authorized
Examples:
//-- Currently no examples for XML --//
-
List Authorized
Description: Returns a list of entities currently authorized for the given propertyUsage:
GET api/Incidents/Data/ContactLinker/Authorized/{PropertyGuid}
Parameter Type Source Description PropertyGuid String FromUri The unique identifier of the property to return authorized entities for Returns:
List of Entity Authorization Records
Examples:
//-- Currently no examples for XML --//
-
Pending Authorization Count
Description: Returns a count of entities still pending authorizationUsage:
GET api/Incidents/Data/ContactLinker/Unauthorized/Count/{PropertyGuid}
Parameter Type Source Description PropertyGuid String FromUri The unique identifier of the property to return pending authorizations count for Returns:
number of entities still pending authorization
Examples:
//-- Currently no examples for XML --//
-
List Pending Authorization
Description: Returns a list of entities still pending authorization for the given propertyUsage:
GET api/Incidents/Data/ContactLinker/Unauthorized/{PropertyGuid}
Parameter Type Source Description PropertyGuid String FromUri The unique identifier of the property to return list of entities pending authorization for Returns:
List of Entity Authorization Records
Examples:
//-- Currently no examples for XML --//
-
Delete Authorization
Description: deletes the entity authorization using the vendor provided unique id for the contactUsage:
DELETE api/Incidents/Data/ContactLinker/Authorization/Delete/ByVendorId/{PropertyGuid}/{ISVEntityId}
Parameter Type Source Description PropertyGuid String FromUri The unique identifier of the property the entity is authorized for ISVEntityId String FromUri The vendor provided unique id for the entity Returns:
0 on success
Examples:
//-- Currently no examples for XML --//
-
Delete Authorization
Description: deletes the entity authorization using the entity guid for the contactUsage:
DELETE api/Incidents/Data/ContactLinker/Authorization/Delete/{PropertyGuid}/{EntityGuid}
Parameter Type Source Description PropertyGuid String FromUri The unique identifier of the property the entity is authorized for EntityGuid String FromUri The unique identifier of the contact Returns:
0 on success
Examples:
//-- Currently no examples for XML --//
-
Assign List
Description: Assigns an authorized entity to a contact list. This is primarily used to associate the entity with the trigger access list.Usage:
POST api/Incidents/Data/ContactLinker/List/Assign/{PropertyGuid}/{ListCode}/{EntityGuid}
Parameter Type Source Description PropertyGuid String FromUri The unique identifier of the property the entity is authorized for ListCode Int32 FromUri The unique numerical code of the list to add the entity to EntityGuid String FromUri The unique identifier of the entity to unassign Returns:
0 on success
Examples:
//-- Currently no examples for XML --//
-
Unassign List
Description: removes an authorized entity from a contact listUsage:
DELETE api/Incidents/Data/ContactLinker/List/Unassign/{PropertyGuid}/{ListCode}/{EntityGuid}
Parameter Type Source Description PropertyGuid String FromUri The unique identifier of the property the entity is authorized for ListCode Int32 FromUri The unique numerical code of the list to remove the entity from EntityGuid String FromUri The unique identifier of the entity to unassign Returns:
0 on success
Examples:
//-- Currently no examples for XML --//