POST Api/TherapyLogging/GetSEMICannedNote

Request Information

URI Parameters

None.

Body Parameters

RequestNote
NameDescriptionTypeAdditional information
TS_ID

decimal number

None.

CampusName

string

None.

UserID

string

None.

DeviceID

string

None.

DeviceOS

string

None.

Version

string

None.

accessToken

string

Required

Matching regular expression pattern: ^a4768b1a-b5c1-4561-86e7-324b8a368354$

Request Formats

application/json, text/json

Sample:
{
  "TS_ID": 1.0,
  "CampusName": "sample string 1",
  "UserID": "sample string 2",
  "DeviceID": "sample string 3",
  "DeviceOS": "sample string 4",
  "Version": "sample string 5",
  "accessToken": "sample string 6"
}

text/html

Sample:
{"TS_ID":1.0,"CampusName":"sample string 1","UserID":"sample string 2","DeviceID":"sample string 3","DeviceOS":"sample string 4","Version":"sample string 5","accessToken":"sample string 6"}

application/xml, text/xml

Sample:
<RequestNote xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParadigmPioneer.Core.Model.AdminPanel">
  <CampusName xmlns="http://schemas.datacontract.org/2004/07/ParadigmPioneer.Core.Model">sample string 1</CampusName>
  <DeviceID xmlns="http://schemas.datacontract.org/2004/07/ParadigmPioneer.Core.Model">sample string 3</DeviceID>
  <DeviceOS xmlns="http://schemas.datacontract.org/2004/07/ParadigmPioneer.Core.Model">sample string 4</DeviceOS>
  <UserID xmlns="http://schemas.datacontract.org/2004/07/ParadigmPioneer.Core.Model">sample string 2</UserID>
  <Version xmlns="http://schemas.datacontract.org/2004/07/ParadigmPioneer.Core.Model">sample string 5</Version>
  <accessToken xmlns="http://schemas.datacontract.org/2004/07/ParadigmPioneer.Core.Model">sample string 6</accessToken>
  <TS_ID>1</TS_ID>
</RequestNote>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SemiNoteReturnResult
NameDescriptionTypeAdditional information
status

boolean

None.

message

string

None.

data

Collection of SEMINote

None.

totalCount

integer

None.

pageSize

integer

None.

currentPage

integer

None.

totalPages

integer

None.

previousPage

boolean

None.

nextPage

boolean

None.

accessToken

string

None.

Response Formats

application/json, text/json

Sample:
{
  "status": true,
  "message": "sample string 2",
  "data": [
    {
      "Note": "sample string 1",
      "Id": 1.0,
      "Abrev": "sample string 2"
    },
    {
      "Note": "sample string 1",
      "Id": 1.0,
      "Abrev": "sample string 2"
    }
  ],
  "totalCount": 3,
  "pageSize": 4,
  "currentPage": 5,
  "totalPages": 6,
  "previousPage": true,
  "nextPage": true,
  "accessToken": "a4768b1a-b5c1-4561-86e7-324b8a368354"
}

text/html

Sample:
{"status":true,"message":"sample string 2","data":[{"Note":"sample string 1","Id":1.0,"Abrev":"sample string 2"},{"Note":"sample string 1","Id":1.0,"Abrev":"sample string 2"}],"totalCount":3,"pageSize":4,"currentPage":5,"totalPages":6,"previousPage":true,"nextPage":true,"accessToken":"a4768b1a-b5c1-4561-86e7-324b8a368354"}

application/xml, text/xml

Sample:
<SemiNoteReturnResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParadigmPioneer.Core.Model.AdminPanel">
  <currentPage>5</currentPage>
  <data>
    <SEMINote>
      <Abrev>sample string 2</Abrev>
      <Id>1</Id>
      <Note>sample string 1</Note>
    </SEMINote>
    <SEMINote>
      <Abrev>sample string 2</Abrev>
      <Id>1</Id>
      <Note>sample string 1</Note>
    </SEMINote>
  </data>
  <message>sample string 2</message>
  <nextPage>true</nextPage>
  <pageSize>4</pageSize>
  <previousPage>true</previousPage>
  <status>true</status>
  <totalCount>3</totalCount>
  <totalPages>6</totalPages>
</SemiNoteReturnResult>