s1 API Host

<back to all web services

GetNotificationRequest

The following routes are available for this service:
GET, OPTIONS/api/admin/notifications/{id}Gets the specified notifications.User has to be authenticated and admin.
Parameters:
NameParameterData TypeRequiredDescription
IdpathstringYesThe id of the notification

To override the Content-type in your clients HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/GetNotificationRequest HTTP/1.1 
Host: s1-api-tst.fource.nl 
Content-Type: application/xml
Content-Length: length

<GetNotificationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/S1.Api.Domain.Models.Notifications">
  <Id>String</Id>
</GetNotificationRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetNotificationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/S1.Api.Domain.Models.Notifications">
  <Notification xmlns:d2p1="http://schemas.datacontract.org/2004/07/S1.Api.Domain.Models.Admin.Notifications">
    <d2p1:CompanyIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
    <d2p1:CompanyWarehouses i:nil="true" />
    <d2p1:Content>String</d2p1:Content>
    <d2p1:CustomerGroups xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
    <d2p1:ExpiryDate>0001-01-01T00:00:00</d2p1:ExpiryDate>
    <d2p1:Id>String</d2p1:Id>
    <d2p1:IsForAllCompanies>false</d2p1:IsForAllCompanies>
    <d2p1:IsForAllCompanyWarehouses>false</d2p1:IsForAllCompanyWarehouses>
    <d2p1:IsForAllCustomerGroups>false</d2p1:IsForAllCustomerGroups>
    <d2p1:PublishDate>0001-01-01T00:00:00</d2p1:PublishDate>
    <d2p1:Title>String</d2p1:Title>
  </Notification>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
      </d2p1:ResponseError>
    </d2p1:Errors>
  </ResponseStatus>
  <UrgentMessages xmlns:d2p1="http://schemas.datacontract.org/2004/07/S1.Api.Domain.Models.UrgentMessages" i:nil="true" />
</GetNotificationResponse>