SupplierConnect Gateway API

ScheduleRequest

Creates or Reschedules a SupplierConnect schedule. This will return the id of the schedule request created and the communication id of the notification sent.

The following routes are available for this service:
POST	/api/schedules
PUT	/api/schedules/{RequestId}

**ScheduleRequest** Parameters:
Name	Parameter	Data Type	Required	Description
RequestId	path	Guid	Yes	Id of the schedule request to be recreated
ScheduleDateTime	body	DateTime	Yes	Date/Time of the activity
Requester	body	ContactInfo	No
Supplier	body	ContactInfo	No
Project	body	ProjectInfo	No
PurchaseOrder	body	PurchaseOrderInfo	No
Activity	body	ActivityReference	No
Params	body	List<ScheduleParams>	No
Attachments	body	List<EmailAttachment>	No

**ContactInfo** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
Name	form	string	No
Email	form	string	No
Phone	form	string	No
ContactReference	form	ObjectReference	No

**ObjectReference** Parameters:
Name	Parameter	Data Type	Required
RmsTableContextId	form	Guid	No
AlternateKey	form	string	No
DataSourceInstanceId	form	Guid	No

**ProjectInfo** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
Name	form	string	No
Reference	form	string	No
Description	form	string	No
Address	form	string	No
HouseType	form	string	No
Elevation	form	string	No
CustomerName	form	string	No
Supervisor	form	ContactInfo	No
ProjectReference	form	ObjectReference	No

**PurchaseOrderInfo** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
Reference	form	string	No
PurchaseOrderReference	form	ObjectReference	No

**ActivityReference** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	Yes	Name/details of the activity
Notes	form	string	No

**ScheduleParams** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	No
Value	form	string	No

**EmailAttachment** Parameters:
Name	Parameter	Data Type	Required
FileName	form	string	No
ContentType	form	string	No
Path	form	string	No
Url	form	string	No
Length	form	long	No
StreamContent	form	string	No
AttachmentType	form	AttachmentType	No
ProcessedAndUploadedAsBlob	form	bool	No

**ScheduleResponse** Parameters:
Name	Parameter	Data Type	Required
ReferenceId	form	Guid	No
CommunicationId	form	Guid	No
Success	form	bool	No
Message	form	string	No
Payload	form	string	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/schedules 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,
		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
}