| Requires any of the roles: | Agent, Administrator, Agent, Administrator |
| GET,OPTIONS | /v1/GetNoticeReport/{NoticeType} | ||
|---|---|---|---|
| PUT,OPTIONS | /v1/DisableNoticeReport/{NoticeType}/{AgentId} |
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
public class dtos
{
public static class NoticeReportRequest
{
public String NoticeType = null;
public Integer AgentId = null;
public String getNoticeType() { return NoticeType; }
public NoticeReportRequest setNoticeType(String value) { this.NoticeType = value; return this; }
public Integer getAgentId() { return AgentId; }
public NoticeReportRequest setAgentId(Integer value) { this.AgentId = value; return this; }
}
public static class NoticeReportResponse
{
public ResponseStatus ResponseStatus = null;
public ArrayList<NoticeAgreement> Notices = new ArrayList<NoticeAgreement>();
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public NoticeReportResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
public ArrayList<NoticeAgreement> getNotices() { return Notices; }
public NoticeReportResponse setNotices(ArrayList<NoticeAgreement> value) { this.Notices = value; return this; }
}
public static class NoticeAgreement
{
public Integer Id = null;
public Integer AgentId = null;
public String AgentName = null;
public String Status = null;
public Date SignedDate = null;
public Date FirstViewed = null;
public Date SnoozedDate = null;
public Integer getId() { return Id; }
public NoticeAgreement setId(Integer value) { this.Id = value; return this; }
public Integer getAgentId() { return AgentId; }
public NoticeAgreement setAgentId(Integer value) { this.AgentId = value; return this; }
public String getAgentName() { return AgentName; }
public NoticeAgreement setAgentName(String value) { this.AgentName = value; return this; }
public String getStatus() { return Status; }
public NoticeAgreement setStatus(String value) { this.Status = value; return this; }
public Date getSignedDate() { return SignedDate; }
public NoticeAgreement setSignedDate(Date value) { this.SignedDate = value; return this; }
public Date getFirstViewed() { return FirstViewed; }
public NoticeAgreement setFirstViewed(Date value) { this.FirstViewed = value; return this; }
public Date getSnoozedDate() { return SnoozedDate; }
public NoticeAgreement setSnoozedDate(Date value) { this.SnoozedDate = 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.
PUT /v1/GetNoticeReport/{NoticeType} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<NoticeReportRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<AgentId>0</AgentId>
<NoticeType>String</NoticeType>
</NoticeReportRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<NoticeReportResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Notices>
<NoticeAgreement>
<AgentId>0</AgentId>
<AgentName>String</AgentName>
<FirstViewed>0001-01-01T00:00:00</FirstViewed>
<Id>0</Id>
<SignedDate>0001-01-01T00:00:00</SignedDate>
<SnoozedDate>0001-01-01T00:00:00</SnoozedDate>
<Status>String</Status>
</NoticeAgreement>
</Notices>
<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>
</NoticeReportResponse>