eQuipAPI

<back to all web services

GetDlmsTransactionSet

Returns a dlms transaction; Requires a valid user to complete this request.

The following routes are available for this service:
GET/dlms/transactions/{transaction_set_id}Returns a dlms transaction
GetDlmsTransactionSet Parameters:
NameParameterData TypeRequiredDescription
UserIDqueryGuidYesThe UserID that authorizes the caller to complete the request. Contact your eQuip admin.
transaction_set_idPathGuidYesThe Id of dlms transaction.
DlmsTransactionSet Parameters:
NameParameterData TypeRequiredDescription
IDbodyGuidNo
AssetIDbodyintNo
SiteIDbodyint?No
SiteNamebodystringNo
DlmsTransactionsRequestIDbodystringNo
ReceivedDateTimebodyDateTime?No
TransactionSetIdentifierCodebodystringNo
IdentifierTypebodystringNo
TransactionSetControlNumberbodystringNo
TransactionSetPurposeCodebodystringNo
TransactionSetPurposeNamebodystringNo
TransactionTypeCodebodystringNo
TransactionTypeNamebodystringNo
TransactionDateTimebodyDateTime?No
ReportStartDatebodyDateTime?No
ReportEndDatebodyDateTime?No
ActionCodebodystringNo
ReconciliationTypebodystringNo
ActionNamebodystringNo
NumberofIncludedSegmentsbodyintNo
TrailerTransactionSetControlNumberbodystringNo
TransactionXmlbodystringNo
IsTransactionXmlToBigToDisplaybodyboolNo
TransactionXmlToSearchDatabodystringNo
ErrorsbodystringNo
IsErrorsToBigToDisplaybodyboolNo
TransactionDirectionbodystringNo
TransactionUsagebodystringNo
DocumentNamebodystringNo
EventTagbodystringNo
IsPublishedbodybool?No
ResponseDueDatebodyDateTime?No
ResponseDatebodyDateTime?No
DateTimeLastGeneratedbodyDateTime?No
DateTimeLastGeneratedNewCatalogbodyDateTime?No
DateTimeLastGeneratedUpdateCatalogbodyDateTime?No
DateTimeGeneratedInventoryAdjustmentbodyDateTime?No
ProcessedStatusbodyint?No
ProcessStatusNamebodystringNo
TransactionOrganizationsbodyList<TransactionOrganization>No
TransactionPartsbodyList<TransactionPart>No
TransactionAssetsbodyList<Assets>No
OriginalTransactionsbodyList<DlmsTransactionXref>No
InventoryTransactionTypebodystringNo
XMLDocumentExceedsBytesMessagebodystringNo
EmailLogIDbodyintNo
RequisitionBase Parameters:
NameParameterData TypeRequiredDescription
CreatedBybodystringNo
ModifiedBybodystringNo
CreatedDatebodyDateTime?No
ModifiedDatebodyDateTime?No
TransactionOrganization Parameters:
NameParameterData TypeRequiredDescription
IDbodyGuidNo
DlmsTransactionSetIDbodyGuidNo
IdentificationIDbodyGuidNo
EntityIdentifierCodebodystringNo
EntityIdentifierNamebodystringNo
IdentificationCodeQualifierbodystringNo
IdentificationCodeQualifierNamebodystringNo
IdentificationCodebodystringNo
IdentificationCodeTextbodystringNo
EntityIdentifierCode1bodystringNo
EntityIdentifierCode1NamebodystringNo
OrganizationContactsbodyList<OrganizationContact>No
TransactionPart Parameters:
NameParameterData TypeRequiredDescription
PartIDbodyintNo
DlmsTransactionSetIDbodyGuidNo
DlmsItemIdentificationIDbodyGuidNo
PartNumberbodystringNo
DescriptionbodystringNo
ManufacturerPartNumberbodystringNo
StockNumberbodystringNo
NationalStockNumberbodystringNo
Assets Parameters:
NameParameterData TypeRequiredDescription
UuidbodyGuidNo
AssetIDbodyintNo
AssetStatebodystringNo
AssetNamebodystringNo
BarcodebodystringNo
SiteIDbodyintNo
LocationIDbodyintNo
OriginalPartNobodystringNo
UnitOfMeasurebodystringNo
UnitCostbodydecimal?No
IsInventoryMasterItembodyboolNo
IsInventoryItembodyboolNo
IsSerializedbodyboolNo
CreatedBybodystringNo
CreatedDatebodyDateTime?No
ModifiedBybodystringNo
ModifiedDatebodyDateTime?No
IsLockedbodyboolNo
ParentAssetIDbodyintNo
IsActivebodyboolNo
QuantitybodyintNo
SubLocationbodystringNo
DataGatherIDbodyint?No
PeopleIDbodyint?No
SecondaryCustodianIDbodyint?No
AlternateNamebodystringNo
AuditStatusbodystringNo
AssetStatusbodystringNo
AuditedBybodystringNo
AuditDatebodyDateTime?No
AssetSerialNobodystringNo
CurrentPartNobodystringNo
StockNumberbodystringNo
LocalStockNumberbodystringNo
MfgbodystringNo
MFGNobodystringNo
QuantityIssuedbodyintNo
LotNumberbodystringNo
DoDAACCodebodystringNo
IsInternalbodyboolNo
PurchaseOrderNobodystringNo
AuditJustification_ChangeTobodystringNo
Quantity_ChangeTobodyint?No
Quantity_ChangeFrombodyint?No
Pricebodydecimal?No
CagecodebodystringNo
AssetConditionbodystringNo
AssetConditionIDbodystringNo
AssetCondition_ChangeFrombodystringNo
AssetCondition_ChangeTobodystringNo
InventoryTransactionTypeCodebodystringNo
QuantityAdjustmentReasonCodebodystringNo
TransportationMethodbodystringNo
InvEnterpriseIDbodystringNo
DocNumberbodystringNo
StockNumber_ChangeTobodystringNo
LIN_ChangeTobodystringNo
MFG_ChangeTobodystringNo
GFCACodebodystringNo
IsManagedByApsrbodyboolNo
GFCACode_ChangeTobodystringNo
GFCACode_ChangeFrombodystringNo
Price_ChangeTobodydecimal?No
SupplyStatusTypeConditionCodebodystringNo
MatchingPartNumberbodystringNo
IsStockNumberExistsbodyboolNo
IsMFGExistsbodyboolNo
IsLINExistsbodyboolNo
IsMatchingPartExistsbodyboolNo
PartIdbodyintNo
PartID_NSNbodyintNo
PartID_MFGbodyintNo
PartID_LINbodyintNo
ContractNobodystringNo
AuditStatus_ChangeTobodystringNo
LastTransactionDocumentNumberbodystringNo
ProductTransferTypeCodebodystringNo
SourceDoDAACCodebodystringNo
TotalQuantitybodyintNo
DocumentIdentificationCodebodystringNo
DlmsTransactionXref Parameters:
NameParameterData TypeRequiredDescription
TransactionXrefRepositorybodyITransactionXrefRepository<DlmsTransactionXref>No
IDbodyGuidNo
SourceTransactionTypebodystringNo
ApplicationAcknowledgmentCodebodystringNo
ApplicationAcknowledgmentCodeNamebodystringNo
ReferenceIdentificationQualifierbodystringNo
ReferenceIdentificationQualifierNamebodystringNo
ReferenceIdentificationbodystringNo
TransactionSetControlNumberbodystringNo
TransactionSetIdentifierCodebodystringNo
TransactionSetPurposeCodebodystringNo
TransactionSetPurposeNamebodystringNo
TransactionTypeCodebodystringNo
TransactionTypeNamebodystringNo
ActionCodebodystringNo
IdentifierTypebodystringNo
SourceTransactionTypeCodebodystringNo
SourceTransactionSetControlNumberbodystringNo
ReferencedTransactionTypebodystringNo
ReferencedTransactionTypeCodebodystringNo
DlmsReferenceIdentificationsbodyList<DlmsReferenceIdentification>No
TechnicalErrorsbodyList<DlmsXrefTechnicalError>No
RejectAdviceCodesbodyList<DlmsXrefRejectAdviceCode>No
ReferencedTransactionsbodyList<DlmsTransactionXref>No
IdentifyingInformationbodystringNo
SourceTransactionIDbodyGuidNo
ReferencedTransactionIDbodyGuid?No
CreatedBybodystringNo
TransactionXmlbodystringNo
TransactionDirectionbodystringNo
ProcessedStatusbodyint?No
ErrorsbodystringNo
ModifiedBybodystringNo
IsErrorsToBigToDisplaybodyboolNo
TransactionDateTimebodyDateTime?No
ReceivedDateTimebodyDateTime?No
SourceTransactionSetIdentifierCodebodystringNo
SourceTransactionSetPurposeCodebodystringNo
SourceTransactionSetPurposeNamebodystringNo
ReferenceTransactionSetIdentifierCodebodystringNo
ReferenceTransactionSetPurposeCodebodystringNo
ReferenceTransactionSetPurposeNamebodystringNo
IdentificationIDbodyGuid?No
HasRegeneratedbodyboolNo
CreatedDatebodyDateTime?No

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /csv/reply/GetDlmsTransactionSet HTTP/1.1 
Host: equipstage2.e-isg.com 
Content-Type: text/csv
Content-Length: length

