POST api/WestcorPayPortal/GetPayPortalSystemMessages

Gets System Messages for UI control.

Request Information

Parameters

Name	Description	Additional information
req		Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "SystemMessageID": 1,
  "SystemMessageTypeId": 2,
  "SystemMessageType": "sample string 3",
  "SystemMessage": "sample string 4",
  "Active": true,
  "StartDate": "2025-11-20T16:23:45.1108759+00:00",
  "EndDate": "2025-11-20T16:23:45.1108759+00:00",
  "CreatedBy": "sample string 6",
  "CreatedDate": "2025-11-20T16:23:45.1108759+00:00",
  "UpdatedBy": "sample string 7",
  "UpdatedDate": "2025-11-20T16:23:45.1108759+00:00",
  "Token": "sample string 8",
  "PartnerCode": "sample string 9"
}

application/xml, text/xml

Sample:

<GetPayPortalSystemMessages_Request xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Westcor.TMPOH.Poco.WestcorPayPortalObjects">
  <PartnerCode>sample string 9</PartnerCode>
  <Token>sample string 8</Token>
  <Active>true</Active>
  <CreatedBy>sample string 6</CreatedBy>
  <CreatedDate>2025-11-20T16:23:45.1108759+00:00</CreatedDate>
  <EndDate>2025-11-20T16:23:45.1108759+00:00</EndDate>
  <StartDate>2025-11-20T16:23:45.1108759+00:00</StartDate>
  <SystemMessage>sample string 4</SystemMessage>
  <SystemMessageID>1</SystemMessageID>
  <SystemMessageType>sample string 3</SystemMessageType>
  <SystemMessageTypeId>2</SystemMessageTypeId>
  <UpdatedBy>sample string 7</UpdatedBy>
  <UpdatedDate>2025-11-20T16:23:45.1108759+00:00</UpdatedDate>
</GetPayPortalSystemMessages_Request>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Response body formats

application/json, text/json

Sample:

[
  {
    "SystemMessageID": 1,
    "SystemMessageTypeId": 2,
    "SystemMessageType": "sample string 3",
    "SystemMessage": "sample string 4",
    "Active": true,
    "StartDate": "2025-11-20T16:23:45.1108759+00:00",
    "EndDate": "2025-11-20T16:23:45.1108759+00:00"
  },
  {
    "SystemMessageID": 1,
    "SystemMessageTypeId": 2,
    "SystemMessageType": "sample string 3",
    "SystemMessage": "sample string 4",
    "Active": true,
    "StartDate": "2025-11-20T16:23:45.1108759+00:00",
    "EndDate": "2025-11-20T16:23:45.1108759+00:00"
  },
  {
    "SystemMessageID": 1,
    "SystemMessageTypeId": 2,
    "SystemMessageType": "sample string 3",
    "SystemMessage": "sample string 4",
    "Active": true,
    "StartDate": "2025-11-20T16:23:45.1108759+00:00",
    "EndDate": "2025-11-20T16:23:45.1108759+00:00"
  }
]

application/xml, text/xml

Sample:

<ArrayOfGetPayPortalSystemMessages_Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Westcor.TMPOH.Poco.WestcorPayPortalObjects">
  <GetPayPortalSystemMessages_Result>
    <Active>true</Active>
    <EndDate>2025-11-20T16:23:45.1108759+00:00</EndDate>
    <StartDate>2025-11-20T16:23:45.1108759+00:00</StartDate>
    <SystemMessage>sample string 4</SystemMessage>
    <SystemMessageID>1</SystemMessageID>
    <SystemMessageType>sample string 3</SystemMessageType>
    <SystemMessageTypeId>2</SystemMessageTypeId>
  </GetPayPortalSystemMessages_Result>
  <GetPayPortalSystemMessages_Result>
    <Active>true</Active>
    <EndDate>2025-11-20T16:23:45.1108759+00:00</EndDate>
    <StartDate>2025-11-20T16:23:45.1108759+00:00</StartDate>
    <SystemMessage>sample string 4</SystemMessage>
    <SystemMessageID>1</SystemMessageID>
    <SystemMessageType>sample string 3</SystemMessageType>
    <SystemMessageTypeId>2</SystemMessageTypeId>
  </GetPayPortalSystemMessages_Result>
  <GetPayPortalSystemMessages_Result>
    <Active>true</Active>
    <EndDate>2025-11-20T16:23:45.1108759+00:00</EndDate>
    <StartDate>2025-11-20T16:23:45.1108759+00:00</StartDate>
    <SystemMessage>sample string 4</SystemMessage>
    <SystemMessageID>1</SystemMessageID>
    <SystemMessageType>sample string 3</SystemMessageType>
    <SystemMessageTypeId>2</SystemMessageTypeId>
  </GetPayPortalSystemMessages_Result>
</ArrayOfGetPayPortalSystemMessages_Result>