NOT FOR PUBLIC DISTRIBUTION: 2020-09-23

Jump to

• Request
• Response

Create/ Add an acknowledged contract to a profile

post

/spms/v1/contractAcknowledgement

This is to create/ add an acknowledged contract to a profile

Request

Supported Media Types

• application/json

Body ()

Required to sign for a profile contract acknowledgement

Root Schema : ContractAcknowledgement

Type: object

Contract Acknowledgement

Show Source

• accountId(optional): integer
  Example: 1
• contractId(optional): integer
  Example: 1
• remarks(optional): string
  Minimum Value: 2

  Maximum Value: 2000

  Example: Remark for contract acknowledgement
• signatureImage(optional): string
  Minimum Value: 1

  Maximum Value: 2097152

  Example: /9j/4AAQSkZJRgABAQEASABIAAD==
• termAndCondition(optional): boolean
  Example: true

{
    "description":"Contract Acknowledgement",
    "type":"object",
    "properties":{
        "accountId":{
            "type":"integer",
            "example":1
        },
        "contractId":{
            "type":"integer",
            "example":1
        },
        "remarks":{
            "type":"string",
            "minimum":2,
            "maximum":2000,
            "example":"Remark for contract acknowledgement"
        },
        "signatureImage":{
            "type":"string",
            "minimum":1,
            "maximum":2097152,
            "example":"/9j/4AAQSkZJRgABAQEASABIAAD=="
        },
        "termAndCondition":{
            "type":"boolean",
            "example":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Contract acknowledgement has been signed

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object Oracle Response returned in singular object
  Title: Oracle Response returned in singular object

  The object returned in Oracle Standard when function is executed successfully

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

Nested Schema : Oracle Response returned in singular object

Type: object

Title: Oracle Response returned in singular object

The object returned in Oracle Standard when function is executed successfully

Show Source

• item(optional): object item

{
    "title":"Oracle Response returned in singular object",
    "description":"The object returned in Oracle Standard when function is executed successfully",
    "type":"object",
    "properties":{
        "item":{
            "type":"object",
            "items":{
                "$ref":"#/definitions/ContractAcknowledgement"
            }
        }
    }
}

Nested Schema : item

Type: object

Show Source

• Array of: object ContractAcknowledgement
  Contract Acknowledgement

{
    "type":"object",
    "items":{
        "$ref":"#/definitions/ContractAcknowledgement"
    }
}

Nested Schema : ContractAcknowledgement

Type: object

Contract Acknowledgement

Show Source

• accountId(optional): integer
  Example: 1
• contractId(optional): integer
  Example: 1
• remarks(optional): string
  Minimum Value: 2

  Maximum Value: 2000

  Example: Remark for contract acknowledgement
• signatureImage(optional): string
  Minimum Value: 1

  Maximum Value: 2097152

  Example: /9j/4AAQSkZJRgABAQEASABIAAD==
• termAndCondition(optional): boolean
  Example: true

{
    "description":"Contract Acknowledgement",
    "type":"object",
    "properties":{
        "accountId":{
            "type":"integer",
            "example":1
        },
        "contractId":{
            "type":"integer",
            "example":1
        },
        "remarks":{
            "type":"string",
            "minimum":2,
            "maximum":2000,
            "example":"Remark for contract acknowledgement"
        },
        "signatureImage":{
            "type":"string",
            "minimum":1,
            "maximum":2097152,
            "example":"/9j/4AAQSkZJRgABAQEASABIAAD=="
        },
        "termAndCondition":{
            "type":"boolean",
            "example":true
        }
    }
}

400 Response

Invalid parameter(s) passed in

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......"
        }
    }
}

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

This API is not allowed for the current user

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

Method requested 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......"
        }
    }
}

406 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......"
        }
    }
}

409 Response

You are trying to create a new contract that already exist

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