Samples

Below are some ficitional samples of API requests for various scenarios.

Get All Forms

Request:

GET https://forms.symed.com/api/forms HTTP/1.1
Accept: application/json
Authorization: Bearer c6394ed8f1dc92a0fea52e36ab507d5b1
Host: forms.symed.com

Response:

[
  {
    "Id": "4cf5ed76-1785-446a-9dac-aef9f8f6fc06",
    "Filename": "SampleFile.PDF",
    "Filetype": "PDF",
    "Filepath": "C:/SamplePath/SampleFile.PDF",
    "Uri": "http://sampleuri.sample",
    "FileData": null,
    "Title": "Sample Title",
    "Description": "Sample description",
    "Tags": "Tag1,Tag2",
    "LastModified": "2015-05-08T09:32:10.0687896-05:00",
    "Version": null,
    "Filesize": 1233334,
    "Pages": 5,
    "State": "AK",
    "Organization": "BCBS",
    "Owner": "Symed",
    "Checksum": "33uPNEA="
  },
  {
    "Id": "d6d9c129-12e1-4776-ad9b-7c9de17b57b8",
    "Filename": "SampleFile2.PDF",
    "Filetype": "PDF",
    "Filepath": "C:/SamplePath/SampleFile2.PDF",
    "Uri": "http://sampleuri.sample",
    "FileData": null,
    "Title": "Sample Title 2",
    "Description": "Sample description 2",
    "Tags": "Tag1,Tag2",
    "LastModified": "2015-05-08T09:32:10.0687896-05:00",
    "Version": null,
    "Filesize": 234523,
    "Pages": 5,
    "State": "CO",
    "Organization": "BCBS",
    "Owner": "Symed",
    "Checksum": "dyIaVsg="
  }
]

Get Form Information By ID

Request:

GET https://forms.symed.com/api/forms/4cf5ed76-1785-446a-9dac-aef9f8f6fc06 HTTP/1.1
Accept: application/json
Authorization: Bearer c6394ed8f1dc92a0fea52e36ab507d5b1
Host: forms.symed.com

Response:

{
    "Id": "4cf5ed76-1785-446a-9dac-aef9f8f6fc06",
    "Filename": "SampleFile.PDF",
    "Filetype": "PDF",
    "Filepath": "C:/SamplePath/SampleFile.PDF",
    "Uri": "http://sampleuri.sample",
    "FileData": null,
    "Title": "Sample Title",
    "Description": "Sample description",
    "Tags": "Tag1,Tag2",
    "LastModified": "2015-05-08T09:32:10.0687896-05:00",
    "Version": null,
    "Filesize": 1233334,
    "Pages": 5,
    "State": "AK",
    "Organization": "BCBS",
    "Owner": "Symed",
    "Checksum": "33uPNEA="
}

Get Forms With Sort (By Title Descending)

Request:

GET https://forms.symed.com/api/forms?sort=-title HTTP/1.1
Accept: application/json
Authorization: Bearer c6394ed8f1dc92a0fea52e36ab507d5b1
Host: forms.symed.com

Response:

[
  {
    "Id": "d6d9c129-12e1-4776-ad9b-7c9de17b57b8",
    "Filename": "SampleFile2.PDF",
    "Filetype": "PDF",
    "Filepath": "C:/SamplePath/SampleFile2.PDF",
    "Uri": "http://sampleuri.sample",
    "FileData": null,
    "Title": "Sample Title 2",
    "Description": "Sample description 2",
    "Tags": "Tag1,Tag2",
    "LastModified": "2015-05-08T09:32:10.0687896-05:00",
    "Version": null,
    "Filesize": 234523,
    "Pages": 5,
    "State": "CO",
    "Organization": "BCBS",
    "Owner": "Symed",
    "Checksum": "dyIaVsg="
  },
  {
    "Id": "4cf5ed76-1785-446a-9dac-aef9f8f6fc06",
    "Filename": "SampleFile.PDF",
    "Filetype": "PDF",
    "Filepath": "C:/SamplePath/SampleFile.PDF",
    "Uri": "http://sampleuri.sample",
    "FileData": null,
    "Title": "Sample Title",
    "Description": "Sample description",
    "Tags": "Tag1,Tag2",
    "LastModified": "2015-05-08T09:32:10.0687896-05:00",
    "Version": null,
    "Filesize": 1233334,
    "Pages": 5,
    "State": "AK",
    "Organization": "BCBS",
    "Owner": "Symed",
    "Checksum": "33uPNEA="
  }
]

Get Form Information By ID With Fields Specified

Request:

GET https://forms.symed.com/api/forms/4cf5ed76-1785-446a-9dac-aef9f8f6fc06?fields=id,filename,title,description HTTP/1.1
Accept: application/json
Authorization: Bearer c6394ed8f1dc92a0fea52e36ab507d5b1
Host: forms.symed.com

Response:

{
    "Id": "4cf5ed76-1785-446a-9dac-aef9f8f6fc06",
    "Filename": "SampleFile.PDF",
    "Title": "Sample Title",
    "Description": "Sample description",
}

Get Form File Data

Request:

GET https://forms.symed.com/api/files/4cf5ed76-1785-446a-9dac-aef9f8f6fc06 HTTP/1.1
Authorization: Bearer c6394ed8f1dc92a0fea52e36ab507d5b1
Host: forms.symed.com

Response:

The file SampleFile.PDF