Coruson API

<back to all web services

GetListImport

Coruson Custom Lists

Requires Authentication
The following routes are available for this service:
GET/api/lists/importGet a list import template
GetListImport Parameters:
NameParameterData TypeRequiredDescription
ListIdqueryGuidYesFilter by ListId.
RequestBase Parameters:
NameParameterData TypeRequiredDescription
VersionformintNo
GetListImportResponse Parameters:
NameParameterData TypeRequiredDescription
ListImportformListImportNo
GetResponseBase Parameters:
NameParameterData TypeRequiredDescription
TotalResultsformintNo
SkipformintNo
TakeformintNo
LinksformList<Link>No
ResponseBase Parameters:
NameParameterData TypeRequiredDescription
StatusDescriptionformstringNo
ResponseStatusformResponseStatusNo
Link Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
RequestUrlformstringNo
MethodformstringNo
ListImport Parameters:
NameParameterData TypeRequiredDescription
ListIdformGuidNo
DescriptionformstringNo
NameformstringNo
ListItemsformList<ListItemImport>No
ListItemImport Parameters:
NameParameterData TypeRequiredDescription
ItemIdformGuidNo
CodeformstringNo
DescriptionformstringNo
NameformstringNo
ChildrenformList<ListItemImport>No

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

HTTP + CSV

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

                    POST /csv/reply/GetListImport HTTP/1.1 
Host: platform.gaelenlighten.com 
Content-Type: text/csv
Content-Length: length

{"Version":0}
                    
HTTP/1.1 200 OK
Content-Type: text/csv
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"}]}