GET api/v2/Service/ListWOCategoryCodes?Page={Page}&PageSize={PageSize}&ListName={ListName}

Returns a list of Work Order Category Codes for the Page and Page Size specified.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
Page

Current page being requested.

integer

Required

PageSize

Number of records for page being requested.

integer

Required

ListName

Name of list for paged data.

string

Default value is

Body Parameters

None.

Response Information

Resource Description

CategoryCodeList
NameDescriptionTypeAdditional information
Content

Data for 1 page of Category Codes.

Collection of CategoryCode

None.

CurrentPage

Current Page being requested.

integer

None.

MaxPages

Total Number of pages.

integer

None.

PageSize

Number of record for page being request

integer

None.

ListName

Name of list for page data.

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Content": [
    {
      "Id": "sample string 1",
      "Desc": "sample string 2"
    },
    {
      "Id": "sample string 1",
      "Desc": "sample string 2"
    }
  ],
  "CurrentPage": 1,
  "MaxPages": 2,
  "PageSize": 3,
  "ListName": "sample string 4"
}

application/xml, text/xml

Sample:
<CategoryCodeList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/com.dockmaster.lib.models">
  <CurrentPage>1</CurrentPage>
  <ListName>sample string 4</ListName>
  <MaxPages>2</MaxPages>
  <PageSize>3</PageSize>
  <Content>
    <CategoryCode>
      <Desc>sample string 2</Desc>
      <Id>sample string 1</Id>
    </CategoryCode>
    <CategoryCode>
      <Desc>sample string 2</Desc>
      <Id>sample string 1</Id>
    </CategoryCode>
  </Content>
</CategoryCodeList>