POST MyPortal/GetCustomerList

Request Information

URI Parameters

None.

Body Parameters

PatientComms.API.Models.CustomerListRequest
NameDescriptionTypeAdditional information
AppKey

globally unique identifier

None.

ResellerId

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "AppKey": "dbe4efa0-606a-46e9-a11a-6e5d663a01b7",
  "ResellerId": 2
}

application/xml, text/xml

Sample:
<CustomerListRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PatientComms.API.Models">
  <AppKey>dbe4efa0-606a-46e9-a11a-6e5d663a01b7</AppKey>
  <ResellerId>2</ResellerId>
</CustomerListRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PatientComms.API.Models.CustomerListResponse
NameDescriptionTypeAdditional information
CustomerList

Collection of PatientComms.API.Models.CustomerListItem

None.

ErrorMessage

string

None.

ErrorStackTrace

string

None.

Response Formats

application/json, text/json

Sample:
{
  "CustomerList": [
    {
      "CustomerId": 1,
      "CustomerName": "sample string 2"
    },
    {
      "CustomerId": 1,
      "CustomerName": "sample string 2"
    }
  ],
  "ErrorMessage": "sample string 1",
  "ErrorStackTrace": "sample string 2"
}

application/xml, text/xml

Sample:
<CustomerListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PatientComms.API.Models">
  <CustomerList>
    <CustomerListItem>
      <CustomerId>1</CustomerId>
      <CustomerName>sample string 2</CustomerName>
    </CustomerListItem>
    <CustomerListItem>
      <CustomerId>1</CustomerId>
      <CustomerName>sample string 2</CustomerName>
    </CustomerListItem>
  </CustomerList>
  <ErrorMessage>sample string 1</ErrorMessage>
  <ErrorStackTrace>sample string 2</ErrorStackTrace>
</CustomerListResponse>