getPresorts

Description

Get the list of saved presorts of a given address table.

Example

Request

This request retrieves information on all saved presorts for the ALCORII address table.

{
  "addressTable" : "name$ALCORII"
}

Reply

{
  "presorts" : [
    {
      "presortName" : "STD-L 36",
      "dateCreate" : "9\/10\/2019 9:19:56"
    },
    {
      "presortName" : "STD-L 34",
      "dateCreate" : "9\/9\/2019 14:05:40"
    },
    {
      "presortName" : "STD-F",
      "dateCreate" : "8\/2\/2019 15:31:40"
    },
    {
      "presortName" : "STD",
      "dateCreate" : "4\/10\/2019 15:19:04"
    }
  ]
} 

Request Schema

{
  "$schema":"http://json-schema.org/draft-04/schema#",
  "description":"Get the list of saved presorts of a given address list.",
  "type":"object",
  "required":[
    "addressTable"
  ],
  "additionalProperties":false,
  "properties":{
    "addressTable":{
      "title":"Address Table",
      "description":"Reference used to determine the address list file.",
      "type":"string",
      "pattern":"(?i)^([0-9]{10}|name\\$.+|file\\$[a-z]+)$"
    }
  }
}

Reply Schema

{
  "$schema":"http://json-schema.org/draft-04/schema#",
  "description":"Reply for the getPresorts request.",
  "type":"object",
  "required":[
    "presorts"
  ],
  "properties":{
    "presorts":{
      "type":"array",
      "items":{
        "type":"object",
        "required":[
          "presortName",
          "dateCreate"
        ],
        "properties":{
          "presortName":{
             "title":"Presort Name",
             "description":"Unique description of the saved presort.",
             "default":"",
             "type":"string",
             "minLength":1,
             "maxLength":255
           },
          "dateCreate":{
            "type":"string"
          }
        }
      }
    }
  }
}