POST api/app/credas-right-to-rent/sync

Records Right to Rent activity and stores available Credas reports in Rezi. Processes this credas right to rent API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

None.

Body Parameters

The sync credas right to rent data contract supplied with the request.

SyncCredasRightToRentDataContract
NameDescriptionTypeAdditional information
GroupId

The unique identifier of the related group resource.

 integer

None.
PersonId

The unique identifier of the related person resource.

 integer

None.
ProcessId

The unique identifier of the related process resource.

 globally unique identifier

None.
EntityId

The unique identifier of the related entity resource.

 globally unique identifier

None.
Action

The action value.

 string

None.
OperationId

The unique identifier of the related operation resource.

 globally unique identifier

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 'SyncCredasRightToRentDataContract'.

application/json, text/json

Sample: 
{
  "GroupId": 1,
  "PersonId": 2,
  "ProcessId": "94650054-999a-4856-8e6f-d67ea5078ca0",
  "EntityId": "d857f75d-8058-4f96-b5a8-4de4a791ed6e",
  "Action": "sample string 5",
  "OperationId": "26f8d630-9fdd-4138-8b4b-bda21f54801b"
}

Response Information

Resource Description

The response returned after the operation completes.

SyncCredasRightToRentResultDataContract
NameDescriptionTypeAdditional information
documentsStored

The documents stored value.

 integer

None.
documentsPending

Indicates whether documents pending is true.

 boolean

None.
documentsScheduled

Indicates whether documents scheduled is true.

 boolean

None.
processComplete

Indicates whether process complete is true.

 boolean

None.
referralPending

Indicates whether referral pending is true.

 boolean

None.
notificationsPending

Indicates whether notifications pending is true.

 boolean

None.
documentIds

The unique identifiers of the related document resources.

 Collection of integer

None.
eventsRecorded

The events recorded value.

 integer

None.
status

The status value.

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "documentsStored": 1,
  "documentsPending": true,
  "documentsScheduled": true,
  "processComplete": true,
  "referralPending": true,
  "notificationsPending": true,
  "documentIds": [
    1,
    2
  ],
  "eventsRecorded": 7,
  "status": "sample string 8"
}