{"UserID":"String"}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"AssetID":0,"SiteID":0,"SiteName":"String","DlmsTransactionsRequestID":"String","ReceivedDateTime":"\/Date(-62135596800000)\/","TransactionSetIdentifierCode":"String","IdentifierType":"String","TransactionSetControlNumber":"String","TransactionSetPurposeCode":"String","TransactionSetPurposeName":"String","TransactionTypeCode":"String","TransactionTypeName":"String","TransactionDateTime":"\/Date(-62135596800000)\/","ReportStartDate":"\/Date(-62135596800000-0000)\/","ReportEndDate":"\/Date(-62135596800000-0000)\/","ActionCode":"String","ReconciliationType":"String","ActionName":"String","NumberofIncludedSegments":0,"TrailerTransactionSetControlNumber":"String","TransactionXml":"String","IsTransactionXmlToBigToDisplay":false,"TransactionXmlToSearchData":"String","Errors":"String","IsErrorsToBigToDisplay":false,"TransactionDirection":"String","TransactionUsage":"String","DocumentName":"String","EventTag":"String","IsPublished":false,"ResponseDueDate":"\/Date(-62135596800000)\/","ResponseDate":"\/Date(-62135596800000)\/","DateTimeLastGenerated":"\/Date(-62135596800000)\/","DateTimeLastGeneratedNewCatalog":"\/Date(-62135596800000)\/","DateTimeLastGeneratedUpdateCatalog":"\/Date(-62135596800000)\/","DateTimeGeneratedInventoryAdjustment":"\/Date(-62135596800000)\/","ProcessedStatus":0,"ProcessStatusName":"String","TransactionOrganizations":[{"EntityIdentifierCode":"String","EntityIdentifierName":"String","IdentificationCodeQualifier":"String","IdentificationCodeQualifierName":"String","IdentificationCode":"String","IdentificationCodeText":"String","EntityIdentifierCode1":"String","EntityIdentifierCode1Name":"String","OrganizationContacts":[{"TransactionOrganizationID":"00000000000000000000000000000000","ContactName":"String","PeopleID":0,"ContactFunctionCode":"String","ContactFunctionName":"String","CommunicationNumberQualifier":"String","CommunicationNumberQualifierName":"String","CommunicationNumber":"String","ContactInquiryReference":"String","CreatedBy":"String","ModifiedBy":"String","CreatedDate":"\/Date(-62135596800000-0000)\/","ModifiedDate":"\/Date(-62135596800000-0000)\/"}],"CreatedBy":"String","ModifiedBy":"String","CreatedDate":"\/Date(-62135596800000-0000)\/","ModifiedDate":"\/Date(-62135596800000-0000)\/"}],"TransactionParts":[{"PartID":0,"PartNumber":"String","Description":"String","ManufacturerPartNumber":"String","StockNumber":"String","NationalStockNumber":"String","CreatedBy":"String","ModifiedBy":"String","CreatedDate":"\/Date(-62135596800000-0000)\/","ModifiedDate":"\/Date(-62135596800000-0000)\/"}],"TransactionAssets":[{"AssetID":0,"AssetState":"String","AssetName":"String","Barcode":"String","SiteID":0,"LocationID":0,"OriginalPartNo":"String","UnitOfMeasure":"String","UnitCost":0,"IsInventoryMasterItem":false,"IsInventoryItem":false,"IsSerialized":false,"CreatedBy":"String","CreatedDate":"\/Date(-62135596800000-0000)\/","ModifiedBy":"String","ModifiedDate":"\/Date(-62135596800000-0000)\/","IsLocked":false,"ParentAssetID":0,"IsActive":false,"Quantity":0,"SubLocation":"String","DataGatherID":0,"PeopleID":0,"SecondaryCustodianID":0,"AlternateName":"String","AuditStatus":"String","AssetStatus":"String","AuditedBy":"String","AuditDate":"\/Date(-62135596800000-0000)\/","AssetSerialNo":"String","CurrentPartNo":"String","StockNumber":"String","LocalStockNumber":"String","Mfg":"String","MFGNo":"String","QuantityIssued":0,"LotNumber":"String","DoDAACCode":"String","IsInternal":false,"PurchaseOrderNo":"String","AuditJustification_ChangeTo":"String","Quantity_ChangeTo":0,"Quantity_ChangeFrom":0,"Price":0,"Cagecode":"String","AssetCondition":"String","AssetConditionID":"String","AssetCondition_ChangeFrom":"String","AssetCondition_ChangeTo":"String","InventoryTransactionTypeCode":"String","QuantityAdjustmentReasonCode":"String","TransportationMethod":"String","InvEnterpriseID":"String","DocNumber":"String","StockNumber_ChangeTo":"String","LIN_ChangeTo":"String","MFG_ChangeTo":"String","GFCACode":"String","IsManagedByApsr":false,"GFCACode_ChangeTo":"String","GFCACode_ChangeFrom":"String","Price_ChangeTo":0,"SupplyStatusTypeConditionCode":"String","MatchingPartNumber":"String","IsStockNumberExists":false,"IsMFGExists":false,"IsLINExists":false,"IsMatchingPartExists":false,"PartId":0,"PartID_NSN":0,"PartID_MFG":0,"PartID_LIN":0,"ContractNo":"String","AuditStatus_ChangeTo":"String","LastTransactionDocumentNumber":"String","ProductTransferTypeCode":"String","SourceDoDAACCode":"String","TotalQuantity":0,"DocumentIdentificationCode":"String"}],"OriginalTransactions":[{"SourceTransactionType":"String","ApplicationAcknowledgmentCode":"String","ApplicationAcknowledgmentCodeName":"String","ReferenceIdentificationQualifier":"String","ReferenceIdentificationQualifierName":"String","ReferenceIdentification":"String","TransactionSetControlNumber":"String","TransactionSetIdentifierCode":"String","TransactionSetPurposeCode":"String","TransactionSetPurposeName":"String","TransactionTypeCode":"String","TransactionTypeName":"String","ActionCode":"String","IdentifierType":"String","SourceTransactionTypeCode":"String","SourceTransactionSetControlNumber":"String","ReferencedTransactionType":"String","ReferencedTransactionTypeCode":"String","DlmsReferenceIdentifications":[{"ReferenceIdentificationQualifier":"String","ReferenceIdentificationQualifierName":"String","ReferenceIdentification":"String","FreeFormDescription":"String","IdentificationType":0,"ReferenceIdentificationQualifier1":"String","ReferenceIdentificationQualifier1Name":"String","ReferenceIdentification1":"String","ReferenceIdentificationQualifier2":"String","ReferenceIdentificationQualifier2Name":"String","ReferenceIdentification2":"String","ReferenceIdentificationQualifier3":"String","ReferenceIdentificationQualifier3Name":"String","ReferenceIdentification3":"String","CreatedBy":"String","ModifiedBy":"String","CreatedDate":"\/Date(-62135596800000-0000)\/","ModifiedDate":"\/Date(-62135596800000-0000)\/"}],"TechnicalErrors":[{"Code":"String","Message":"String","Status":1,"StatusName":"String","Notes":"String","CreatedBy":"String","ModifiedBy":"String"}],"RejectAdviceCodes":[{"IndustryCodeQualifier":"String","IndustryCodeQualifierName":"String","IndustryCode":"String","IndustryCodeName":"String","CreatedBy":"String"}],"ReferencedTransactions":[{"SourceTransactionType":"String","ApplicationAcknowledgmentCode":"String","ApplicationAcknowledgmentCodeName":"String","ReferenceIdentificationQualifier":"String","ReferenceIdentificationQualifierName":"String","ReferenceIdentification":"String","TransactionSetControlNumber":"String","TransactionSetIdentifierCode":"String","TransactionSetPurposeCode":"String","TransactionSetPurposeName":"String","TransactionTypeCode":"String","TransactionTypeName":"String","ActionCode":"String","IdentifierType":"String","SourceTransactionTypeCode":"String","SourceTransactionSetControlNumber":"String","ReferencedTransactionType":"String","ReferencedTransactionTypeCode":"String","DlmsReferenceIdentifications":[{"ReferenceIdentificationQualifier":"String","ReferenceIdentificationQualifierName":"String","ReferenceIdentification":"String","FreeFormDescription":"String","IdentificationType":0,"ReferenceIdentificationQualifier1":"String","ReferenceIdentificationQualifier1Name":"String","ReferenceIdentification1":"String","ReferenceIdentificationQualifier2":"String","ReferenceIdentificationQualifier2Name":"String","ReferenceIdentification2":"String","ReferenceIdentificationQualifier3":"String","ReferenceIdentificationQualifier3Name":"String","ReferenceIdentification3":"String","CreatedBy":"String","ModifiedBy":"String","CreatedDate":"\/Date(-62135596800000-0000)\/","ModifiedDate":"\/Date(-62135596800000-0000)\/"}],"TechnicalErrors":[{"Code":"String","Message":"String","Status":1,"StatusName":"String","Notes":"String","CreatedBy":"String","ModifiedBy":"String"}],"RejectAdviceCodes":[{"IndustryCodeQualifier":"String","IndustryCodeQualifierName":"String","IndustryCode":"String","IndustryCodeName":"String","CreatedBy":"String"}],"ReferencedTransactions":[{"SourceTransactionType":"String","ApplicationAcknowledgmentCode":"String","ApplicationAcknowledgmentCodeName":"String","ReferenceIdentificationQualifier":"String","ReferenceIdentificationQualifierName":"String","ReferenceIdentification":"String","TransactionSetControlNumber":"String","TransactionSetIdentifierCode":"String","TransactionSetPurposeCode":"String","TransactionSetPurposeName":"String","TransactionTypeCode":"String","TransactionTypeName":"String","ActionCode":"String","IdentifierType":"String","SourceTransactionTypeCode":"String","SourceTransactionSetControlNumber":"String","ReferencedTransactionType":"String","ReferencedTransactionTypeCode":"String","DlmsReferenceIdentifications":[{"ReferenceIdentificationQualifier":"String","ReferenceIdentificationQualifierName":"String","ReferenceIdentification":"String","FreeFormDescription":"String","IdentificationType":0,"ReferenceIdentificationQualifier1":"String","ReferenceIdentificationQualifier1Name":"String","ReferenceIdentification1":"String","ReferenceIdentificationQualifier2":"String","ReferenceIdentificationQualifier2Name":"String","ReferenceIdentification2":"String","ReferenceIdentificationQualifier3":"String","ReferenceIdentificationQualifier3Name":"String","ReferenceIdentification3":"String","CreatedBy":"String","ModifiedBy":"String","CreatedDate":"\/Date(-62135596800000-0000)\/","ModifiedDate":"\/Date(-62135596800000-0000)\/"}],"TechnicalErrors":[{"Code":"String","Message":"String","Status":1,"StatusName":"String","Notes":"String","CreatedBy":"String","ModifiedBy":"String"}],"RejectAdviceCodes":[{"IndustryCodeQualifier":"String","IndustryCodeQualifierName":"String","IndustryCode":"String","IndustryCodeName":"String","CreatedBy":"String"}],"IdentifyingInformation":"String","ReferencedTransactionID":"00000000000000000000000000000000","CreatedBy":"String","TransactionXml":"String","TransactionDirection":"String","ProcessedStatus":0,"Errors":"String","ModifiedBy":"String","IsErrorsToBigToDisplay":false,"TransactionDateTime":"\/Date(-62135596800000)\/","ReceivedDateTime":"\/Date(-62135596800000)\/","SourceTransactionSetIdentifierCode":"String","SourceTransactionSetPurposeCode":"String","SourceTransactionSetPurposeName":"String","ReferenceTransactionSetIdentifierCode":"String","ReferenceTransactionSetPurposeCode":"String","ReferenceTransactionSetPurposeName":"String","IdentificationID":"00000000000000000000000000000000","HasRegenerated":false,"CreatedDate":"\/Date(-62135596800000)\/"}],"IdentifyingInformation":"String","ReferencedTransactionID":"00000000000000000000000000000000","CreatedBy":"String","TransactionXml":"String","TransactionDirection":"String","ProcessedStatus":0,"Errors":"String","ModifiedBy":"String","IsErrorsToBigToDisplay":false,"TransactionDateTime":"\/Date(-62135596800000)\/","ReceivedDateTime":"\/Date(-62135596800000)\/","SourceTransactionSetIdentifierCode":"String","SourceTransactionSetPurposeCode":"String","SourceTransactionSetPurposeName":"String","ReferenceTransactionSetIdentifierCode":"String","ReferenceTransactionSetPurposeCode":"String","ReferenceTransactionSetPurposeName":"String","IdentificationID":"00000000000000000000000000000000","HasRegenerated":false,"CreatedDate":"\/Date(-62135596800000)\/"}],"IdentifyingInformation":"String","ReferencedTransactionID":"00000000000000000000000000000000","CreatedBy":"String","TransactionXml":"String","TransactionDirection":"String","ProcessedStatus":0,"Errors":"String","ModifiedBy":"String","IsErrorsToBigToDisplay":false,"TransactionDateTime":"\/Date(-62135596800000)\/","ReceivedDateTime":"\/Date(-62135596800000)\/","SourceTransactionSetIdentifierCode":"String","SourceTransactionSetPurposeCode":"String","SourceTransactionSetPurposeName":"String","ReferenceTransactionSetIdentifierCode":"String","ReferenceTransactionSetPurposeCode":"String","ReferenceTransactionSetPurposeName":"String","IdentificationID":"00000000000000000000000000000000","HasRegenerated":false,"CreatedDate":"\/Date(-62135596800000)\/"}],"InventoryTransactionType":"String","XMLDocumentExceedsBytesMessage":"String","EmailLogID":0,"CreatedBy":"String","ModifiedBy":"String","CreatedDate":"\/Date(-62135596800000-0000)\/","ModifiedDate":"\/Date(-62135596800000-0000)\/"}