API docs by Redocly

request API (develop:c14720)

Download OpenAPI specification:

License: None

Automatically generated swagger spec for the request stack.

ApplicationService

Create

Request Body schema: application/json
required
required
object (requestapplicationv2Company)
required
Array of objects (requestapplicationv2Individual)
required
Array of objects (Either individuals or company must be provided. Both are NOT allowed!)

Responses

Request samples

Content type
application/json
{
  • "company": {
    },
  • "guarantors": [
    ],
  • "individuals": [
    ]
}

Response samples

Content type
application/json
{
  • "application": {
    }
}

Delete

path Parameters
ids
required
Array of strings non-empty
query Parameters
hard
boolean

Responses

Response samples

Content type
application/json
{ }

ApplicationService_GetById

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "application": {
    }
}

Read

path Parameters
creatorEmail
required
string

Responses

Response samples

Content type
application/json
{
  • "application": {
    }
}

ApplicationService_Send

Request Body schema: application/json
required
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

id
required
string
language
required
string
objectId
required
string
requestId
string

Optional. If not provided the email will be used to match.

viewingAppointmentDone
required
boolean

Responses

Request samples

Content type
application/json
{
  • "desiredStartOfContract": {
    },
  • "id": "string",
  • "language": "string",
  • "objectId": "string",
  • "requestId": "string",
  • "viewingAppointmentDone": true
}

Response samples

Content type
application/json
{ }

ApplicationService_GetSettings

path Parameters
accountId
required
string <int64>

Responses

Response samples

Content type
application/json
{
  • "settings": {
    }
}

Settings

path Parameters
accountId
required
string <int64>
Request Body schema: application/json
required
contractCreationCost
number <float>
showContractCreationCostAgreement
boolean

Responses

Request samples

Content type
application/json
{
  • "contractCreationCost": 0.1,
  • "showContractCreationCostAgreement": true
}

Response samples

Content type
application/json
{
  • "settings": {
    }
}

RequestService

Create

Request Body schema: application/json
required
required
object (v2Checklist)
createdByReceiver
required
boolean (If receiver or requester read the last message)
favorite
required
boolean
required
Array of objects (v2Guarantor)
initialMessage
required
string
marketplaceName
required
string
objectId
required
string
ownerId
required
string <int64>
rejected
required
boolean
required
Array of objects (v2Requester)
sendDefaultAnswer
required
boolean
source
required
string (- PERSONAL_REQUEST_SOURCE: E.g. if requester came into office)
Default: "UNDEFINED_REQUEST_SOURCE"
Enum: "UNDEFINED_REQUEST_SOURCE" "PHONE_REQUEST_SOURCE" "MAIL_REQUEST_SOURCE" "WEBSITE_REQUEST_SOURCE" "MARKETPLACE_REQUEST_SOURCE" "PERSONAL_REQUEST_SOURCE"
tenancyId
required
string

DO NOT USE! Deprecated. Use tenancyIds

tenancyIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "checklist": {
    },
  • "createdByReceiver": true,
  • "favorite": true,
  • "guarantors": [
    ],
  • "initialMessage": "string",
  • "marketplaceName": "string",
  • "objectId": "string",
  • "ownerId": "string",
  • "rejected": true,
  • "requesters": [
    ],
  • "sendDefaultAnswer": true,
  • "source": "UNDEFINED_REQUEST_SOURCE",
  • "tenancyId": "string",
  • "tenancyIds": [
    ]
}

Response samples

Content type
application/json
{
  • "request": {
    }
}

RequestService_GetMarketingStatistics

path Parameters
accountId
required
string <int64>

The ID of the account whose marketing statistics are to be calculated (requests to objects he got with share-scope=MARKETING)

query Parameters
contactIdAssigneeMarketing
string

The contactId which should be used for employee based statistics

Responses

Response samples

Content type
application/json
{
  • "employeeNewRequests": 0,
  • "employeeUnreadRequests": 0,
  • "overallNewRequests": 0,
  • "overallUnreadRequests": 0
}

RequestService_GetStatistics

path Parameters
objectIds
required
Array of strings non-empty

Responses

Response samples

Content type
application/json
{
  • "statistics": [
    ]
}

Read

path Parameters
ids
required
Array of strings non-empty

Responses

Response samples

Content type
application/json
{
  • "requests": [
    ]
}

RequestService_ListByRequesterContactId

path Parameters
contactId
required
string

Responses

Response samples

Content type
application/json
{
  • "requests": [
    ]
}

RequestService_ListReceivedByObjectIds

path Parameters
objectIds
required
Array of strings non-empty
query Parameters
new
boolean

Optional: If new request wasn't read by the receiver at least once

readByReceiver
boolean

Optional: If receiver read the last message

checklist.viewingAppointmentContactShared
boolean
checklist.viewingAppointmentArranged
boolean
checklist.viewingAppointmentDone
boolean
checklist.applicationFormRequested
boolean
checklist.applicationFormReceived
boolean
checklist.referencesObtained
boolean
checklist.creditCheckDone
boolean
checklist.contractSent
boolean
checklist.contractReceived
boolean
marketplaceName
Array of strings

