GET | /api/lists/import | Get a list import template |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ListId | query | Guid | Yes | Filter by ListId. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Version | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ListImport | form | ListImport | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
TotalResults | form | int | No | |
Skip | form | int | No | |
Take | form | int | No | |
Links | form | List<Link> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
StatusDescription | form | string | No | |
ResponseStatus | form | ResponseStatus | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | No | |
RequestUrl | form | string | No | |
Method | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ListId | form | Guid | No | |
Description | form | string | No | |
Name | form | string | No | |
ListItems | form | List<ListItemImport> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /json/reply/GetListImport HTTP/1.1
Host: platform.gaelenlighten.com
Content-Type: application/json
Content-Length: length
{"Version":0}
HTTP/1.1 200 OK Content-Type: application/json 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"}]}