GET common/schemas/{id}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

Body Parameters

None.

Response Information

Resource Description

Schema
NameDescriptionTypeAdditional information
ID

integer

None.

DocumentCategoryID

integer

None.

Name

string

None.

Description

string

None.

Status

integer

None.

Items

None.

Response Formats

application/json, text/json

Sample:
{
  "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": "2024-04-26T02:19:09.7270384+00:00",
    "EditUser": 1,
    "EditTime": "2024-04-26T02:19:09.7270384+00:00"
  }
}

text/xml

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