NOT FOR PUBLIC DISTRIBUTION: 2020-09-23

Jump to

• Request
• Response

Retrieve list of contracts

get

/spms/v1/contracts

This is to retrieve a list of all contracts

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Retrieve a list of all contracts

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object Oracle Response object containing list items
  Title: Oracle Response object containing list items

  The object returned in Oracle Standard when function is executed successfully

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/contractList"
    }
}

Nested Schema : Oracle Response object containing list items

Type: object

Title: Oracle Response object containing list items

The object returned in Oracle Standard when function is executed successfully

Show Source

• items(optional): array items

{
    "title":"Oracle Response object containing list items",
    "description":"The object returned in Oracle Standard when function is executed successfully",
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Contract"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Contract
  Title: Contract

  Legal document for guest to sign/ acknowledge

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Contract"
    }
}

Nested Schema : Contract

Type: object

Title: Contract

Legal document for guest to sign/ acknowledge

Show Source

• category: integer
  Minimum Value: 1

  Maximum Value: 1

  This value is the id value obtained from Contract Category

  Example: 1
• content(optional): string
  Minimum Value: 0

  Maximum Value: 50000

  Pattern: ^[a-zA-Z0-9 _,\\?/\\.\\-\\\\+\\*\n~!@#$%&{}\\[\\]()=<>\\|\\^\\":;@`]*$

  This is the content of the contract

  Example: Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.
• enabled(optional): boolean
  Indicates whether this contract is enabled

  Example: true
• name: string
  Minimum Value: 1

  Maximum Value: 100

  Pattern: ^[a-zA-Z0-9 ]*$

  Example: Oracle Cruise Contract
• remarks(optional): boolean
  Indicates whether the remarks textbox should be displayed or not

  Example: true
• signature(optional): boolean
  Indicates whether the signature is required or not. True indicates required, false indicates not required.

  Example: true
• termsAndCondition(optional): string
  Minimum Value: 0

  Maximum Value: 500

  Pattern: ^[a-zA-Z0-9 _,\\?/\\.\\-\\\\+\\*\n~!@#$%&{}\\[\\]()=<>\\|\\^\\":;@`]*$

  This is the actual terms and condition for this contract

  Example: Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged.
• termsAndConditionStatus(optional): boolean
  Indicates whether the terms and condition is mandatory or optional. True indicates mandatory, false indicates optional.

  Example: true

{
    "title":"Contract",
    "description":"Legal document for guest to sign/ acknowledge",
    "type":"object",
    "properties":{
        "category":{
            "type":"integer",
            "minimum":1,
            "maximum":1,
            "example":1,
            "description":"This value is the id value obtained from Contract Category"
        },
        "name":{
            "type":"string",
            "minimum":1,
            "maximum":100,
            "example":"Oracle Cruise Contract",
            "pattern":"^[a-zA-Z0-9 ]*$"
        },
        "content":{
            "type":"string",
            "minimum":0,
            "maximum":50000,
            "example":"Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.",
            "pattern":"^[a-zA-Z0-9 _,\\\\?/\\\\.\\\\-\\\\\\\\+\\\\*\\n~!@#$%&{}\\\\[\\\\]()=<>\\\\|\\\\^\\\\\":;@`]*$",
            "description":"This is the content of the contract"
        },
        "enabled":{
            "type":"boolean",
            "example":"true",
            "description":"Indicates whether this contract is enabled"
        },
        "termsAndCondition":{
            "type":"string",
            "minimum":0,
            "maximum":500,
            "example":"Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. ",
            "pattern":"^[a-zA-Z0-9 _,\\\\?/\\\\.\\\\-\\\\\\\\+\\\\*\\n~!@#$%&{}\\\\[\\\\]()=<>\\\\|\\\\^\\\\\":;@`]*$",
            "description":"This is the actual terms and condition for this contract"
        },
        "termsAndConditionStatus":{
            "type":"boolean",
            "example":"true",
            "description":"Indicates whether the terms and condition is mandatory or optional. True indicates mandatory, false indicates optional."
        },
        "signature":{
            "type":"boolean",
            "example":"true",
            "description":"Indicates whether the signature is required or not. True indicates required, false indicates not required."
        },
        "remarks":{
            "type":"boolean",
            "example":"true",
            "description":"Indicates whether the remarks textbox should be displayed or not"
        }
    },
    "required":[
        "category",
        "name"
    ]
}

204 Response

No contacts is available

401 Response

You are not authorized to use this API

Body ()

Root Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
  Example: There are validation errors for the object......
• title(optional): string
  Example: validation fails for row with key={123}
• type(optional): string
  Example: HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

403 Response

You are forbidden to use this API

Body ()

Root Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
  Example: There are validation errors for the object......
• title(optional): string
  Example: validation fails for row with key={123}
• type(optional): string
  Example: HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

405 Response

This method is not available

Body ()

Root Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
  Example: There are validation errors for the object......
• title(optional): string
  Example: validation fails for row with key={123}
• type(optional): string
  Example: HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

415 Response

The media supplied is not supported

Body ()

Root Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
  Example: There are validation errors for the object......
• title(optional): string
  Example: validation fails for row with key={123}
• type(optional): string
  Example: HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

500 Response

Error occurred while processing this request

Body ()

Root Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
  Example: There are validation errors for the object......
• title(optional): string
  Example: validation fails for row with key={123}
• type(optional): string
  Example: HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

502 Response

Bad Gateway

503 Response

Service not available

Back to Top