GET api/DocumentTypes/{companyId}/Company?welfareId={welfareId}&stmBenefitId={stmBenefitId}

Return all document types for a company

Request Information

URI Parameters

Name	Type	Additional information
companyId	integer	Required
welfareId	integer	None.
stmBenefitId	integer	None.

Body Parameters

None.

Response Information

Resource Description

List of DocumentType

ServiceResultTypedOfListOfDocumentType

Name	Type	Additional information
Code	integer	None.
Errors	Collection of string	None.
Data	Collection of DocumentType	None.

Response Formats

application/json, text/json

Sample:

{
  "Code": 1,
  "Errors": [
    "sample string 1",
    "sample string 2"
  ],
  "Data": [
    {
      "DocumentTypeId": 1,
      "DocumentTypeName": "sample string 2",
      "SeqNo": 3,
      "IsRequired": true,
      "IsOtherDocument": true,
      "DocumentNameFormat": "sample string 6",
      "IsActive": true
    },
    {
      "DocumentTypeId": 1,
      "DocumentTypeName": "sample string 2",
      "SeqNo": 3,
      "IsRequired": true,
      "IsOtherDocument": true,
      "DocumentNameFormat": "sample string 6",
      "IsActive": true
    }
  ]
}

text/html

Sample:

{"Code":1,"Errors":["sample string 1","sample string 2"],"Data":[{"DocumentTypeId":1,"DocumentTypeName":"sample string 2","SeqNo":3,"IsRequired":true,"IsOtherDocument":true,"DocumentNameFormat":"sample string 6","IsActive":true},{"DocumentTypeId":1,"DocumentTypeName":"sample string 2","SeqNo":3,"IsRequired":true,"IsOtherDocument":true,"DocumentNameFormat":"sample string 6","IsActive":true}]}

application/xml, text/xml

Sample:

<ServiceResultTypedOfArrayOfDocumentTypeYj8O1tFc xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LSW.Common.Models">
  <Code>1</Code>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/TTMWM_MECLAIM_API.ViewModels">
    <d2p1:DocumentType>
      <d2p1:DocumentNameFormat>sample string 6</d2p1:DocumentNameFormat>
      <d2p1:DocumentTypeId>1</d2p1:DocumentTypeId>
      <d2p1:DocumentTypeName>sample string 2</d2p1:DocumentTypeName>
      <d2p1:IsActive>true</d2p1:IsActive>
      <d2p1:IsOtherDocument>true</d2p1:IsOtherDocument>
      <d2p1:IsRequired>true</d2p1:IsRequired>
      <d2p1:SeqNo>3</d2p1:SeqNo>
    </d2p1:DocumentType>
    <d2p1:DocumentType>
      <d2p1:DocumentNameFormat>sample string 6</d2p1:DocumentNameFormat>
      <d2p1:DocumentTypeId>1</d2p1:DocumentTypeId>
      <d2p1:DocumentTypeName>sample string 2</d2p1:DocumentTypeName>
      <d2p1:IsActive>true</d2p1:IsActive>
      <d2p1:IsOtherDocument>true</d2p1:IsOtherDocument>
      <d2p1:IsRequired>true</d2p1:IsRequired>
      <d2p1:SeqNo>3</d2p1:SeqNo>
    </d2p1:DocumentType>
  </Data>
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Errors>
</ServiceResultTypedOfArrayOfDocumentTypeYj8O1tFc>