GET BillSplitArrangement/GetBillSplitArrangement?splitNameSearch={splitNameSearch}&splitNameSearchType={splitNameSearchType}

Returns a list of Bill Split Arrangements and the departments referenced for each.

Request Information

URI Parameters

Name	Description	Type	Additional Information
splitNameSearch	The value to search Split Arrangement Names for. (Optional)	string	Default value is string.Empty
splitNameSearchType	How to search the Split Arrangement Name records. (Optional)	MatchStringEnum	Default value is StartsWith

Body Parameters

Response Information

Resource Description

Returns a list of Bill Split Arrangements and the departments referenced for each.

AgvBillSplitArrangement

Name	Description	Type
Status	Status of the API call.	string
Message	Message of the API call.	string
Count	Count of how many BillSplitArrangement JSON dictionaries.	string
BillSplitArrangements	JSON dictionary of BillSplitArrangement objects.	Collection of ClsSplitDept

Response Formats

application/json, text/json

Sample:

{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "Count": "2",
  "BillSplitArrangements": [
    {
      "UniqueID": 5,
      "SplitName": "sample string 6",
      "Departments": [
        {
          "DeptID": "sample string 3",
          "DepartmentName": "sample string 4"
        },
        {
          "DeptID": "sample string 3",
          "DepartmentName": "sample string 4"
        }
      ]
    },
    {
      "UniqueID": 5,
      "SplitName": "sample string 6",
      "Departments": [
        {
          "DeptID": "sample string 3",
          "DepartmentName": "sample string 4"
        },
        {
          "DeptID": "sample string 3",
          "DepartmentName": "sample string 4"
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<AgvBillSplitArrangement xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Field">
  <BillSplitArrangements xmlns:d2p1="http://schemas.datacontract.org/2004/07/SSI.Agv">
    <d2p1:SplitArrangement>
      <d2p1:Departments>
        <d2p1:SplitDeptDetail>
          <d2p1:DepartmentName>sample string 4</d2p1:DepartmentName>
          <d2p1:DeptID>sample string 3</d2p1:DeptID>
        </d2p1:SplitDeptDetail>
        <d2p1:SplitDeptDetail>
          <d2p1:DepartmentName>sample string 4</d2p1:DepartmentName>
          <d2p1:DeptID>sample string 3</d2p1:DeptID>
        </d2p1:SplitDeptDetail>
      </d2p1:Departments>
      <d2p1:SplitName>sample string 6</d2p1:SplitName>
      <d2p1:UniqueID>5</d2p1:UniqueID>
    </d2p1:SplitArrangement>
    <d2p1:SplitArrangement>
      <d2p1:Departments>
        <d2p1:SplitDeptDetail>
          <d2p1:DepartmentName>sample string 4</d2p1:DepartmentName>
          <d2p1:DeptID>sample string 3</d2p1:DeptID>
        </d2p1:SplitDeptDetail>
        <d2p1:SplitDeptDetail>
          <d2p1:DepartmentName>sample string 4</d2p1:DepartmentName>
          <d2p1:DeptID>sample string 3</d2p1:DeptID>
        </d2p1:SplitDeptDetail>
      </d2p1:Departments>
      <d2p1:SplitName>sample string 6</d2p1:SplitName>
      <d2p1:UniqueID>5</d2p1:UniqueID>
    </d2p1:SplitArrangement>
  </BillSplitArrangements>
  <Message>sample string 2</Message>
  <Status>sample string 1</Status>
</AgvBillSplitArrangement>