API » Version 1 » Schemes

Obtains a list of schemes to which the current user has been granted access

Get Scheme List GET

Gets the list of schemes for which the current user has been granted access through one or more personas

Parameters

Response Parameters
ParameterNameTypeDescription
SchemesSchemesList (Optional)The list of schemes to which the current user has access
SchemeID
Scheme IdentifierNumberThe unique numeric identifier assigned to the scheme
SchemeName
Scheme NameStringThe name of the scheme
SchemeLogoLarge
Large Scheme LogoString (Optional)The path to a scheme logo of up to 128 x 128px in size
SchemeLogoSmall
Small Scheme LogoString (Optional)The path to a scheme logo of up to 32 x 32px in size

XML

Example Request 
GET https://api.casi.services/v1/schemes.eb HTTP/1.1
Accept: text/xml
Response Schema 
<?xml version="1.0" encoding="utf-8"?>
<xsd:schema elementFormDefault="qualified" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <xsd:element name="SchemeList">
    <xsd:complexType>
      <xsd:sequence>
        <xsd:element name="Schemes" minOccurs="0">
          <xsd:annotation>
            <xsd:documentation>The list of schemes to which the current user has access</xsd:documentation>
          </xsd:annotation>
          <xsd:complexType>
            <xsd:sequence>
              <xsd:element name="Item" minOccurs="0" maxOccurs="unbounded">
                <xsd:complexType>
                  <xsd:sequence>
                    <xsd:element name="SchemeID" type="xsd:double">
                      <xsd:annotation>
                        <xsd:documentation>The unique numeric identifier assigned to the scheme</xsd:documentation>
                      </xsd:annotation>
                    </xsd:element>
                    <xsd:element name="SchemeName" type="xsd:string">
                      <xsd:annotation>
                        <xsd:documentation>The name of the scheme</xsd:documentation>
                      </xsd:annotation>
                    </xsd:element>
                    <xsd:element name="SchemeLogoLarge" minOccurs="0" type="xsd:string">
                      <xsd:annotation>
                        <xsd:documentation>The path to a scheme logo of up to 128 x 128px in size</xsd:documentation>
                      </xsd:annotation>
                    </xsd:element>
                    <xsd:element name="SchemeLogoSmall" minOccurs="0" type="xsd:string">
                      <xsd:annotation>
                        <xsd:documentation>The path to a scheme logo of up to 32 x 32px in size</xsd:documentation>
                      </xsd:annotation>
                    </xsd:element>
                  </xsd:sequence>
                </xsd:complexType>
              </xsd:element>
            </xsd:sequence>
          </xsd:complexType>
        </xsd:element>
      </xsd:sequence>
    </xsd:complexType>
  </xsd:element>
</xsd:schema>
Example Response 
HTTP/1.1 200 OK
Content-Type: text/xml

<?xml version="1.0" encoding="utf-8"?>
<SchemeList>
  <Schemes>
    <Item>
      <SchemeID>xsd:double</SchemeID>
      <SchemeName>xsd:string</SchemeName>
      <SchemeLogoLarge>xsd:string</SchemeLogoLarge>
      <SchemeLogoSmall>xsd:string</SchemeLogoSmall>
    </Item>...</Schemes>
</SchemeList>

JSON

Example Request 
GET https://api.casi.services/v1/schemes.eb HTTP/1.1
Accept: application/json
Example Response 
HTTP/1.1 200 OK
Content-Type: application/json

{"Schemes":[{"SchemeID":Number,
      "SchemeName":String,
      "SchemeLogoLarge":String,
      "SchemeLogoSmall":String},
    ...]}

Test