POST api/Search/XtMemoInbox
Request Information
URI Parameters
None.
Body Parameters
MemoInboxRequestName | Description | Type | Additional information |
---|---|---|---|
ToSiteGroupNum | integer |
None. |
|
ToContactNum | integer |
None. |
|
FromDepartment | string |
None. |
|
FromSiteGroupNum | integer |
None. |
|
FromContactNum | integer |
None. |
|
SessionNum | integer |
None. |
|
SessionPassword | Collection of byte |
None. |
|
ApplicationCode | string |
None. |
|
StagesURL | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "ToSiteGroupNum": 1, "ToContactNum": 1, "FromDepartment": "sample string 1", "FromSiteGroupNum": 1, "FromContactNum": 1, "SessionNum": 2, "SessionPassword": "QEA=", "ApplicationCode": "sample string 3", "StagesURL": "sample string 4" }
application/xml, text/xml
Sample:
<MemoInboxRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models"> <StagesURL>sample string 4</StagesURL> <ApplicationCode>sample string 3</ApplicationCode> <SessionNum>2</SessionNum> <SessionPassword>QEA=</SessionPassword> <FromContactNum>1</FromContactNum> <FromDepartment>sample string 1</FromDepartment> <FromSiteGroupNum>1</FromSiteGroupNum> <ToContactNum>1</ToContactNum> <ToSiteGroupNum>1</ToSiteGroupNum> </MemoInboxRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
XtMemoInboxQueryResultName | Description | Type | Additional information |
---|---|---|---|
ExcludeColumnList | Collection of string |
None. |
|
ResultSet | Collection of XtMemoInboxResult |
None. |
|
Success | boolean |
None. |
|
UserErrorMessage | string |
None. |
|
ErrorTypeNum | integer |
None. |
|
SqlConnectionLost | boolean |
None. |
|
ClientVersion | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "ExcludeColumnList": [ "sample string 1", "sample string 2" ], "ResultSet": [ { "ActionDateTime": "2024-05-01T14:34:22.3495937-04:00", "CreateAppUserNum": 1, "CreateDate": "2024-05-01T14:34:22.3495937-04:00", "DevNum": 1, "EventCodeWithDescr": "sample string 1", "From": "sample string 2", "FromDepartment": "sample string 3", "FromSiteGroupNum": 1, "HistoryServerNum": 1, "MarkAsReadFlag": true, "Memo": "sample string 4", "MemoNum": 1, "MemoSubject": "sample string 5", "Name": "sample string 6", "OriginalMemoNum": 1, "PointDescription": "sample string 7", "SeqNumBig": 1, "SiteName": "sample string 8", "SiteNum": 1, "To": "sample string 9", "ToContactNum": 1, "ToSiteGroupName": "sample string 10", "ToSiteGroupNum": 1, "TransmitterCode": "sample string 11" }, { "ActionDateTime": "2024-05-01T14:34:22.3495937-04:00", "CreateAppUserNum": 1, "CreateDate": "2024-05-01T14:34:22.3495937-04:00", "DevNum": 1, "EventCodeWithDescr": "sample string 1", "From": "sample string 2", "FromDepartment": "sample string 3", "FromSiteGroupNum": 1, "HistoryServerNum": 1, "MarkAsReadFlag": true, "Memo": "sample string 4", "MemoNum": 1, "MemoSubject": "sample string 5", "Name": "sample string 6", "OriginalMemoNum": 1, "PointDescription": "sample string 7", "SeqNumBig": 1, "SiteName": "sample string 8", "SiteNum": 1, "To": "sample string 9", "ToContactNum": 1, "ToSiteGroupName": "sample string 10", "ToSiteGroupNum": 1, "TransmitterCode": "sample string 11" } ], "Success": true, "UserErrorMessage": "sample string 2", "ErrorTypeNum": 3, "SqlConnectionLost": true, "ClientVersion": "sample string 5" }
application/xml, text/xml
Sample:
<XtMemoInboxQueryResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Stages"> <ClientVersion>sample string 5</ClientVersion> <ErrorTypeNum>3</ErrorTypeNum> <SqlConnectionLost>true</SqlConnectionLost> <Success>true</Success> <UserErrorMessage>sample string 2</UserErrorMessage> <ExcludeColumnList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </ExcludeColumnList> <ResultSet> <XtMemoInboxResult> <ActionDateTime>2024-05-01T14:34:22.3495937-04:00</ActionDateTime> <CreateAppUserNum>1</CreateAppUserNum> <CreateDate>2024-05-01T14:34:22.3495937-04:00</CreateDate> <DevNum>1</DevNum> <EventCodeWithDescr>sample string 1</EventCodeWithDescr> <From>sample string 2</From> <FromDepartment>sample string 3</FromDepartment> <FromSiteGroupNum>1</FromSiteGroupNum> <HistoryServerNum>1</HistoryServerNum> <MarkAsReadFlag>true</MarkAsReadFlag> <Memo>sample string 4</Memo> <MemoNum>1</MemoNum> <MemoSubject>sample string 5</MemoSubject> <Name>sample string 6</Name> <OriginalMemoNum>1</OriginalMemoNum> <PointDescription>sample string 7</PointDescription> <SeqNumBig>1</SeqNumBig> <SiteName>sample string 8</SiteName> <SiteNum>1</SiteNum> <To>sample string 9</To> <ToContactNum>1</ToContactNum> <ToSiteGroupName>sample string 10</ToSiteGroupName> <ToSiteGroupNum>1</ToSiteGroupNum> <TransmitterCode>sample string 11</TransmitterCode> </XtMemoInboxResult> <XtMemoInboxResult> <ActionDateTime>2024-05-01T14:34:22.3495937-04:00</ActionDateTime> <CreateAppUserNum>1</CreateAppUserNum> <CreateDate>2024-05-01T14:34:22.3495937-04:00</CreateDate> <DevNum>1</DevNum> <EventCodeWithDescr>sample string 1</EventCodeWithDescr> <From>sample string 2</From> <FromDepartment>sample string 3</FromDepartment> <FromSiteGroupNum>1</FromSiteGroupNum> <HistoryServerNum>1</HistoryServerNum> <MarkAsReadFlag>true</MarkAsReadFlag> <Memo>sample string 4</Memo> <MemoNum>1</MemoNum> <MemoSubject>sample string 5</MemoSubject> <Name>sample string 6</Name> <OriginalMemoNum>1</OriginalMemoNum> <PointDescription>sample string 7</PointDescription> <SeqNumBig>1</SeqNumBig> <SiteName>sample string 8</SiteName> <SiteNum>1</SiteNum> <To>sample string 9</To> <ToContactNum>1</ToContactNum> <ToSiteGroupName>sample string 10</ToSiteGroupName> <ToSiteGroupNum>1</ToSiteGroupNum> <TransmitterCode>sample string 11</TransmitterCode> </XtMemoInboxResult> </ResultSet> </XtMemoInboxQueryResult>