POST api/sync/credasv2actor/{groupId}/{personId}/{negId}

callback from credas to notify us of actor updates to a case Processes this sync API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
groupId

The unique identifier of the group resource.

 integer

Required
personId

The unique identifier of the person resource.

 integer

Required
negId

The unique identifier of the neg resource.

 integer

Required

Body Parameters

The credas v2 actor webhook data contract supplied with the request.

CredasV2ActorWebhookDataContract
NameDescriptionTypeAdditional information
clientId

The unique identifier of the related client resource.

 globally unique identifier

None.
processId

The unique identifier of the related process resource.

 globally unique identifier

None.
processActorId

The unique identifier of the related process actor resource.

 integer

None.
entityId

The unique identifier of the related entity resource.

 globally unique identifier

None.
smsStatus

The sms status value.

 integer

None.
smsStatusDescription

The sms status description value.

 string

None.
emailStatus

The email status value.

 integer

None.
emailStatusDescription

The email status description value.

 string

None.

Request Formats

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CredasV2ActorWebhookDataContract'.

application/json, text/json

Sample: 
{
  "clientId": "1802d003-c028-430d-804b-73845650e0fd",
  "processId": "4a0a1f47-6258-443a-b1f3-2656efce892f",
  "processActorId": 3,
  "entityId": "6c5c76d8-5476-4a18-af98-7b36243e22fc",
  "smsStatus": 5,
  "smsStatusDescription": "sample string 6",
  "emailStatus": 7,
  "emailStatusDescription": "sample string 8"
}

Response Information

Resource Description

The response returned after the operation completes.

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

The version value.

 Version

None.
Content

The content value.

 HttpContent

None.
StatusCode

The status code classification.

 HttpStatusCode

None.
ReasonPhrase

The reason phrase value.

 string

None.
Headers

The collection of headers.

 Collection of Object

None.
RequestMessage

The request message value.

 HttpRequestMessage

None.
IsSuccessStatusCode

Indicates whether this item is success status code.

 boolean

None.