POST api/communication/savePreDefinedMessage
Request Information
URI Parameters
None.
Body Parameters
PreDefinedMessageBindingModelName | Description | Type | Additional information |
---|---|---|---|
Message | string |
None. |
|
DebtorId | integer |
None. |
|
DebtorUniqueKey | string |
None. |
|
CompanyId | integer |
None. |
|
InvoiceId | integer |
None. |
Request Formats
application/json, text/json
Sample:
{ "message": "sample string 1", "debtorId": 2, "debtorUniqueKey": "sample string 3", "companyId": 4, "invoiceId": 5 }
application/xml, text/xml
Sample:
<PreDefinedMessageBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DigitalMoneyCollector.Repository.BindingModel"> <CompanyId>4</CompanyId> <DebtorId>2</DebtorId> <DebtorUniqueKey>sample string 3</DebtorUniqueKey> <InvoiceId>5</InvoiceId> <Message>sample string 1</Message> </PreDefinedMessageBindingModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ResponseModelName | Description | Type | Additional information |
---|---|---|---|
IsSuccess | boolean |
None. |
|
StatusCode | string |
None. |
|
ErrorDescription | string |
None. |
|
Message | string |
None. |
|
Data | Object |
None. |
Response Formats
application/json, text/json
Sample:
{ "isSuccess": true, "statusCode": "sample string 2", "errorDescription": "sample string 3", "message": "sample string 4", "data": {} }
application/xml, text/xml
Sample:
<ResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DigitalMoneyCollector.Repository.BindingModel"> <Data /> <ErrorDescription>sample string 3</ErrorDescription> <IsSuccess>true</IsSuccess> <Message>sample string 4</Message> <StatusCode>sample string 2</StatusCode> </ResponseModel>