BootView WebApi

<back to all web services

GetCustomerNoticePrograms

The following routes are available for this service:
GET/customers/{customerId}/noticeprogramsGets a list of the given customer's notice programs. Only returns the list if this user has access to this customer.
GetCustomerNoticePrograms Parameters:
NameParameterData TypeRequiredDescription
CustomerIdpathGuidYesThe customer id

To override the Content-type in your clients, use the 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.

GET /customers/{customerId}/noticeprograms HTTP/1.1 
Host: api.paylock.com 
Accept: application/xml

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

<ArrayOfCustomerNoticeProgram xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <CustomerNoticeProgram>
    <CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
    <Description>String</Description>
    <Id>0</Id>
    <IsActive>false</IsActive>
    <IsInvoiceable>false</IsInvoiceable>
    <SendNotification>false</SendNotification>
  </CustomerNoticeProgram>
</ArrayOfCustomerNoticeProgram>