GET api/Data/SchoolListForPartner?PartnerKey={PartnerKey}&options={options}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
PartnerKey

string

Required

options

integer

Default value is 0

Body Parameters

None.

Response Information

Resource Description

ApiCustomersResponse
NameDescriptionTypeAdditional information
errorMsg

string

None.

Customers

Collection of ApiCustomer

None.

Response Formats

application/json, text/json

Sample:
{
  "errorMsg": "sample string 1",
  "Customers": [
    {
      "Customerid": 1,
      "CustomerCode": "sample string 2",
      "Name": "sample string 3",
      "ApiKey": "sample string 4",
      "attributes": "sample string 5",
      "Logo": "sample string 6"
    },
    {
      "Customerid": 1,
      "CustomerCode": "sample string 2",
      "Name": "sample string 3",
      "ApiKey": "sample string 4",
      "attributes": "sample string 5",
      "Logo": "sample string 6"
    }
  ]
}

application/xml, text/xml

Sample:
<ApiCustomersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/m5api.Models">
  <Customers>
    <ApiCustomer>
      <ApiKey>sample string 4</ApiKey>
      <CustomerCode>sample string 2</CustomerCode>
      <Customerid>1</Customerid>
      <Logo>sample string 6</Logo>
      <Name>sample string 3</Name>
      <attributes>sample string 5</attributes>
    </ApiCustomer>
    <ApiCustomer>
      <ApiKey>sample string 4</ApiKey>
      <CustomerCode>sample string 2</CustomerCode>
      <Customerid>1</Customerid>
      <Logo>sample string 6</Logo>
      <Name>sample string 3</Name>
      <attributes>sample string 5</attributes>
    </ApiCustomer>
  </Customers>
  <errorMsg>sample string 1</errorMsg>
</ApiCustomersResponse>