Coruson API

GetListImport

Coruson Custom Lists

The following routes are available for this service:
GET	/api/lists/import	Get a list import template

**GetListImport** Parameters:
Name	Parameter	Data Type	Required	Description
ListId	query	Guid	Yes	Filter by ListId.

**RequestBase** Parameters:
Name	Parameter	Data Type	Required	Description
Version	form	int	No

**GetListImportResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ListImport	form	ListImport	No

**GetResponseBase** Parameters:
Name	Parameter	Data Type	Required
TotalResults	form	int	No
Skip	form	int	No
Take	form	int	No
Links	form	List<Link>	No

**ResponseBase** Parameters:
Name	Parameter	Data Type	Required	Description
StatusDescription	form	string	No
ResponseStatus	form	ResponseStatus	No

**Link** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
RequestUrl	form	string	No
Method	form	string	No

**ListImport** Parameters:
Name	Parameter	Data Type	Required
ListId	form	Guid	No
Description	form	string	No
Name	form	string	No
ListItems	form	List<ListItemImport>	No

**ListItemImport** Parameters:
Name	Parameter	Data Type	Required
ItemId	form	Guid	No
Code	form	string	No
Description	form	string	No
Name	form	string	No
Children	form	List<ListItemImport>	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 /jsv/reply/GetListImport HTTP/1.1 
Host: platform.gaelenlighten.com 
Content-Type: text/jsv
Content-Length: length

{
	Version: 0
}

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

{
	ListImport: 
	{
		Description: String,
		Name: String,
		ListItems: 
		[
			{
				Code: String,
				Description: String,
				Name: String,
				Children: 
				[
					{
						Code: String,
						Description: String,
						Name: String,
						Children: 
						[
							{
								Code: String,
								Description: String,
								Name: String
							}
						]
					}
				]
			}
		]
	},
	TotalResults: 0,
	StatusDescription: String,
	Skip: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Take: 0,
	Links: 
	[
		{
			Name: String,
			RequestUrl: String,
			Method: String
		}
	]
}