POST api/QMS/UserDocuments/CreateByLogin?LoginName={LoginName}   QMS   All Services

This service creates the new User Document associated with the given Login name and returns the UserDocumentID value if successful.

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
Must provide in the URI

Define this parameter in the request URI.

String
model
Must provide valid DocumentTypeID

Define this parameter in the request body.

UserDocumentDTO
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

Request 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-09T11:16:29.8138658+00:00",
  "LoginName": "sample string 9"
}

application/xml, text/xml

Sample:
<UserDocumentDTO xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <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-09T11:16:29.8138658+00:00</ExpiryDate>
  <LoginName>sample string 9</LoginName>
</UserDocumentDTO>

Return Type

Return typeInt32

Response Information

Response body formats

application/json, text/json

Sample:
1

application/xml, text/xml

Sample:
<int>1</int>