GET Allowances/Find?Label={Label}&Description={Description}&SearchOperator={SearchOperator}

Finds all Allowances matching specified criteria.
Currently available querystring parameters:
Label, Description
Use SearchOperator=0 to specify an AND query or SearchOperator=1 for an OR query

Request Parameters
Response Samples

Parameters

Name	Description	Additional information
Label	Label	Define this parameter in the request URI.
Description	Description	Define this parameter in the request URI.
SearchOperator	SearchOperator	Define this parameter in the request URI.

Response body formats

A GetAllowancesRolesResponse containing matching Allowances.

application/json, text/json

Sample:

{
  "List": [
    {
      "Id": 1,
      "Label": "sample string 2",
      "Description": "sample string 3",
      "CurrencyId": 4,
      "NightHours": 5,
      "NightRate": 6.0,
      "AllowanceRates": [
        {
          "Id": 1,
          "AllowanceId": 2,
          "HourThreshold": 3,
          "HourlyRate": 4.0
        },
        {
          "Id": 1,
          "AllowanceId": 2,
          "HourThreshold": 3,
          "HourlyRate": 4.0
        },
        {
          "Id": 1,
          "AllowanceId": 2,
          "HourThreshold": 3,
          "HourlyRate": 4.0
        }
      ]
    },
    {
      "Id": 1,
      "Label": "sample string 2",
      "Description": "sample string 3",
      "CurrencyId": 4,
      "NightHours": 5,
      "NightRate": 6.0,
      "AllowanceRates": [
        {
          "Id": 1,
          "AllowanceId": 2,
          "HourThreshold": 3,
          "HourlyRate": 4.0
        },
        {
          "Id": 1,
          "AllowanceId": 2,
          "HourThreshold": 3,
          "HourlyRate": 4.0
        },
        {
          "Id": 1,
          "AllowanceId": 2,
          "HourThreshold": 3,
          "HourlyRate": 4.0
        }
      ]
    },
    {
      "Id": 1,
      "Label": "sample string 2",
      "Description": "sample string 3",
      "CurrencyId": 4,
      "NightHours": 5,
      "NightRate": 6.0,
      "AllowanceRates": [
        {
          "Id": 1,
          "AllowanceId": 2,
          "HourThreshold": 3,
          "HourlyRate": 4.0
        },
        {
          "Id": 1,
          "AllowanceId": 2,
          "HourThreshold": 3,
          "HourlyRate": 4.0
        },
        {
          "Id": 1,
          "AllowanceId": 2,
          "HourThreshold": 3,
          "HourlyRate": 4.0
        }
      ]
    }
  ],
  "ResponseInformation": {
    "Errors": [
      {
        "ErrorCode": "sample string 1",
        "Message": "sample string 2"
      },
      {
        "ErrorCode": "sample string 1",
        "Message": "sample string 2"
      },
      {
        "ErrorCode": "sample string 1",
        "Message": "sample string 2"
      }
    ],
    "Status": 0,
    "Links": [
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "IsTemplated": true
      }
    ]
  }
}

application/xml, text/xml

Sample:

<GetAllowancesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Responses">
  <ResponseInformation xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Common">
    <Errors>
      <ApiErrorDetail>
        <ErrorCode>sample string 1</ErrorCode>
        <Message>sample string 2</Message>
      </ApiErrorDetail>
      <ApiErrorDetail>
        <ErrorCode>sample string 1</ErrorCode>
        <Message>sample string 2</Message>
      </ApiErrorDetail>
      <ApiErrorDetail>
        <ErrorCode>sample string 1</ErrorCode>
        <Message>sample string 2</Message>
      </ApiErrorDetail>
    </Errors>
    <Links>
      <Link>
        <Href>sample string 2</Href>
        <IsTemplated>true</IsTemplated>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
      </Link>
      <Link>
        <Href>sample string 2</Href>
        <IsTemplated>true</IsTemplated>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
      </Link>
      <Link>
        <Href>sample string 2</Href>
        <IsTemplated>true</IsTemplated>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
      </Link>
    </Links>
    <Status>Failure</Status>
  </ResponseInformation>
  <List xmlns:d2p1="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Types" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Common">
    <d2p1:Allowance>
      <d2p1:AllowanceRates>
        <d2p1:AllowanceRate>
          <d2p1:AllowanceId>2</d2p1:AllowanceId>
          <d2p1:HourThreshold>3</d2p1:HourThreshold>
          <d2p1:HourlyRate>4</d2p1:HourlyRate>
          <d2p1:Id>1</d2p1:Id>
        </d2p1:AllowanceRate>
        <d2p1:AllowanceRate>
          <d2p1:AllowanceId>2</d2p1:AllowanceId>
          <d2p1:HourThreshold>3</d2p1:HourThreshold>
          <d2p1:HourlyRate>4</d2p1:HourlyRate>
          <d2p1:Id>1</d2p1:Id>
        </d2p1:AllowanceRate>
        <d2p1:AllowanceRate>
          <d2p1:AllowanceId>2</d2p1:AllowanceId>
          <d2p1:HourThreshold>3</d2p1:HourThreshold>
          <d2p1:HourlyRate>4</d2p1:HourlyRate>
          <d2p1:Id>1</d2p1:Id>
        </d2p1:AllowanceRate>
      </d2p1:AllowanceRates>
      <d2p1:CurrencyId>4</d2p1:CurrencyId>
      <d2p1:Description>sample string 3</d2p1:Description>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Label>sample string 2</d2p1:Label>
      <d2p1:NightHours>5</d2p1:NightHours>
      <d2p1:NightRate>6</d2p1:NightRate>
    </d2p1:Allowance>
    <d2p1:Allowance>
      <d2p1:AllowanceRates>
        <d2p1:AllowanceRate>
          <d2p1:AllowanceId>2</d2p1:AllowanceId>
          <d2p1:HourThreshold>3</d2p1:HourThreshold>
          <d2p1:HourlyRate>4</d2p1:HourlyRate>
          <d2p1:Id>1</d2p1:Id>
        </d2p1:AllowanceRate>
        <d2p1:AllowanceRate>
          <d2p1:AllowanceId>2</d2p1:AllowanceId>
          <d2p1:HourThreshold>3</d2p1:HourThreshold>
          <d2p1:HourlyRate>4</d2p1:HourlyRate>
          <d2p1:Id>1</d2p1:Id>
        </d2p1:AllowanceRate>
        <d2p1:AllowanceRate>
          <d2p1:AllowanceId>2</d2p1:AllowanceId>
          <d2p1:HourThreshold>3</d2p1:HourThreshold>
          <d2p1:HourlyRate>4</d2p1:HourlyRate>
          <d2p1:Id>1</d2p1:Id>
        </d2p1:AllowanceRate>
      </d2p1:AllowanceRates>
      <d2p1:CurrencyId>4</d2p1:CurrencyId>
      <d2p1:Description>sample string 3</d2p1:Description>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Label>sample string 2</d2p1:Label>
      <d2p1:NightHours>5</d2p1:NightHours>
      <d2p1:NightRate>6</d2p1:NightRate>
    </d2p1:Allowance>
    <d2p1:Allowance>
      <d2p1:AllowanceRates>
        <d2p1:AllowanceRate>
          <d2p1:AllowanceId>2</d2p1:AllowanceId>
          <d2p1:HourThreshold>3</d2p1:HourThreshold>
          <d2p1:HourlyRate>4</d2p1:HourlyRate>
          <d2p1:Id>1</d2p1:Id>
        </d2p1:AllowanceRate>
        <d2p1:AllowanceRate>
          <d2p1:AllowanceId>2</d2p1:AllowanceId>
          <d2p1:HourThreshold>3</d2p1:HourThreshold>
          <d2p1:HourlyRate>4</d2p1:HourlyRate>
          <d2p1:Id>1</d2p1:Id>
        </d2p1:AllowanceRate>
        <d2p1:AllowanceRate>
          <d2p1:AllowanceId>2</d2p1:AllowanceId>
          <d2p1:HourThreshold>3</d2p1:HourThreshold>
          <d2p1:HourlyRate>4</d2p1:HourlyRate>
          <d2p1:Id>1</d2p1:Id>
        </d2p1:AllowanceRate>
      </d2p1:AllowanceRates>
      <d2p1:CurrencyId>4</d2p1:CurrencyId>
      <d2p1:Description>sample string 3</d2p1:Description>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Label>sample string 2</d2p1:Label>
      <d2p1:NightHours>5</d2p1:NightHours>
      <d2p1:NightRate>6</d2p1:NightRate>
    </d2p1:Allowance>
  </List>
</GetAllowancesResponse>

GET Allowances/Find?Label={Label}&Description={Description}&SearchOperator={SearchOperator}

Parameters

Response body formats

application/json, text/json

application/xml, text/xml

URI parameters

Headers | Add header

Body

Status

Headers

Body