GET api/PaymentStatusTypes

Returns a list of all payment status types in your database

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of PaymentStatusType

Name	Type	Additional information
PaymentStatusTypeId	integer	None.
OrganizationId	integer	None.
Description	string	None.
IsActive	boolean	None.
IsSystemDefined	boolean	None.
Links	Collection of Link	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "PaymentStatusTypeId": 1,
    "OrganizationId": 2,
    "Description": "sample string 3",
    "IsActive": true,
    "IsSystemDefined": true,
    "Links": [
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "Type": "sample string 4"
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "Type": "sample string 4"
      }
    ]
  },
  {
    "PaymentStatusTypeId": 1,
    "OrganizationId": 2,
    "Description": "sample string 3",
    "IsActive": true,
    "IsSystemDefined": true,
    "Links": [
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "Type": "sample string 4"
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "Type": "sample string 4"
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfPaymentStatusType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProClassApi.Web.Api.Models">
  <PaymentStatusType>
    <Description>sample string 3</Description>
    <IsActive>true</IsActive>
    <IsSystemDefined>true</IsSystemDefined>
    <Links>
      <Link>
        <Href>sample string 2</Href>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
        <Type>sample string 4</Type>
      </Link>
      <Link>
        <Href>sample string 2</Href>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
        <Type>sample string 4</Type>
      </Link>
    </Links>
    <OrganizationId>2</OrganizationId>
    <PaymentStatusTypeId>1</PaymentStatusTypeId>
  </PaymentStatusType>
  <PaymentStatusType>
    <Description>sample string 3</Description>
    <IsActive>true</IsActive>
    <IsSystemDefined>true</IsSystemDefined>
    <Links>
      <Link>
        <Href>sample string 2</Href>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
        <Type>sample string 4</Type>
      </Link>
      <Link>
        <Href>sample string 2</Href>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
        <Type>sample string 4</Type>
      </Link>
    </Links>
    <OrganizationId>2</OrganizationId>
    <PaymentStatusTypeId>1</PaymentStatusTypeId>
  </PaymentStatusType>
</ArrayOfPaymentStatusType>