Optional

Responses

Response samples

Content type
application/json
{
  • "new": 0,
  • "overall": 0,
  • "requests": [
    ],
  • "reserved": true,
  • "unread": 0
}

RequestService_ListSent

path Parameters
accountId
required
string <int64>

Responses

Response samples

Content type
application/json
{
  • "requests": [
    ]
}

Update

Request Body schema: application/json
required
ids
required
Array of strings
readByReceiver
required
boolean (True=receiver read, false=requester read)

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ],
  • "readByReceiver": true
}

Response samples

Content type
application/json
{ }

RequestService_MarkRejected

Request Body schema: application/json
required
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

RequestService_MarkUnread

Request Body schema: application/json
required
ids
required
Array of strings
unreadByReceiver
required
boolean (True=receiver unread, false=requester unread)

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ],
  • "unreadByReceiver": true
}

Response samples

Content type
application/json
{ }

RequestService_PartiallySetChecklist

Request Body schema: application/json
required
applicationFormReceived
required
boolean
applicationFormRequested
required
boolean
contractReceived
required
boolean
contractSent
required
boolean
creditCheckDone
required
boolean
ids
required
Array of strings
referencesObtained
required
boolean
viewingAppointmentArranged
required
boolean
viewingAppointmentContactShared
required
boolean
viewingAppointmentDone
required
boolean

Responses

Request samples

Content type
application/json
{
  • "applicationFormReceived": true,
  • "applicationFormRequested": true,
  • "contractReceived": true,
  • "contractSent": true,
  • "creditCheckDone": true,
  • "ids": [
    ],
  • "referencesObtained": true,
  • "viewingAppointmentArranged": true,
  • "viewingAppointmentContactShared": true,
  • "viewingAppointmentDone": true
}

Response samples

Content type
application/json
{
  • "requests": [
    ]
}

RequestService_Reactivate

Request Body schema: application/json
required
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

RequestService_SetChecklist

Request Body schema: application/json
required
required
object (v2Checklist)
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "checklist": {
    },
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

RequestService_SetFavorite

Request Body schema: application/json
required
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

RequestService_SetNotFavorite

Request Body schema: application/json
required
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

Delete

path Parameters
ids
required
Array of strings non-empty

Responses

Response samples

Content type
application/json
{ }

RequestService_AddGuarantors

path Parameters
id
required
string
Request Body schema: application/json
required
Array of objects (v2Guarantor)

Responses

Request samples

Content type
application/json
{
  • "guarantors": [
    ]
}

Response samples

Content type
application/json
{
  • "request": {
    }
}

RequestService_AddRequesters

path Parameters
id
required
string
Request Body schema: application/json
required
Array of objects (v2Requester)

Responses

Request samples

Content type
application/json
{
  • "requesters": [
    ]
}

Response samples

Content type
application/json
{
  • "request": {
    }
}

RequestService_Move

path Parameters
id
required
string
Request Body schema: application/json
required
objectId
string

Responses

Request samples

Content type
application/json
{
  • "objectId": "string"
}

Response samples

Content type
application/json
{
  • "request": {
    }
}

RequestService_RemoveRequesters

path Parameters
id
required
string
Request Body schema: application/json
required
contactIds
Array of strings

Responses

Request samples

Content type
application/json
{
  • "contactIds": [
    ]
}

Response samples

Content type
application/json
{
  • "request": {
    }
}

RequestService_Reserve

path Parameters
id
required
string
Request Body schema: application/json
required
tenancyId
string

DO NOT USE! Deprecated. Use tenancyIds

tenancyIds
Array of strings

Responses

Request samples

Content type
application/json
{
  • "tenancyId": "string",
  • "tenancyIds": [
    ]
}

Response samples

Content type
application/json
{ }

RequestService_SetEmployerReference

path Parameters
id
required
string
Request Body schema: application/json
required
contactId
string
object (v2EmployerReference)
generatePdf
boolean
language
string

Responses

Request samples

Content type
application/json
{
  • "contactId": "string",
  • "employerReference": {
    },
  • "generatePdf": true,
  • "language": "string"
}

Response samples

Content type
application/json
{ }

RequestService_SetEmployerReferenceFinalized

path Parameters
id
required
string
Request Body schema: application/json
required
finalized
boolean

Responses

Request samples

Content type
application/json
{
  • "finalized": true
}

Response samples

Content type
application/json
{ }

RequestService_SetLandlordReference

path Parameters
id
required
string
Request Body schema: application/json
required
contactId
string
generatePdf
boolean
object (v2LandlordReference)
language
string

Responses

Request samples

Content type
application/json
{
  • "contactId": "string",
  • "generatePdf": true,
  • "landlordReference": {
    },
  • "language": "string"
}

Response samples

Content type
application/json
{ }

RequestService_SetLandlordReferenceFinalized

path Parameters
id
required
string
Request Body schema: application/json
required
finalized
boolean

Responses

Request samples

Content type
application/json
{
  • "finalized": true
}

Response samples

Content type
application/json
{ }