Creates a new notice program for the given customer. Fails if this user does not have access to this customer or if either property is missing. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CustomerId | path | Guid | Yes | The customer id |
Description | body | string | Yes | The label to show, or the program name. |
IsActive | body | bool | Yes | Whether the notice program is active (available) or not. |
SendNotification | body | bool | Yes | Whether the notice program can send notice notifications or not. |
IsInvoiceable | body | bool | Yes | Whether the notice program can be used for invoicing or not. |
To override the Content-type in your clients, use the HTTP Accept Header, append the .soap12 suffix or ?format=soap12
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /soap12 HTTP/1.1
Host: api.paylock.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<CreateCustomerNoticeProgram xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
<CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
<Description>String</Description>
<IsActive>false</IsActive>
<IsInvoiceable>false</IsInvoiceable>
<SendNotification>false</SendNotification>
</CreateCustomerNoticeProgram>
</soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <int xmlns="http://schemas.microsoft.com/2003/10/Serialization/">0</int> </soap12:Body> </soap12:Envelope>