| 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 Foundation
import ServiceStack
public class NoticeRequest : Codable
{
public var dateAsOf:Date
public var notice:[Notice] = []
required public init(){}
}
public class Notice : Codable
{
public var noticeId:Int
public var beginDate:Date
public var expireDate:Date
public var noticeTitle:String
public var noticeDescription:String
public var noticeFullText:String
public var orderIndex:Int
public var isActive:Bool
public var isUrgent:Bool
required public init(){}
}
public class NoticeResponse : Codable
{
public var responseStatus:ResponseStatus
public var notice:[Notice] = []
required public init(){}
}
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>