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
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
Response
Supported Media Types
- application/json
201 Response
Created
Root Schema : ContractAcknowledgementWithId
Type:
object
Contract Acknowledgement
Show Source
-
accountId(optional):
integer
Example:
1
-
contractId(optional):
integer
Example:
1
-
id(optional):
integer
Minimum Value:
1
This is the contract acknowledgement primary keyExample: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
400 Response
Bad Request
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Bad Request",
"detail":"Invalid parameter(s)"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
401 Response
Unauthorized
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
"title":"Unauthorized",
"detail":"Valid token is required to access this resource"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
406 Response
Not Acceptable
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7",
"title":"Not Acceptable",
"detail":"Request a Mime type that is supported for this Resource"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
409 Response
Conflict
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.10",
"title":"Conflict",
"detail":"Duplicate resource not allowed"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
415 Response
Unsupported Media Type
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16",
"title":"Invalid content",
"detail":"Content type not supported"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
500 Response
Internal Server Error
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1",
"title":"Internal Server Error",
"detail":"Issue fulfilling request. Please retry or contact support"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
503 Response
Service Unavailable
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
"title":"Service Unavailable",
"detail":"Service Unavailable. Try again later"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source