| POST | /customers/{customerId}/noticeprograms/{programId}/noticetypes | Creates a new notice type for the given customer's given notice program. Fails if this user does not have access to this customer or if either property is missing or the notice program doesn't exist. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CustomerId | path | Guid | Yes | The customer id |
| ProgramId | path | int | Yes | The notice program id |
| Name | body | string | Yes | The label to show, or the reason. |
| IsActive | body | bool | Yes | Whether the notice type is active (available) or not. |
| Sequence | body | int | No | This notice type's place in the seqence of other notice types within a notice program. |
| Hiatus | body | int | Yes | The length, in days before another notice should be issued. |
| IsRealTimeNotice | body | bool | No | Whether or not this notice type is a 'real-time' synchronized notice (i.e. events about it are sent between data partners as they happen). |
| IsEmailableNotice | body | bool | No | Whether or not this notice type is emailable (i.e. email our partner when a notice of this type happens). |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /customers/{customerId}/noticeprograms/{programId}/noticetypes HTTP/1.1
Host: api.paylock.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<CreateCustomerNoticeType 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>
<Hiatus>0</Hiatus>
<IsActive>false</IsActive>
<IsEmailableNotice>false</IsEmailableNotice>
<IsRealTimeNotice>false</IsRealTimeNotice>
<Name>String</Name>
<ProgramId>0</ProgramId>
<Sequence>0</Sequence>
</CreateCustomerNoticeType>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <int xmlns="http://schemas.microsoft.com/2003/10/Serialization/">0</int>