Centriq IncidentRegister Api
Centriq's Incident register api provides a common interface for third party applications to interact with the incident register.
Version: v1
OAUTH 2.0 Access
Example data
Content-Type: application/json
{
"username" : "user@org.co.za",
"password" : "pass",
"client_id" : "00000000-0000-0000-0000-000000000000",
"client_secret" : "xxxxxxxxxxxxxxx.portal.incidentApi.co.za"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/json
Responses
200
OK
[ Jump to Models ]
Table of Contents
Up
get /api/clients/{clientId}
Gets Client by id (getClientById)
Path parameters
clientId (required)
Path Parameter — format: uuid
Return type
Example data
Content-Type: application/json
{
"clientName" : "clientName",
"clientCode" : "clientCode",
"id" : "00000000-0000-0000-0000-000000000000"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/json
Responses
200
OK
Client
Up
get /api/clients/{clientId}/rejections
Gets all rejections for the given client (getClientRejections)
Path parameters
clientId (required)
Path Parameter — The id of the client format: uuid
Return type
Example data
Content-Type: application/json
[ {
"claimNo" : "claimNo",
"businessClassId" : 3,
"incidentNo" : "incidentNo",
"rejectionAmount" : 6.027456183070403,
"documents" : [ {
"extension" : "extension",
"updatedBy" : "updatedBy",
"createdBy" : "createdBy",
"contents" : "contents",
"id" : 0,
"documentName" : "documentName",
"createdOn" : "2000-01-23T04:56:07.000+00:00",
"updateOn" : "2000-01-23T04:56:07.000+00:00"
}, {
"extension" : "extension",
"updatedBy" : "updatedBy",
"createdBy" : "createdBy",
"contents" : "contents",
"id" : 0,
"documentName" : "documentName",
"createdOn" : "2000-01-23T04:56:07.000+00:00",
"updateOn" : "2000-01-23T04:56:07.000+00:00"
} ],
"processLink" : "processLink",
"policyNo" : "policyNo",
"policyTypeId" : 4,
"policyInceptionDate" : "2000-01-23T04:56:07.000+00:00",
"modifiedOn" : "2000-01-23T04:56:07.000+00:00",
"capturedOn" : "2000-01-23T04:56:07.000+00:00",
"businessSubClassId" : 2,
"receivedOn" : "2000-01-23T04:56:07.000+00:00",
"partyName" : "partyName",
"incidentTypeId" : 5,
"modifiedBy" : "modifiedBy",
"id" : 5,
"incidentStatusId" : 2,
"capturedBy" : "capturedBy",
"zeroRejectionAmountReason" : "zeroRejectionAmountReason",
"clientId" : "00000000-0000-0000-0000-000000000000",
"dateOfLoss" : "2000-01-23T04:56:07.000+00:00",
"rejectionLetterSent" : true,
"numberOfMonths" : 1,
"claimPaid" : true,
"incidentSubStatusId" : 7,
"rejectionReasonId" : 0,
"businessTypeId" : 7,
"partyEmail" : "partyEmail",
"incidentSourceId" : 9,
"rejectedOn" : "2000-01-23T04:56:07.000+00:00",
"settlementAmount" : 1.2315135367772556,
"incidentDescription" : "incidentDescription"
}, {
"claimNo" : "claimNo",
"businessClassId" : 3,
"incidentNo" : "incidentNo",
"rejectionAmount" : 6.027456183070403,
"documents" : [ {
"extension" : "extension",
"updatedBy" : "updatedBy",
"createdBy" : "createdBy",
"contents" : "contents",
"id" : 0,
"documentName" : "documentName",
"createdOn" : "2000-01-23T04:56:07.000+00:00",
"updateOn" : "2000-01-23T04:56:07.000+00:00"
}, {
"extension" : "extension",
"updatedBy" : "updatedBy",
"createdBy" : "createdBy",
"contents" : "contents",
"id" : 0,
"documentName" : "documentName",
"createdOn" : "2000-01-23T04:56:07.000+00:00",
"updateOn" : "2000-01-23T04:56:07.000+00:00"
} ],
"processLink" : "processLink",
"policyNo" : "policyNo",
"policyTypeId" : 4,
"policyInceptionDate" : "2000-01-23T04:56:07.000+00:00",
"modifiedOn" : "2000-01-23T04:56:07.000+00:00",
"capturedOn" : "2000-01-23T04:56:07.000+00:00",
"businessSubClassId" : 2,
"receivedOn" : "2000-01-23T04:56:07.000+00:00",
"partyName" : "partyName",
"incidentTypeId" : 5,
"modifiedBy" : "modifiedBy",
"id" : 5,
"incidentStatusId" : 2,
"capturedBy" : "capturedBy",
"zeroRejectionAmountReason" : "zeroRejectionAmountReason",
"clientId" : "00000000-0000-0000-0000-000000000000",
"dateOfLoss" : "2000-01-23T04:56:07.000+00:00",
"rejectionLetterSent" : true,
"numberOfMonths" : 1,
"claimPaid" : true,
"incidentSubStatusId" : 7,
"rejectionReasonId" : 0,
"businessTypeId" : 7,
"partyEmail" : "partyEmail",
"incidentSourceId" : 9,
"rejectedOn" : "2000-01-23T04:56:07.000+00:00",
"settlementAmount" : 1.2315135367772556,
"incidentDescription" : "incidentDescription"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/json
Responses
200
OK
Up
get /api/clients/{clientId}/users
Gets list of Users for client (getClientUsers)
Path parameters
clientId (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
[ {
"clientId" : "00000000-0000-0000-0000-000000000000",
"clientName" : "clientName",
"displayName" : "displayName",
"id" : 0,
"userName" : "userName",
"email" : "email"
}, {
"clientId" : "00000000-0000-0000-0000-000000000000",
"clientName" : "clientName",
"displayName" : "displayName",
"id" : 0,
"userName" : "userName",
"email" : "email"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/json
Responses
200
OK
Gets Client for logged in user (getClients)
Return type
Example data
Content-Type: application/json
[ {
"clientName" : "clientName",
"clientCode" : "clientCode",
"id" : "00000000-0000-0000-0000-000000000000"
}, {
"clientName" : "clientName",
"clientCode" : "clientCode",
"id" : "00000000-0000-0000-0000-000000000000"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/json
Responses
200
OK
Up
get /api/Document/GetDocumentById
Gets a Document by id (getDocumentById)
Query parameters
id (required)
Query Parameter — format: int64
Return type
Example data
Content-Type: application/json
{
"extension" : "extension",
"updatedBy" : "updatedBy",
"createdBy" : "createdBy",
"contents" : "contents",
"id" : 0,
"documentName" : "documentName",
"createdOn" : "2000-01-23T04:56:07.000+00:00",
"updateOn" : "2000-01-23T04:56:07.000+00:00"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/json
Responses
200
OK
Document
Up
post /api/Document/SaveDocument
Saves a Document (saveDocument)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/json
Request body
Responses
204
No Content
Up
post /api/Document/SaveDocuments
Saves a list of Documents (saveDocuments)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/json
Request body
Responses
204
No Content
Up
get /api/Incident/Lookups/BusinessClasses
Gets list of BusinessClasses (businessClasses)
Return type
Example data
Content-Type: application/json
[ {
"modifiedOn" : "2000-01-23T04:56:07.000+00:00",
"isDeleted" : true,
"createdBy" : "createdBy",
"name" : "name",
"modifiedBy" : "modifiedBy",
"id" : 6,
"policyTypeId" : 0,
"createdOn" : "2000-01-23T04:56:07.000+00:00"
}, {
"modifiedOn" : "2000-01-23T04:56:07.000+00:00",
"isDeleted" : true,
"createdBy" : "createdBy",
"name" : "name",
"modifiedBy" : "modifiedBy",
"id" : 6,
"policyTypeId" : 0,
"createdOn" : "2000-01-23T04:56:07.000+00:00"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/json
Responses
200
OK
Up
get /api/Incident/Lookups/BusinessSubClasses
Gets list of BusinessSubClasses (businessSubClasses)
Return type
Example data
Content-Type: application/json
[ {
"businessClassId" : 0,
"modifiedOn" : "2000-01-23T04:56:07.000+00:00",
"isDeleted" : true,
"createdBy" : "createdBy",
"name" : "name",
"modifiedBy" : "modifiedBy",
"id" : 6,
"createdOn" : "2000-01-23T04:56:07.000+00:00"
}, {
"businessClassId" : 0,
"modifiedOn" : "2000-01-23T04:56:07.000+00:00",
"isDeleted" : true,
"createdBy" : "createdBy",
"name" : "name",
"modifiedBy" : "modifiedBy",
"id" : 6,
"createdOn" : "2000-01-23T04:56:07.000+00:00"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/json
Responses
200
OK
Up
get /api/Incident/Lookups/BusinessTypes
Gets list of BusinessTypes (businessTypes)
Return type
Example data
Content-Type: application/json
[ {
"modifiedOn" : "2000-01-23T04:56:07.000+00:00",
"isDeleted" : true,
"createdBy" : "createdBy",
"name" : "name",
"modifiedBy" : "modifiedBy",
"id" : 0,
"createdOn" : "2000-01-23T04:56:07.000+00:00"
}, {
"modifiedOn" : "2000-01-23T04:56:07.000+00:00",
"isDeleted" : true,
"createdBy" : "createdBy",
"name" : "name",
"modifiedBy" : "modifiedBy",
"id" : 0,
"createdOn" : "2000-01-23T04:56:07.000+00:00"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/json
Responses
200
OK
Up
get /api/Incident/Lookups/ComplaintTypes
Gets list of ComplaintTypes (complaintTypes)
Return type
Example data
Content-Type: application/json
[ { }, { } ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/json
Responses
200
OK
Up
get /api/Incident/Lookups/ComplimentTypes
Gets list of ComplimentTypes (complimentTypes)
Return type
Example data
Content-Type: application/json
[ {
"modifiedOn" : "2000-01-23T04:56:07.000+00:00",
"isDeleted" : true,
"createdBy" : "createdBy",
"name" : "name",
"modifiedBy" : "modifiedBy",
"id" : 0,
"createdOn" : "2000-01-23T04:56:07.000+00:00"
}, {
"modifiedOn" : "2000-01-23T04:56:07.000+00:00",
"isDeleted" : true,
"createdBy" : "createdBy",
"name" : "name",
"modifiedBy" : "modifiedBy",
"id" : 0,
"createdOn" : "2000-01-23T04:56:07.000+00:00"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/json
Responses
200
OK
Up
get /api/Incident/Lookups/IncidentSources
Gets list of IncidentSources (incidentSources)
Return type
Example data
Content-Type: application/json
[ {
"modifiedOn" : "2000-01-23T04:56:07.000+00:00",
"isDeleted" : true,
"createdBy" : "createdBy",
"name" : "name",
"modifiedBy" : "modifiedBy",
"id" : 0,
"createdOn" : "2000-01-23T04:56:07.000+00:00"
}, {
"modifiedOn" : "2000-01-23T04:56:07.000+00:00",
"isDeleted" : true,
"createdBy" : "createdBy",
"name" : "name",
"modifiedBy" : "modifiedBy",
"id" : 0,
"createdOn" : "2000-01-23T04:56:07.000+00:00"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/json
Responses
200
OK
Up
get /api/Incident/Lookups/IncidentStatuses
Gets list of IncidentStatuses (incidentStatuses)
Return type
Example data
Content-Type: application/json
[ {
"modifiedOn" : "2000-01-23T04:56:07.000+00:00",
"isDeleted" : true,
"createdBy" : "createdBy",
"name" : "name",
"modifiedBy" : "modifiedBy",
"id" : 0,
"createdOn" : "2000-01-23T04:56:07.000+00:00"
}, {
"modifiedOn" : "2000-01-23T04:56:07.000+00:00",
"isDeleted" : true,
"createdBy" : "createdBy",
"name" : "name",
"modifiedBy" : "modifiedBy",
"id" : 0,
"createdOn" : "2000-01-23T04:56:07.000+00:00"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/json
Responses
200
OK
Up
get /api/Incident/Lookups/IncidentSubStatuses
Gets list of IncidentSubStatuses (incidentSubStatuses)
Return type
Example data
Content-Type: application/json
[ {
"modifiedOn" : "2000-01-23T04:56:07.000+00:00",
"isDeleted" : true,
"createdBy" : "createdBy",
"name" : "name",
"incidentTypeId" : 0,
"modifiedBy" : "modifiedBy",
"id" : 6,
"createdOn" : "2000-01-23T04:56:07.000+00:00"
}, {
"modifiedOn" : "2000-01-23T04:56:07.000+00:00",
"isDeleted" : true,
"createdBy" : "createdBy",
"name" : "name",
"incidentTypeId" : 0,
"modifiedBy" : "modifiedBy",
"id" : 6,
"createdOn" : "2000-01-23T04:56:07.000+00:00"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/json
Responses
200
OK
Up
get /api/Incident/Lookups/IncidentTypeSources
Gets list of IncidentTypeSources (incidentTypeSources)
Return type
Example data
Content-Type: application/json
[ {
"modifiedOn" : "2000-01-23T04:56:07.000+00:00",
"isDeleted" : true,
"createdBy" : "createdBy",
"incidentSourceId" : 6,
"name" : "name",
"incidentTypeId" : 0,
"modifiedBy" : "modifiedBy",
"id" : 1,
"createdOn" : "2000-01-23T04:56:07.000+00:00"
}, {
"modifiedOn" : "2000-01-23T04:56:07.000+00:00",
"isDeleted" : true,
"createdBy" : "createdBy",
"incidentSourceId" : 6,
"name" : "name",
"incidentTypeId" : 0,
"modifiedBy" : "modifiedBy",
"id" : 1,
"createdOn" : "2000-01-23T04:56:07.000+00:00"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/json
Responses
200
OK
Up
get /api/Incident/Lookups/IncidentTypes
Gets list of IncidentTypes (incidentTypes)
Return type
Example data
Content-Type: application/json
[ {
"modifiedOn" : "2000-01-23T04:56:07.000+00:00",
"isDeleted" : true,
"createdBy" : "createdBy",
"name" : "name",
"modifiedBy" : "modifiedBy",
"id" : 0,
"createdOn" : "2000-01-23T04:56:07.000+00:00"
}, {
"modifiedOn" : "2000-01-23T04:56:07.000+00:00",
"isDeleted" : true,
"createdBy" : "createdBy",
"name" : "name",
"modifiedBy" : "modifiedBy",
"id" : 0,
"createdOn" : "2000-01-23T04:56:07.000+00:00"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/json
Responses
200
OK
Up
get /api/Incident/Lookups/OstiComplaintTypes
Gets list of OstiComplaintTypes (ostiComplaintTypes)
Return type
Example data
Content-Type: application/json
[ {
"modifiedOn" : "2000-01-23T04:56:07.000+00:00",
"isDeleted" : true,
"createdBy" : "createdBy",
"sortOrder" : 0,
"name" : "name",
"modifiedBy" : "modifiedBy",
"id" : 6,
"createdOn" : "2000-01-23T04:56:07.000+00:00"
}, {
"modifiedOn" : "2000-01-23T04:56:07.000+00:00",
"isDeleted" : true,
"createdBy" : "createdBy",
"sortOrder" : 0,
"name" : "name",
"modifiedBy" : "modifiedBy",
"id" : 6,
"createdOn" : "2000-01-23T04:56:07.000+00:00"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/json
Responses
200
OK
Up
get /api/Incident/Lookups/PolicyTypes
Gets list of PolicyTypes (policyTypes)
Return type
Example data
Content-Type: application/json
[ {
"modifiedOn" : "2000-01-23T04:56:07.000+00:00",
"isDeleted" : true,
"createdBy" : "createdBy",
"name" : "name",
"modifiedBy" : "modifiedBy",
"id" : 0,
"createdOn" : "2000-01-23T04:56:07.000+00:00"
}, {
"modifiedOn" : "2000-01-23T04:56:07.000+00:00",
"isDeleted" : true,
"createdBy" : "createdBy",
"name" : "name",
"modifiedBy" : "modifiedBy",
"id" : 0,
"createdOn" : "2000-01-23T04:56:07.000+00:00"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/json
Responses
200
OK
Up
get /api/Incident/Lookups/RejectionReasons
Gets list of RejectionReasons (rejectionReasons)
Query parameters
incidentId (required)
Query Parameter — format: int64
Return type
Example data
Content-Type: application/json
[ {
"modifiedOn" : "2000-01-23T04:56:07.000+00:00",
"isDeleted" : true,
"createdBy" : "createdBy",
"name" : "name",
"modifiedBy" : "modifiedBy",
"id" : 0,
"createdOn" : "2000-01-23T04:56:07.000+00:00"
}, {
"modifiedOn" : "2000-01-23T04:56:07.000+00:00",
"isDeleted" : true,
"createdBy" : "createdBy",
"name" : "name",
"modifiedBy" : "modifiedBy",
"id" : 0,
"createdOn" : "2000-01-23T04:56:07.000+00:00"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/json
Responses
200
OK
Up
get /api/Incidents/Rejections/{rejectionId}
Gets a rejection by id (getRejectionById)
Path parameters
rejectionId (required)
Path Parameter — rejection Id format: int64
Return type
Example data
Content-Type: application/json
{
"claimNo" : "claimNo",
"businessClassId" : 3,
"incidentNo" : "incidentNo",
"rejectionAmount" : 6.027456183070403,
"documents" : [ {
"extension" : "extension",
"updatedBy" : "updatedBy",
"createdBy" : "createdBy",
"contents" : "contents",
"id" : 0,
"documentName" : "documentName",
"createdOn" : "2000-01-23T04:56:07.000+00:00",
"updateOn" : "2000-01-23T04:56:07.000+00:00"
}, {
"extension" : "extension",
"updatedBy" : "updatedBy",
"createdBy" : "createdBy",
"contents" : "contents",
"id" : 0,
"documentName" : "documentName",
"createdOn" : "2000-01-23T04:56:07.000+00:00",
"updateOn" : "2000-01-23T04:56:07.000+00:00"
} ],
"processLink" : "processLink",
"policyNo" : "policyNo",
"policyTypeId" : 4,
"policyInceptionDate" : "2000-01-23T04:56:07.000+00:00",
"modifiedOn" : "2000-01-23T04:56:07.000+00:00",
"capturedOn" : "2000-01-23T04:56:07.000+00:00",
"businessSubClassId" : 2,
"receivedOn" : "2000-01-23T04:56:07.000+00:00",
"partyName" : "partyName",
"incidentTypeId" : 5,
"modifiedBy" : "modifiedBy",
"id" : 5,
"incidentStatusId" : 2,
"capturedBy" : "capturedBy",
"zeroRejectionAmountReason" : "zeroRejectionAmountReason",
"clientId" : "00000000-0000-0000-0000-000000000000",
"dateOfLoss" : "2000-01-23T04:56:07.000+00:00",
"rejectionLetterSent" : true,
"numberOfMonths" : 1,
"claimPaid" : true,
"incidentSubStatusId" : 7,
"rejectionReasonId" : 0,
"businessTypeId" : 7,
"partyEmail" : "partyEmail",
"incidentSourceId" : 9,
"rejectedOn" : "2000-01-23T04:56:07.000+00:00",
"settlementAmount" : 1.2315135367772556,
"incidentDescription" : "incidentDescription"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/json
Responses
200
OK
Rejection
Up
post /api/Incidents/Rejections/Rejection
Submits a rejection for approval. (submitRejection)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/json
Request body
Body Parameter — The rejection to be submitted
Return type
Object
Example data
Content-Type: application/json
"{}"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/json
Responses
200
OK
Object
Up
post /api/Incidents/Rejections/{rejectionId}
Uploads a Document for rejection (uploadDocument)
Path parameters
rejectionId (required)
Path Parameter —
Consumes
This API call consumes the following media types via the request header:
application/jsontext/json
Request body
Body Parameter — The rejection to be updated
Return type
Example data
Content-Type: application/json
{
"claimNo" : "claimNo",
"businessClassId" : 3,
"incidentNo" : "incidentNo",
"rejectionAmount" : 6.027456183070403,
"documents" : [ {
"extension" : "extension",
"updatedBy" : "updatedBy",
"createdBy" : "createdBy",
"contents" : "contents",
"id" : 0,
"documentName" : "documentName",
"createdOn" : "2000-01-23T04:56:07.000+00:00",
"updateOn" : "2000-01-23T04:56:07.000+00:00"
}, {
"extension" : "extension",
"updatedBy" : "updatedBy",
"createdBy" : "createdBy",
"contents" : "contents",
"id" : 0,
"documentName" : "documentName",
"createdOn" : "2000-01-23T04:56:07.000+00:00",
"updateOn" : "2000-01-23T04:56:07.000+00:00"
} ],
"processLink" : "processLink",
"policyNo" : "policyNo",
"policyTypeId" : 4,
"policyInceptionDate" : "2000-01-23T04:56:07.000+00:00",
"modifiedOn" : "2000-01-23T04:56:07.000+00:00",
"capturedOn" : "2000-01-23T04:56:07.000+00:00",
"businessSubClassId" : 2,
"receivedOn" : "2000-01-23T04:56:07.000+00:00",
"partyName" : "partyName",
"incidentTypeId" : 5,
"modifiedBy" : "modifiedBy",
"id" : 5,
"incidentStatusId" : 2,
"capturedBy" : "capturedBy",
"zeroRejectionAmountReason" : "zeroRejectionAmountReason",
"clientId" : "00000000-0000-0000-0000-000000000000",
"dateOfLoss" : "2000-01-23T04:56:07.000+00:00",
"rejectionLetterSent" : true,
"numberOfMonths" : 1,
"claimPaid" : true,
"incidentSubStatusId" : 7,
"rejectionReasonId" : 0,
"businessTypeId" : 7,
"partyEmail" : "partyEmail",
"incidentSourceId" : 9,
"rejectedOn" : "2000-01-23T04:56:07.000+00:00",
"settlementAmount" : 1.2315135367772556,
"incidentDescription" : "incidentDescription"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/json
Responses
200
OK
Rejection
Up
post /api/Incident/TaskList/CompleteTask
Completes a task (completeTask)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/json
Request body
Return type
Boolean
Example data
Content-Type: application/json
true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/json
Responses
200
OK
Boolean
Up
post /api/tasks/Open/{userId}/tasks/{serialNumber}
Opens a task (openTask)
Path parameters
userId (required)
Path Parameter — format: int32
serialNumber (required)
Path Parameter — serialNumber
Return type
Object
Example data
Content-Type: application/json
"{}"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/json
Responses
200
OK
Object
Up
post /api/tasks/ReAssign
Reassigns a task to another user (reAssignTask)
Consumes
This API call consumes the following media types via the request header:
application/jsontext/json
Request body
Return type
Boolean
Example data
Content-Type: application/json
true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/json
Responses
200
OK
Boolean
Up
get /api/users/{userId}/tasks
Gets a users task (getTasks)
Path parameters
userId (required)
Path Parameter — user Id format: int32
Return type
Example data
Content-Type: application/json
[ {
"serialNumber" : "serialNumber",
"selectedAction" : "selectedAction",
"taskAssignees" : [ {
"name" : "name",
"allowedActions" : [ "allowedActions", "allowedActions" ]
}, {
"name" : "name",
"allowedActions" : [ "allowedActions", "allowedActions" ]
} ],
"taskUrl" : "taskUrl",
"documents" : [ {
"extension" : "extension",
"updatedBy" : "updatedBy",
"createdBy" : "createdBy",
"contents" : "contents",
"id" : 0,
"documentName" : "documentName",
"createdOn" : "2000-01-23T04:56:07.000+00:00",
"updateOn" : "2000-01-23T04:56:07.000+00:00"
}, {
"extension" : "extension",
"updatedBy" : "updatedBy",
"createdBy" : "createdBy",
"contents" : "contents",
"id" : 0,
"documentName" : "documentName",
"createdOn" : "2000-01-23T04:56:07.000+00:00",
"updateOn" : "2000-01-23T04:56:07.000+00:00"
} ],
"allowedActions" : [ "allowedActions", "allowedActions" ],
"description" : "description",
"allocatedUser" : "allocatedUser",
"taskId" : 0
}, {
"serialNumber" : "serialNumber",
"selectedAction" : "selectedAction",
"taskAssignees" : [ {
"name" : "name",
"allowedActions" : [ "allowedActions", "allowedActions" ]
}, {
"name" : "name",
"allowedActions" : [ "allowedActions", "allowedActions" ]
} ],
"taskUrl" : "taskUrl",
"documents" : [ {
"extension" : "extension",
"updatedBy" : "updatedBy",
"createdBy" : "createdBy",
"contents" : "contents",
"id" : 0,
"documentName" : "documentName",
"createdOn" : "2000-01-23T04:56:07.000+00:00",
"updateOn" : "2000-01-23T04:56:07.000+00:00"
}, {
"extension" : "extension",
"updatedBy" : "updatedBy",
"createdBy" : "createdBy",
"contents" : "contents",
"id" : 0,
"documentName" : "documentName",
"createdOn" : "2000-01-23T04:56:07.000+00:00",
"updateOn" : "2000-01-23T04:56:07.000+00:00"
} ],
"allowedActions" : [ "allowedActions", "allowedActions" ],
"description" : "description",
"allocatedUser" : "allocatedUser",
"taskId" : 0
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/json
Responses
200
OK
Up
get /api/users/{userId}
Gets user by id (getUserById)
Path parameters
userId (required)
Path Parameter — format: int32
Return type
Example data
Content-Type: application/json
{
"clientId" : "00000000-0000-0000-0000-000000000000",
"clientName" : "clientName",
"displayName" : "displayName",
"id" : 0,
"userName" : "userName",
"email" : "email"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsontext/json
Responses
200
OK
User
[ Jump to Methods ]
Table of Contents
BusinessClass - BusinessSubClass - BusinessType - Client - ComplaintType - ComplimentType - Document - DocumentCollection - IncidentSource - IncidentStatus - IncidentSubStatus - IncidentType - IncidentTypeSource - OstiComplaintType - PolicyType - ReAssignTaskRequest - Rejection - RejectionReason - Task - TaskAssignee - User -
policyTypeId (optional)
id (optional)
name (optional)
createdBy (optional)
createdOn (optional)
modifiedBy (optional)
modifiedOn (optional)
isDeleted (optional)
businessClassId (optional)
id (optional)
name (optional)
createdBy (optional)
createdOn (optional)
modifiedBy (optional)
modifiedOn (optional)
isDeleted (optional)
id (optional)
name (optional)
createdBy (optional)
createdOn (optional)
modifiedBy (optional)
modifiedOn (optional)
isDeleted (optional)
id (optional)
example: 00000000-0000-0000-0000-000000000000
clientName (optional)
clientCode (optional)
id (optional)
name (optional)
createdBy (optional)
createdOn (optional)
modifiedBy (optional)
modifiedOn (optional)
isDeleted (optional)
id (optional)
documentName (optional)
extension (optional)
createdBy (optional)
createdOn (optional)
updatedBy (optional)
updateOn (optional)
contents (optional)
id (optional)
name (optional)
createdBy (optional)
createdOn (optional)
modifiedBy (optional)
modifiedOn (optional)
isDeleted (optional)
id (optional)
name (optional)
createdBy (optional)
createdOn (optional)
modifiedBy (optional)
modifiedOn (optional)
isDeleted (optional)
incidentTypeId (optional)
id (optional)
name (optional)
createdBy (optional)
createdOn (optional)
modifiedBy (optional)
modifiedOn (optional)
isDeleted (optional)
id (optional)
name (optional)
createdBy (optional)
createdOn (optional)
modifiedBy (optional)
modifiedOn (optional)
isDeleted (optional)
incidentTypeId (optional)
incidentSourceId (optional)
name (optional)
id (optional)
createdBy (optional)
createdOn (optional)
modifiedBy (optional)
modifiedOn (optional)
isDeleted (optional)
sortOrder (optional)
id (optional)
name (optional)
createdBy (optional)
createdOn (optional)
modifiedBy (optional)
modifiedOn (optional)
isDeleted (optional)
id (optional)
name (optional)
createdBy (optional)
createdOn (optional)
modifiedBy (optional)
modifiedOn (optional)
isDeleted (optional)
taskSerialNumber (optional)
fromUserId (optional)
toUserId (optional)
rejectionReasonId
dateOfLoss
rejectedOn (optional)
rejectionAmount
numberOfMonths
zeroRejectionAmountReason
claimPaid
rejectionLetterSent
id (optional)
incidentTypeId
incidentStatusId
incidentSubStatusId
incidentSourceId
businessClassId
businessSubClassId
policyTypeId
businessTypeId
incidentNo (optional)
receivedOn
capturedOn (optional)
capturedBy
policyNo
policyInceptionDate (optional)
claimNo
partyName
partyEmail (optional)
incidentDescription
clientId
example: 00000000-0000-0000-0000-000000000000
modifiedOn (optional)
modifiedBy (optional)
processLink (optional)
settlementAmount
documents
id (optional)
name (optional)
createdBy (optional)
createdOn (optional)
modifiedBy (optional)
modifiedOn (optional)
isDeleted (optional)
taskId (optional)
serialNumber (optional)
taskUrl (optional)
description (optional)
allocatedUser (optional)
allowedActions (optional)
selectedAction (optional)
taskAssignees (optional)
documents (optional)
name (optional)
allowedActions (optional)
id (optional)
userName (optional)
displayName (optional)
email (optional)
clientName (optional)
clientId (optional)
example: 00000000-0000-0000-0000-000000000000