POST api/v2/General/PayTypes/RetrievePayTypes

Retrieves a list of Pay Types

Request Information

URI Parameters

None.

Body Parameters

A list of pay type codes to retrieve. Leave blank to retrieve all paytypes.

Collection of string

Request Formats

application/json, text/json

Sample:

[
  "sample string 1",
  "sample string 2"
]

application/xml, text/xml

Sample:

<ArrayOfstring xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
  <string>sample string 1</string>
  <string>sample string 2</string>
</ArrayOfstring>

Response Information

Resource Description

Collection of PayType

Name	Description	Type	Additional information
Id		string	None.
Description		string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": "sample string 1",
    "Description": "sample string 2"
  },
  {
    "Id": "sample string 1",
    "Description": "sample string 2"
  }
]

application/xml, text/xml

Sample:

<ArrayOfPayType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/com.dockmaster.lib.models">
  <PayType>
    <Description>sample string 2</Description>
    <Id>sample string 1</Id>
  </PayType>
  <PayType>
    <Description>sample string 2</Description>
    <Id>sample string 1</Id>
  </PayType>
</ArrayOfPayType>