GET common/schemas?skip={skip}&take={take}&name={name}&category={category}&sort={sort}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
skip

integer

Default value is 0

take

integer

Default value is 50

name

string

None.

category

integer

None.

sort

string

None.

Body Parameters

None.

Response Information

Resource Description

PagedDataOfSchema
NameDescriptionTypeAdditional information
Data

Collection of Schema

None.

Count

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "Data": [
    {
      "ID": 1,
      "DocumentCategoryID": 2,
      "Name": "sample string 3",
      "Description": "sample string 4",
      "Status": 5,
      "Items": [
        {
          "ItemID": 1,
          "COA": "sample string 2",
          "PR": "sample string 3",
          "Description": "sample string 4",
          "Positive": 5,
          "TaxID": 1,
          "PostIndicator": "sample string 6"
        },
        {
          "ItemID": 1,
          "COA": "sample string 2",
          "PR": "sample string 3",
          "Description": "sample string 4",
          "Positive": 5,
          "TaxID": 1,
          "PostIndicator": "sample string 6"
        }
      ],
      "Audit": {
        "AddUser": 1,
        "AddTime": "2025-06-01T02:34:39.3273266+00:00",
        "EditUser": 1,
        "EditTime": "2025-06-01T02:34:39.3273266+00:00"
      }
    },
    {
      "ID": 1,
      "DocumentCategoryID": 2,
      "Name": "sample string 3",
      "Description": "sample string 4",
      "Status": 5,
      "Items": [
        {
          "ItemID": 1,
          "COA": "sample string 2",
          "PR": "sample string 3",
          "Description": "sample string 4",
          "Positive": 5,
          "TaxID": 1,
          "PostIndicator": "sample string 6"
        },
        {
          "ItemID": 1,
          "COA": "sample string 2",
          "PR": "sample string 3",
          "Description": "sample string 4",
          "Positive": 5,
          "TaxID": 1,
          "PostIndicator": "sample string 6"
        }
      ],
      "Audit": {
        "AddUser": 1,
        "AddTime": "2025-06-01T02:34:39.3273266+00:00",
        "EditUser": 1,
        "EditTime": "2025-06-01T02:34:39.3273266+00:00"
      }
    }
  ],
  "Count": 1
}

text/xml

Sample:
<PagedDataOfSchema43vHY0yQ xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Pixfin.DTO">
  <Count>1</Count>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Pixfin.DTO.Common.Schemas">
    <d2p1:Schema>
      <d2p1:Audit>
        <AddTime>2025-06-01T02:34:39.3273266+00:00</AddTime>
        <AddUser>1</AddUser>
        <EditTime>2025-06-01T02:34:39.3273266+00:00</EditTime>
        <EditUser>1</EditUser>
      </d2p1:Audit>
      <d2p1:Description>sample string 4</d2p1:Description>
      <d2p1:DocumentCategoryID>2</d2p1:DocumentCategoryID>
      <d2p1:ID>1</d2p1:ID>
      <d2p1:Items>
        <d2p1:Item>
          <d2p1:COA>sample string 2</d2p1:COA>
          <d2p1:Description>sample string 4</d2p1:Description>
          <d2p1:ItemID>1</d2p1:ItemID>
          <d2p1:PR>sample string 3</d2p1:PR>
          <d2p1:Positive>5</d2p1:Positive>
          <d2p1:PostIndicator>sample string 6</d2p1:PostIndicator>
          <d2p1:TaxID>1</d2p1:TaxID>
        </d2p1:Item>
        <d2p1:Item>
          <d2p1:COA>sample string 2</d2p1:COA>
          <d2p1:Description>sample string 4</d2p1:Description>
          <d2p1:ItemID>1</d2p1:ItemID>
          <d2p1:PR>sample string 3</d2p1:PR>
          <d2p1:Positive>5</d2p1:Positive>
          <d2p1:PostIndicator>sample string 6</d2p1:PostIndicator>
          <d2p1:TaxID>1</d2p1:TaxID>
        </d2p1:Item>
      </d2p1:Items>
      <d2p1:Name>sample string 3</d2p1:Name>
      <d2p1:Status>5</d2p1:Status>
    </d2p1:Schema>
    <d2p1:Schema>
      <d2p1:Audit>
        <AddTime>2025-06-01T02:34:39.3273266+00:00</AddTime>
        <AddUser>1</AddUser>
        <EditTime>2025-06-01T02:34:39.3273266+00:00</EditTime>
        <EditUser>1</EditUser>
      </d2p1:Audit>
      <d2p1:Description>sample string 4</d2p1:Description>
      <d2p1:DocumentCategoryID>2</d2p1:DocumentCategoryID>
      <d2p1:ID>1</d2p1:ID>
      <d2p1:Items>
        <d2p1:Item>
          <d2p1:COA>sample string 2</d2p1:COA>
          <d2p1:Description>sample string 4</d2p1:Description>
          <d2p1:ItemID>1</d2p1:ItemID>
          <d2p1:PR>sample string 3</d2p1:PR>
          <d2p1:Positive>5</d2p1:Positive>
          <d2p1:PostIndicator>sample string 6</d2p1:PostIndicator>
          <d2p1:TaxID>1</d2p1:TaxID>
        </d2p1:Item>
        <d2p1:Item>
          <d2p1:COA>sample string 2</d2p1:COA>
          <d2p1:Description>sample string 4</d2p1:Description>
          <d2p1:ItemID>1</d2p1:ItemID>
          <d2p1:PR>sample string 3</d2p1:PR>
          <d2p1:Positive>5</d2p1:Positive>
          <d2p1:PostIndicator>sample string 6</d2p1:PostIndicator>
          <d2p1:TaxID>1</d2p1:TaxID>
        </d2p1:Item>
      </d2p1:Items>
      <d2p1:Name>sample string 3</d2p1:Name>
      <d2p1:Status>5</d2p1:Status>
    </d2p1:Schema>
  </Data>
</PagedDataOfSchema43vHY0yQ>