IPrimeSuiteAPI REST API Documentation


SystemIntKeyMapSearch


Method: POST

URI Template: https://api-test.greenwaymedical.com/Integration/RESTv1.0/PrimeSuiteAPIService/SystemIntKeyMapSearch

Request Format: Xml or Json

Request XML Example (schema): 

<?xml version="1.0" encoding="utf-16"?>
<IntKeyMapSearchRequest>
  <IntKeyMap>
    <IntKeyMapID>0</IntKeyMapID>
    <IntSenderReceiverID>0</IntSenderReceiverID>
    <IntSenderReceiverDescription>String Content</IntSenderReceiverDescription>
    <IntSenderReceiverIdentifier>String Content</IntSenderReceiverIdentifier>
    <RoleID>0</RoleID>
    <RoleName>String Content</RoleName>
    <RoleDescription>String Content</RoleDescription>
    <PrimeSuiteID>0</PrimeSuiteID>
    <ExternalID>String Content</ExternalID>
    <IntSenderReceiverConfig>String Content</IntSenderReceiverConfig>
  </IntKeyMap>
  <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>
</IntKeyMapSearchRequest>

Request Json Example (schema): 

{
  "IntKeyMap": {
    "IntKeyMapID": 0,
    "IntSenderReceiverID": 0,
    "IntSenderReceiverDescription": "String Content",
    "IntSenderReceiverIdentifier": "String Content",
    "RoleID": 0,
    "RoleName": "String Content",
    "RoleDescription": "String Content",
    "PrimeSuiteID": 0,
    "ExternalID": "String Content",
    "IntSenderReceiverConfig": "String Content"
  },
  "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"
    }
  }
}

Response Format: Xml

Response XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<IntKeyMapSearchResponse>
  <IntKeyMaps>
    <IntKeyMapID>0</IntKeyMapID>
    <IntSenderReceiverID>0</IntSenderReceiverID>
    <IntSenderReceiverDescription>String Content</IntSenderReceiverDescription>
    <IntSenderReceiverIdentifier>String Content</IntSenderReceiverIdentifier>
    <RoleID>0</RoleID>
    <RoleName>String Content</RoleName>
    <RoleDescription>String Content</RoleDescription>
    <PrimeSuiteID>0</PrimeSuiteID>
    <ExternalID>String Content</ExternalID>
    <IntSenderReceiverConfig>String Content</IntSenderReceiverConfig>
  </IntKeyMaps>
</IntKeyMapSearchResponse>

Response Format: Json

Response Example (schema):

{
  "IntKeyMaps": [
    {
      "IntKeyMapID": 0,
      "IntSenderReceiverID": 0,
      "IntSenderReceiverDescription": "String Content",
      "IntSenderReceiverIdentifier": "String Content",
      "RoleID": 0,
      "RoleName": "String Content",
      "RoleDescription": "String Content",
      "PrimeSuiteID": 0,
      "ExternalID": "String Content",
      "IntSenderReceiverConfig": "String Content"
    }
  ]
}