SupplierConnect Gateway API

GetSchedules

Retrieve SupplierConnect schedule(s) by given ids. This will return SupplierConnect schedule request(s), and the associated other details such as statuses

The following routes are available for this service:
GET	/api/schedules
GET	/api/schedules/{Ids}

**GetSchedules** Parameters:
Name	Parameter	Data Type	Required	Description
Ids	path	List<Guid>	Yes	Id or list of Ids of the schedule request(s) to be retrieved

**GetSchedulesResponse** Parameters:
Name	Parameter	Data Type	Required
Success	form	bool	No
Message	form	string	No
ScheduleRequests	form	List<ScheduleDetails>	No
ResponseStatus	form	ResponseStatus	No
LastRowVersion	form	string	No

**ScheduleDetails** Parameters:
Name	Parameter	Data Type	Required
ReferenceId	form	Guid	No
Index	form	int	No
StatusId	form	Guid	No
Status	form	string	No
StatusMessage	form	string	No
RequestedBy	form	string	No
RequestedDate	form	DateTime?	No
CommunicationId	form	Guid	No

**SupplierConnectSchedule** Parameters:
Name	Parameter	Data Type	Required
RequestId	form	Guid	No
PreviousRequestId	form	Guid	No
LicenseeId	form	Guid	No
LicenseeName	form	string	No
ScheduleDateTime	form	DateTime	No
Requester	form	SupplierConnectContactInfo	No
Supplier	form	SupplierConnectContactInfo	No
Project	form	SupplierConnectProjectInfo	No
PurchaseOrder	form	SupplierConnectPurchaseOrderInfo	No
Activity	form	SupplierConnectActivityReference	No
Params	form	List<SupplierConnectScheduleParams>	No
Attachments	form	List<EmailAttachment>	No

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

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

**SupplierConnectProjectInfo** 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
Supervisor	form	SupplierConnectContactInfo	No
CustomerName	form	string	No
ProjectReference	form	SupplierConnectObjectReference	No

**SupplierConnectPurchaseOrderInfo** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
Reference	form	string	No
Description	form	string	No
ProjectId	form	Guid	No
PurchaseOrderReference	form	SupplierConnectObjectReference	No

**SupplierConnectActivityReference** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	No
Notes	form	string	No

**SupplierConnectScheduleParams** 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
FileStream	form	Stream	No
StreamContent	form	string	No
AttachmentType	form	AttachmentType	No
ProcessedAndUploadedAsBlob	form	bool	No

**AttachmentType** Enum:
Url
FileStream

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.

GET /api/schedules HTTP/1.1 
Host: production-eros-gateway-api-supplierconnect.azurewebsites.net 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Success: False,
	Message: String,
	ScheduleRequests: 
	[
		{
			Index: 0,
			Status: String,
			StatusMessage: String,
			RequestedBy: String,
			RequestedDate: 0001-01-01,
			LicenseeName: String,
			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,
				Supervisor: 
				{
					Name: String,
					Email: String,
					Phone: String,
					ContactReference: 
					{
						AlternateKey: String
					}
				},
				CustomerName: 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
				}
			]
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	LastRowVersion: String
}