POST api/v1/admin/fixedmessages
This method adds a new fixed message.
Request Information
URI Parameters
None.
Body Parameters
FixedMessageRequestName | Description | Type | Additional information |
---|---|---|---|
Name |
Name given to the fixed message |
string |
Required |
Message |
The fixed message |
string |
Required |
Request Formats
application/json, text/json
Sample:
{ "Name": "sample string 1", "Message": "sample string 2" }
application/xml, text/xml
Sample:
<FixedMessageRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Name>sample string 1</Name> <Message>sample string 2</Message> </FixedMessageRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ResponseOfObjectName | Description | Type | Additional information |
---|---|---|---|
Error | Error |
None. |
|
ResponseData | ResponseDataOfObject |
None. |
Response Formats
application/json, text/json
Sample:
{ "Error": { "ErrorCode": "sample string 1", "ErrorReason": "sample string 2" }, "ResponseData": { "Identification": { "UserId": "sample string 1" }, "Result": "sample string 1", "Detail": {} } }
application/xml, text/xml
Sample:
<ResponseOfObject xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Error> <ErrorCode>sample string 1</ErrorCode> <ErrorReason>sample string 2</ErrorReason> </Error> <ResponseData> <Result>sample string 1</Result> <Identification> <UserId>sample string 1</UserId> </Identification> <Detail /> </ResponseData> </ResponseOfObject>