Upload File

Upload a file to the server

POST /api/.../files/{filegrouptype}

Upload a file to the server as a MIME multipart. Must use content-type of "multipart/form-data".

Returns an object that contains the file identifier. This file ID may be used with other API calls.

Files are placed in the path defined by web.config's "UploadsFilePath" value. Ultimately, the files are stored using the session context of the user ("{tenant}/users/{loggedOnUserID}/"). The default path is:

  • ~/App_Data/Uploads/{tenant}/users/{loggedOnUserID}
Note: At service startup, files older than 24 hours are automatically deleted.

Request Information

Parameters
Name Type Required Description
filegrouptype String Yes File group type values. "IDList" or "MARC"

IDList accepts files the following extenstions:
  • .csv
  • .txt
  • .xls
  • .xlsx

Response Information

Example
application/json, text/json 
{
  "FileID": "fdccd8c8-9d41-48f0-a050-7137ecd26772_txt"
}

HTTP Response Codes

Code Description
200 OK. Success
400 Bad Request. Check parameters and file extension.
406 NotAcceptable. MIME multipart request not formatted properly.