| Requires any of the roles: | Worker, Agent, Administrator |
| GET,POST,OPTIONS | /v1/Notice/{NoticeId} | ||
|---|---|---|---|
| GET,OPTIONS | /v1/Notice | ||
| GET,OPTIONS | /v1/Notice/History/{DateAsOf} |
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
public class dtos
{
public static class NoticeRequest
{
public Date DateAsOf = null;
public ArrayList<Notice> Notice = new ArrayList<Notice>();
public Date getDateAsOf() { return DateAsOf; }
public NoticeRequest setDateAsOf(Date value) { this.DateAsOf = value; return this; }
public ArrayList<Notice> getNotice() { return Notice; }
public NoticeRequest setNotice(ArrayList<Notice> value) { this.Notice = value; return this; }
}
public static class Notice
{
public Integer NoticeId = null;
public Date BeginDate = null;
public Date ExpireDate = null;
public String NoticeTitle = null;
public String NoticeDescription = null;
public String NoticeFullText = null;
public Integer OrderIndex = null;
public Boolean IsActive = null;
public Boolean IsUrgent = null;
public Integer getNoticeId() { return NoticeId; }
public Notice setNoticeId(Integer value) { this.NoticeId = value; return this; }
public Date getBeginDate() { return BeginDate; }
public Notice setBeginDate(Date value) { this.BeginDate = value; return this; }
public Date getExpireDate() { return ExpireDate; }
public Notice setExpireDate(Date value) { this.ExpireDate = value; return this; }
public String getNoticeTitle() { return NoticeTitle; }
public Notice setNoticeTitle(String value) { this.NoticeTitle = value; return this; }
public String getNoticeDescription() { return NoticeDescription; }
public Notice setNoticeDescription(String value) { this.NoticeDescription = value; return this; }
public String getNoticeFullText() { return NoticeFullText; }
public Notice setNoticeFullText(String value) { this.NoticeFullText = value; return this; }
public Integer getOrderIndex() { return OrderIndex; }
public Notice setOrderIndex(Integer value) { this.OrderIndex = value; return this; }
public Boolean getIsActive() { return IsActive; }
public Notice setIsActive(Boolean value) { this.IsActive = value; return this; }
public Boolean getIsUrgent() { return IsUrgent; }
public Notice setIsUrgent(Boolean value) { this.IsUrgent = value; return this; }
}
public static class NoticeResponse
{
public ResponseStatus ResponseStatus = null;
public ArrayList<Notice> Notice = new ArrayList<Notice>();
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public NoticeResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
public ArrayList<Notice> getNotice() { return Notice; }
public NoticeResponse setNotice(ArrayList<Notice> value) { this.Notice = value; return this; }
}
}
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 /v1/Notice/{NoticeId} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<NoticeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<DateAsOf>0001-01-01T00:00:00</DateAsOf>
<Notice>
<Notice>
<BeginDate>0001-01-01T00:00:00</BeginDate>
<ExpireDate>0001-01-01T00:00:00</ExpireDate>
<IsActive>false</IsActive>
<IsUrgent>false</IsUrgent>
<NoticeDescription>String</NoticeDescription>
<NoticeFullText>String</NoticeFullText>
<NoticeId>0</NoticeId>
<NoticeTitle>String</NoticeTitle>
<OrderIndex>0</OrderIndex>
</Notice>
</Notice>
</NoticeRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<NoticeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Notice>
<Notice>
<BeginDate>0001-01-01T00:00:00</BeginDate>
<ExpireDate>0001-01-01T00:00:00</ExpireDate>
<IsActive>false</IsActive>
<IsUrgent>false</IsUrgent>
<NoticeDescription>String</NoticeDescription>
<NoticeFullText>String</NoticeFullText>
<NoticeId>0</NoticeId>
<NoticeTitle>String</NoticeTitle>
<OrderIndex>0</OrderIndex>
</Notice>
</Notice>
<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:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
</NoticeResponse>