Create Landlord Agreement
post
https://server:port/spl/rest/apis/customer/v-model/landlordAgreements/
This script handles the Integration Suite API to Create Landlord Agreement .
Request
There are no request parameters for this operation.
Supported Media Types
- application/xml
- application/json
Root Schema : schema
Type:
Show Source
object
-
account: object
account
-
description: string
Maximum Length:
60
Enter a Description of the landlord agreement.Example:Bowers Property Mgts
-
landlordAgreementDetail: object
landlordAgreementDetail
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:1
Nested Schema : items
Type:
Show Source
object
-
endMonthDay: string
Maximum Length:
4
When Seasonal is turned on, the Start Month/Day and the End Month/Day is defined for the effective season.Example:0610
-
isSeasonal: boolean
Turn on Seasonal if the service should only revert to the landlords account during a specific season of the year.Example:
false
-
landLord: string
Maximum Length:
10
Landlord Agreement ID -
serviceType: object
serviceType
-
startMonthDay: string
Maximum Length:
4
When Seasonal is turned on, the Start Month/Day and the End Month/Day is defined for the effective season.Example:0101
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:1
Nested Schema : serviceType
Type:
Show Source
object
-
serviceType: string
Maximum Length:
30
Service Type
Root Schema : schema
Type:
Show Source
object
-
account: object
account
-
description: string
Maximum Length:
60
Enter a Description of the landlord agreement.Example:Bowers Property Mgts
-
landlordAgreementDetail: object
landlordAgreementDetail
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:1
Nested Schema : items
Type:
Show Source
object
-
endMonthDay: string
Maximum Length:
4
When Seasonal is turned on, the Start Month/Day and the End Month/Day is defined for the effective season.Example:0610
-
isSeasonal: boolean
Turn on Seasonal if the service should only revert to the landlords account during a specific season of the year.Example:
false
-
landLord: string
Maximum Length:
10
Landlord Agreement ID -
serviceType: object
serviceType
-
startMonthDay: string
Maximum Length:
4
When Seasonal is turned on, the Start Month/Day and the End Month/Day is defined for the effective season.Example:0101
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:1
Nested Schema : serviceType
Type:
Show Source
object
-
serviceType: string
Maximum Length:
30
Service Type
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : C1LandlordAg
Type:
Show Source
object
-
_self: string
_self
-
account: object
account
-
description: string
Maximum Length:
60
Enter a Description of the landlord agreement.Example:Bowers Property Mgts
-
landLord: string
Maximum Length:
10
Landlord ID is a system-assigned random number that stays with the landlord agreement for life.Example:9999999999
-
landlordAgreementDetail: object
landlordAgreementDetail
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:1
Nested Schema : account
Type:
Show Source
object
-
_link: string
_link
-
accountId: string
Maximum Length:
10
Account ID
Nested Schema : items
Type:
Show Source
object
-
endMonthDay: string
Maximum Length:
4
When Seasonal is turned on, the Start Month/Day and the End Month/Day is defined for the effective season.Example:0610
-
isSeasonal: boolean
Turn on Seasonal if the service should only revert to the landlords account during a specific season of the year.Example:
false
-
serviceType: object
serviceType
-
startMonthDay: string
Maximum Length:
4
When Seasonal is turned on, the Start Month/Day and the End Month/Day is defined for the effective season.Example:0101
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:1
Nested Schema : serviceType
Type:
Show Source
object
-
_link: string
_link
-
serviceType: string
Maximum Length:
30
Service Type
400 Response
Bad Request
Root Schema : problemDetailDocument
Type:
Show Source
object
-
detail: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
httpStatus: number
Minimum Value:
0
Maximum Value:9999
The HTTP Status code for the error. -
problemInstance: string
Maximum Length:
60
Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction. -
problemType: string
Maximum Length:
60
URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework. -
serverMessage: object
serverMessage
-
stackTrace: string
Maximum Length:
60
The stack trace shows where the error occurs during the execution of a program. -
title: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type:
Show Source
object
-
callSequence: string
Maximum Length:
60
Delimited sequence of programs called. -
longDescription: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
messageCategory: number
Minimum Value:
0
Maximum Value:0
Message Category within Oracle Utilities Application Framework. -
messageNbr: number
Minimum Value:
-99999
Maximum Value:99999
Message Number within Oracle Utilities Application Framework. -
messageText: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format. -
programName: string
Maximum Length:
60
Name of the program that encountered the error.
500 Response
Internal Server Error
Root Schema : problemDetailDocument
Type:
Show Source
object
-
detail: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
httpStatus: number
Minimum Value:
0
Maximum Value:9999
The HTTP Status code for the error. -
problemInstance: string
Maximum Length:
60
Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction. -
problemType: string
Maximum Length:
60
URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework. -
serverMessage: object
serverMessage
-
stackTrace: string
Maximum Length:
60
The stack trace shows where the error occurs during the execution of a program. -
title: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type:
Show Source
object
-
callSequence: string
Maximum Length:
60
Delimited sequence of programs called. -
longDescription: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
messageCategory: number
Minimum Value:
0
Maximum Value:0
Message Category within Oracle Utilities Application Framework. -
messageNbr: number
Minimum Value:
-99999
Maximum Value:99999
Message Number within Oracle Utilities Application Framework. -
messageText: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format. -
programName: string
Maximum Length:
60
Name of the program that encountered the error.