GET api/QMS/UserDocuments/GetByLogin?LoginName={LoginName}&DocumentTypeID={DocumentTypeID}   QMS   All Services

This service returns all the User Documents associated with the give User LoginName. A DocumentTypeID can also optionaly be provided to also filter by DocumentType

Request Information

Headers

Fields Type M/O/C Definition
AccountLoginName String(50) Mandatory Login name of an account used for logging into Galaxy application to perform the service call
AccountPassword String(50) Mandatory Password of an account used for logging into Galaxy application to perform the service call
SourceSystemID String(50) Mandatory Name or ID of application or system that initiated the call.
DomainID String(50) Mandatory Name or ID of the domain that the call is being made to. (Value will be 1, if the site only has one domain)
Accept String Optional Format in which client expects the response: [application/json] (default), [application/xml]
ContentType String Optional Format in which client is sending the request: [application/json] (default), [application/xml]

Parameters

NameDescriptionAdditional informationType
LoginName 
User LoginName

Define this parameter in the request URI.

 String
DocumentTypeID 
None = 0, Passport = 1, Visa = 2, License = 3, Record = 4

Define this parameter in the request URI.

 Nullable<Int32>

Return Type

Return typeUserDocumentDTO[]
UserDocumentDTO:
PropertyNameTypeRequiredDescription
UserDocumentID Int32 Display
DocumentTypeID Int32 Mandatory
UserID Int32 Conditional
Title String Optional Maximum length: 500 chars
FileName String Optional Maximum length: 500 chars
ImagePath String Optional Maximum length: 150 chars
DocNumber String Optional Maximum length: 250 chars
CountryID String Optional Maximum length: 50 chars
ExpiryDate Nullable<DateTime> Optional
LoginName String Display

Response Information

Response body formats

application/json, text/json

Sample: 
[
  {
    "UserDocumentID": 1,
    "DocumentTypeID": 2,
    "UserID": 3,
    "Title": "sample string 4",
    "FileName": "sample string 5",
    "ImagePath": "sample string 6",
    "DocNumber": "sample string 7",
    "CountryID": "sample string 8",
    "ExpiryDate": "2025-05-09T12:20:39.3485801+00:00",
    "LoginName": "sample string 9"
  },
  {
    "UserDocumentID": 1,
    "DocumentTypeID": 2,
    "UserID": 3,
    "Title": "sample string 4",
    "FileName": "sample string 5",
    "ImagePath": "sample string 6",
    "DocNumber": "sample string 7",
    "CountryID": "sample string 8",
    "ExpiryDate": "2025-05-09T12:20:39.3485801+00:00",
    "LoginName": "sample string 9"
  },
  {
    "UserDocumentID": 1,
    "DocumentTypeID": 2,
    "UserID": 3,
    "Title": "sample string 4",
    "FileName": "sample string 5",
    "ImagePath": "sample string 6",
    "DocNumber": "sample string 7",
    "CountryID": "sample string 8",
    "ExpiryDate": "2025-05-09T12:20:39.3485801+00:00",
    "LoginName": "sample string 9"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfUserDocumentDTO xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <UserDocumentDTO>
    <UserDocumentID>1</UserDocumentID>
    <DocumentTypeID>2</DocumentTypeID>
    <UserID>3</UserID>
    <Title>sample string 4</Title>
    <FileName>sample string 5</FileName>
    <ImagePath>sample string 6</ImagePath>
    <DocNumber>sample string 7</DocNumber>
    <CountryID>sample string 8</CountryID>
    <ExpiryDate>2025-05-09T12:20:39.3485801+00:00</ExpiryDate>
    <LoginName>sample string 9</LoginName>
  </UserDocumentDTO>
  <UserDocumentDTO>
    <UserDocumentID>1</UserDocumentID>
    <DocumentTypeID>2</DocumentTypeID>
    <UserID>3</UserID>
    <Title>sample string 4</Title>
    <FileName>sample string 5</FileName>
    <ImagePath>sample string 6</ImagePath>
    <DocNumber>sample string 7</DocNumber>
    <CountryID>sample string 8</CountryID>
    <ExpiryDate>2025-05-09T12:20:39.3485801+00:00</ExpiryDate>
    <LoginName>sample string 9</LoginName>
  </UserDocumentDTO>
  <UserDocumentDTO>
    <UserDocumentID>1</UserDocumentID>
    <DocumentTypeID>2</DocumentTypeID>
    <UserID>3</UserID>
    <Title>sample string 4</Title>
    <FileName>sample string 5</FileName>
    <ImagePath>sample string 6</ImagePath>
    <DocNumber>sample string 7</DocNumber>
    <CountryID>sample string 8</CountryID>
    <ExpiryDate>2025-05-09T12:20:39.3485801+00:00</ExpiryDate>
    <LoginName>sample string 9</LoginName>
  </UserDocumentDTO>
</ArrayOfUserDocumentDTO>