| POST | /api/schedules/{RequestId}/cancel |
|---|
namespace Eros.Saguna.Common.Library
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type ScheduleResponse() =
member val ReferenceId:Guid = new Guid() with get,set
member val CommunicationId:Guid = new Guid() with get,set
member val Success:Boolean = new Boolean() with get,set
member val Message:String = null with get,set
member val Payload:String = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type ObjectReference() =
[<DataMember(Name="RmsTableContextId")>]
member val RmsTableContextId:Guid = new Guid() with get,set
[<DataMember(Name="AlternateKey")>]
member val AlternateKey:String = null with get,set
[<DataMember(Name="DataSourceInstanceId")>]
member val DataSourceInstanceId:Guid = new Guid() with get,set
[<DataContract>]
[<AllowNullLiteral>]
type ContactInfo() =
[<DataMember(Name="Id")>]
member val Id:Guid = new Guid() with get,set
[<DataMember(Name="Name")>]
member val Name:String = null with get,set
[<DataMember(Name="Email")>]
member val Email:String = null with get,set
[<DataMember(Name="Phone")>]
member val Phone:String = null with get,set
[<DataMember(Name="ContactReference")>]
member val ContactReference:ObjectReference = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type ProjectInfo() =
[<DataMember(Name="Id")>]
member val Id:Guid = new Guid() with get,set
[<DataMember(Name="Name")>]
member val Name:String = null with get,set
[<DataMember(Name="Reference")>]
member val Reference:String = null with get,set
[<DataMember(Name="Description")>]
member val Description:String = null with get,set
[<DataMember(Name="Address")>]
member val Address:String = null with get,set
[<DataMember(Name="HouseType")>]
member val HouseType:String = null with get,set
[<DataMember(Name="Elevation")>]
member val Elevation:String = null with get,set
[<DataMember(Name="CustomerName")>]
member val CustomerName:String = null with get,set
[<DataMember(Name="Supervisor")>]
member val Supervisor:ContactInfo = null with get,set
[<DataMember(Name="ProjectReference")>]
member val ProjectReference:ObjectReference = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type PurchaseOrderInfo() =
[<DataMember(Name="Id")>]
member val Id:Guid = new Guid() with get,set
[<DataMember(Name="Reference")>]
member val Reference:String = null with get,set
[<DataMember(Name="Description")>]
member val Description:String = null with get,set
[<DataMember(Name="PurchaseOrderReference")>]
member val PurchaseOrderReference:ObjectReference = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type ActivityReference() =
///<summary>
///Name/details of the activity
///</summary>
[<DataMember(Name="name")>]
[<ApiMember(Description="Name/details of the activity", IsRequired=true, Name="Name")>]
member val Name:String = null with get,set
[<DataMember(Name="notes")>]
member val Notes:String = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type ScheduleParams() =
[<DataMember(Name="Name")>]
member val Name:String = null with get,set
[<DataMember(Name="Value")>]
member val Value:String = null with get,set
type AttachmentType =
| Url = 0
| FileStream = 1
[<AllowNullLiteral>]
type EmailAttachment() =
member val FileName:String = null with get,set
member val ContentType:String = null with get,set
member val Path:String = null with get,set
member val Url:String = null with get,set
member val Length:Int64 = new Int64() with get,set
member val FileStream:Stream = null with get,set
member val StreamContent:String = null with get,set
member val AttachmentType:AttachmentType = new AttachmentType() with get,set
member val ProcessedAndUploadedAsBlob:Boolean = new Boolean() with get,set
///<summary>
///Creates or Reschedules a SupplierConnect schedule. This will return the id of the schedule request created and the communication id of the notification sent.
///</summary>
[<Api(Description="Creates or Reschedules a SupplierConnect schedule. This will return the id of the schedule request created and the communication id of the notification sent.")>]
[<DataContract>]
[<AllowNullLiteral>]
type CancelScheduleRequest() =
///<summary>
///Id of the schedule request to be recreated
///</summary>
[<DataMember(Name="RequestId")>]
[<ApiMember(Description="Id of the schedule request to be recreated", IsRequired=true, Name="RequestId")>]
member val RequestId:Guid = new Guid() with get,set
///<summary>
///Date/Time of the activity
///</summary>
[<DataMember(Name="ScheduleDateTime")>]
[<ApiMember(Description="Date/Time of the activity", IsRequired=true, Name="ScheduleDateTime")>]
[<Required>]
member val ScheduleDateTime:DateTime = new DateTime() with get,set
[<DataMember(Name="Requester")>]
member val Requester:ContactInfo = null with get,set
[<DataMember(Name="Supplier")>]
member val Supplier:ContactInfo = null with get,set
[<DataMember(Name="Project")>]
member val Project:ProjectInfo = null with get,set
[<DataMember(Name="PurchaseOrder")>]
member val PurchaseOrder:PurchaseOrderInfo = null with get,set
[<DataMember(Name="Activity")>]
member val Activity:ActivityReference = null with get,set
[<DataMember(Name="Params")>]
member val Params:ResizeArray<ScheduleParams> = null with get,set
[<DataMember(Name="Attachments")>]
member val Attachments:ResizeArray<EmailAttachment> = null with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/schedules/{RequestId}/cancel HTTP/1.1
Host: production-eros-gateway-api-supplierconnect.azurewebsites.net
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
ScheduleDateTime: 0001-01-01,
Requester:
{
Name: String,
Email: String,
Phone: String,
ContactReference:
{
AlternateKey: String
}
},
Supplier:
{
Name: String,
Email: String,
Phone: String,
ContactReference:
{
AlternateKey: String
}
},
Project:
{
Name: String,
Reference: String,
Description: String,
Address: String,
HouseType: String,
Elevation: String,
CustomerName: String,
Supervisor:
{
Name: String,
Email: String,
Phone: String,
ContactReference:
{
AlternateKey: String
}
},
ProjectReference:
{
AlternateKey: String
}
},
PurchaseOrder:
{
Reference: String,
Description: String,
PurchaseOrderReference:
{
AlternateKey: String
}
},
Activity:
{
name: String,
notes: String
},
Params:
[
{
Name: String,
Value: String
}
],
Attachments:
[
{
FileName: String,
ContentType: String,
Path: String,
Url: String,
Length: 0,
StreamContent: String,
AttachmentType: Url,
ProcessedAndUploadedAsBlob: False
}
]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Success: False,
Message: String,
Payload: String
}