IPrimeSuiteAPI REST API Documentation
FlagListGet
Method: POST
URI Template: https://api-test.greenwaymedical.com/Integration/RESTv1.0/PrimeSuiteAPIService/FlagListGet
Request Format: Xml or Json
Request XML Example (schema):
<?xml version="1.0" encoding="utf-16"?>
<FlagListGetRequest>
<Header>
<SourceSiteID>String Content</SourceSiteID>
<DestinationSiteID>String Content</DestinationSiteID>
<PrimeSuiteUserID>0</PrimeSuiteUserID>
</Header>
<Credentials>
<PrimeSuiteCredential>
<PrimeSuiteSiteId>String Content</PrimeSuiteSiteId>
<PrimeSuiteUserName>String Content</PrimeSuiteUserName>
<PrimeSuiteUserPassword>String Content</PrimeSuiteUserPassword>
<PrimeSuiteUserAlias>String Content</PrimeSuiteUserAlias>
</PrimeSuiteCredential>
<VendorCredential>
<VendorLogin>String Content</VendorLogin>
<VendorPassword>String Content</VendorPassword>
</VendorCredential>
</Credentials>
<Category>0</Category>
<PageSize>0</PageSize>
<PageStart>0</PageStart>
</FlagListGetRequest>
Request Json Example (schema):
{
"Header": {
"SourceSiteID": "String Content",
"DestinationSiteID": "String Content",
"PrimeSuiteUserID": 0
},
"Credentials": {
"PrimeSuiteCredential": {
"PrimeSuiteSiteId": "String Content",
"PrimeSuiteUserName": "String Content",
"PrimeSuiteUserPassword": "String Content",
"PrimeSuiteUserAlias": "String Content"
},
"VendorCredential": {
"VendorLogin": "String Content",
"VendorPassword": "String Content"
}
},
"Category": 0,
"PageSize": 0,
"PageStart": 0
}
Response Format: Xml
Response XML Example (schema):
<?xml version="1.0" encoding="utf-16"?>
<FlagListGetResponse>
<FlagItems>
<FlagId>0</FlagId>
<FlagLabel>String Content</FlagLabel>
<CategoryName>0</CategoryName>
<Icon>String Content</Icon>
<Priority>3</Priority>
<AlertPopUp>false</AlertPopUp>
<DisplayOnPage>false</DisplayOnPage>
<SelectedPage>0</SelectedPage>
<CoPayAmount>String Content</CoPayAmount>
<NoAppointmentSchedule>false</NoAppointmentSchedule>
</FlagItems>
<TotalRows>0</TotalRows>
</FlagListGetResponse>
Response Format: Json
Response Example (schema):
{
"FlagItems": [
{
"FlagId": 0,
"FlagLabel": "String Content",
"CategoryName": 0,
"Icon": "String Content",
"Priority": 3,
"AlertPopUp": false,
"DisplayOnPage": false,
"SelectedPage": 0,
"CoPayAmount": "String Content",
"NoAppointmentSchedule": false
}
],
"TotalRows": 0
}