POST api/Incoming/MessageFromParent
Request Information
URI Parameters
None.
Body Parameters
ApiIncomingMessageRequestName | Description | Type | Additional information |
---|---|---|---|
CustomerId | integer |
None. |
|
CustomerCode | string |
None. |
|
PartnerKey | string |
None. |
|
apiKey | string |
None. |
|
ContactId | string |
None. |
|
StudentId | string |
None. |
|
Topic | string |
None. |
|
Message | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "CustomerId": 1, "CustomerCode": "sample string 2", "PartnerKey": "sample string 3", "apiKey": "sample string 4", "ContactId": "sample string 5", "StudentId": "sample string 6", "Topic": "sample string 7", "Message": "sample string 8" }
application/xml, text/xml
Sample:
<ApiIncomingMessageRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/m5api.Models"> <ContactId>sample string 5</ContactId> <CustomerCode>sample string 2</CustomerCode> <CustomerId>1</CustomerId> <Message>sample string 8</Message> <PartnerKey>sample string 3</PartnerKey> <StudentId>sample string 6</StudentId> <Topic>sample string 7</Topic> <apiKey>sample string 4</apiKey> </ApiIncomingMessageRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ApiIncomingMessageResponseName | Description | Type | Additional information |
---|---|---|---|
CustomerId | integer |
None. |
|
errorMsg | string |
None. |
|
okMsg | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "CustomerId": 1, "errorMsg": "sample string 2", "okMsg": "sample string 3" }
application/xml, text/xml
Sample:
<ApiIncomingMessageResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/m5api.Models"> <CustomerId>1</CustomerId> <errorMsg>sample string 2</errorMsg> <okMsg>sample string 3</okMsg> </ApiIncomingMessageResponse>