eQuipAPI

<back to all web services

GetRequisition

Returns a requisition; Requires a valid user to complete this request.

The following routes are available for this service:
GET/requisitions/{requisitionId}Returns a requisition
GetRequisition Parameters:
NameParameterData TypeRequiredDescription
UserIDqueryGuidYesThe UserID that authorizes the caller to complete the request. Contact your eQuip admin.
requisitionIdPathGuidYesThe Id of requisition.
Requisition Parameters:
NameParameterData TypeRequiredDescription
RequisitionRepositorybodyIRequisitionRepository<Requisition>No
IDbodyGuidNo
DlmsTransactionTransmissionIDbodyGuid?No
AssignedNumberbodyintNo
ContractNumberbodystringNo
ReleaseNumberbodystringNo
CreatedDatebodyDateTime?No
ModifiedDatebodyDateTime?No
ReferenceIdentificationQualifierbodystringNo
ReferenceIdentificationQualifierNamebodystringNo
ReferenceIdentificationbodystringNo
ReferenceIdentificationQualifier1bodystringNo
ReferenceIdentificationQualifier1NamebodystringNo
ReferenceIdentification1bodystringNo
LastGeneratedDatebodyDateTime?No
TransactionIDbodyGuid?No
TransactionSetControlNumberbodystringNo
RequisitionDemandDetailsbodyList<RequisitionDemandDetail>No
RequisitionItemsbodyList<RequisitionItem>No
RequisitionReferenceIdentificationsbodyList<DlmsReferenceIdentification>No
RequisitionTransactionsbodyList<DlmsTransactionsReference>No
RequisitionBase Parameters:
NameParameterData TypeRequiredDescription
CreatedBybodystringNo
ModifiedBybodystringNo
CreatedDatebodyDateTime?No
ModifiedDatebodyDateTime?No
RequisitionDemandDetail Parameters:
NameParameterData TypeRequiredDescription
IDbodyGuidNo
RequisitionIDbodyGuidNo
IndustryCodebodystringNo
IndustryCodeTextbodystringNo
CodeListQualifierCodebodystringNo
CodeListQualifierNamebodystringNo
IndustryCode1bodystringNo
IndustryCode1TextbodystringNo
CodeListQualifierCode1bodystringNo
CodeListQualifierName1bodystringNo
QuantitybodydecimalNo
IndustryCode2bodystringNo
IndustryCode2TextbodystringNo
CodeListQualifierCode2bodystringNo
CodeListQualifierName2bodystringNo
ReferenceIdentificationQualifierbodystringNo
ReferenceIdentificationQualifierTextbodystringNo
ReferenceIdentificationbodystringNo
RequisitionItem Parameters:
NameParameterData TypeRequiredDescription
IDbodyGuidNo
RequisitionIDbodyGuidNo
QuantityOrderedbodydecimalNo
PartIDbodyint?No
PartNamebodystringNo
UnitofMeasurebodystringNo
UnitofMeasureTextbodystringNo
UnitPricebodydecimalNo
BasisUnitPriceCodebodystringNo
BasisUnitPriceNamebodystringNo
ProductServiceIDQualifierbodystringNo
ProductServiceIDQualifierNamebodystringNo
ProductServiceIDbodystringNo
ProductServiceIDQualifier1bodystringNo
ProductServiceIDQualifier1NamebodystringNo
ProductServiceID1bodystringNo
ProductServiceIDQualifier2bodystringNo
ProductServiceIDQualifier2NamebodystringNo
ProductServiceID2bodystringNo
ProductServiceIDQualifier3bodystringNo
ProductServiceIDQualifier3NamebodystringNo
ProductServiceID3bodystringNo
ProductServiceIDQualifier4bodystringNo
ProductServiceIDQualifier4NamebodystringNo
ProductServiceID4bodystringNo
RequisitionItemStatusReportbodyList<RequisitionItemStatusReport>No
DlmsReferenceIdentification Parameters:
NameParameterData TypeRequiredDescription
IDbodyGuidNo
RequisitionIDbodyGuidNo
IdentificationIDbodyGuidNo
ReferenceIdentificationQualifierbodystringNo
ReferenceIdentificationQualifierNamebodystringNo
ReferenceIdentificationbodystringNo
FreeFormDescriptionbodystringNo
IdentificationTypebodyintNo
ReferenceIdentificationQualifier1bodystringNo
ReferenceIdentificationQualifier1NamebodystringNo
ReferenceIdentification1bodystringNo
ReferenceIdentificationQualifier2bodystringNo
ReferenceIdentificationQualifier2NamebodystringNo
ReferenceIdentification2bodystringNo
ReferenceIdentificationQualifier3bodystringNo
ReferenceIdentificationQualifier3NamebodystringNo
ReferenceIdentification3bodystringNo
DlmsTransactionsReference Parameters:
NameParameterData TypeRequiredDescription
IDbodyGuidNo
IdentificationIDbodyGuidNo
TransactionDateTimebodyDateTime?No
TransactionTypebodystringNo
TransactionTypeNamebodystringNo
ExpectedReplyDatebodyDateTime?No
ReportStartDatebodyDateTime?No
ReportEndDatebodyDateTime?No

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

HTTP + JSV

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

POST /jsv/reply/GetRequisition HTTP/1.1 
Host: equipstage3.e-isg.com 
Content-Type: text/jsv
Content-Length: length

{
	UserID: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	DlmsTransactionTransmissionID: 00000000000000000000000000000000,
	AssignedNumber: 0,
	ContractNumber: String,
	ReleaseNumber: String,
	CreatedDate: 0001-01-01,
	ModifiedDate: 0001-01-01,
	ReferenceIdentificationQualifier: String,
	ReferenceIdentificationQualifierName: String,
	ReferenceIdentification: String,
	ReferenceIdentificationQualifier1: String,
	ReferenceIdentificationQualifier1Name: String,
	ReferenceIdentification1: String,
	LastGeneratedDate: 0001-01-01,
	TransactionID: 00000000000000000000000000000000,
	TransactionSetControlNumber: String,
	RequisitionDemandDetails: 
	[
		{
			IndustryCode: String,
			IndustryCodeText: String,
			CodeListQualifierCode: String,
			CodeListQualifierName: String,
			IndustryCode1: String,
			IndustryCode1Text: String,
			CodeListQualifierCode1: String,
			CodeListQualifierName1: String,
			Quantity: 0,
			IndustryCode2: String,
			IndustryCode2Text: String,
			CodeListQualifierCode2: String,
			CodeListQualifierName2: String,
			ReferenceIdentificationQualifier: String,
			ReferenceIdentificationQualifierText: String,
			ReferenceIdentification: String,
			CreatedBy: String,
			ModifiedBy: String,
			CreatedDate: 0001-01-01,
			ModifiedDate: 0001-01-01
		}
	],
	RequisitionItems: 
	[
		{
			QuantityOrdered: 0,
			PartID: 0,
			PartName: String,
			UnitofMeasure: String,
			UnitofMeasureText: String,
			UnitPrice: 0,
			BasisUnitPriceCode: String,
			BasisUnitPriceName: String,
			ProductServiceIDQualifier: String,
			ProductServiceIDQualifierName: String,
			ProductServiceID: String,
			ProductServiceIDQualifier1: String,
			ProductServiceIDQualifier1Name: String,
			ProductServiceID1: String,
			ProductServiceIDQualifier2: String,
			ProductServiceIDQualifier2Name: String,
			ProductServiceID2: String,
			ProductServiceIDQualifier3: String,
			ProductServiceIDQualifier3Name: String,
			ProductServiceID3: String,
			ProductServiceIDQualifier4: String,
			ProductServiceIDQualifier4Name: String,
			ProductServiceID4: String,
			RequisitionItemStatusReport: 
			[
				{
					AllocationType: 0,
					ShipmentDate: 0001-01-01,
					Quantity: 0,
					OrderStatusCode: String,
					OrderStatusName: String,
					DateTimeQualifier: String,
					DateTimeQualifierName: String,
					CreatedBy: String,
					ModifiedBy: String,
					CreatedDate: 0001-01-01,
					ModifiedDate: 0001-01-01
				}
			],
			CreatedBy: String,
			ModifiedBy: String,
			CreatedDate: 0001-01-01,
			ModifiedDate: 0001-01-01
		}
	],
	RequisitionReferenceIdentifications: 
	[
		{
			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: 0001-01-01,
			ModifiedDate: 0001-01-01
		}
	],
	RequisitionTransactions: 
	[
		{
			TransactionDateTime: 0001-01-01,
			TransactionType: String,
			TransactionTypeName: String,
			ExpectedReplyDate: 0001-01-01,
			ReportStartDate: 0001-01-01,
			ReportEndDate: 0001-01-01,
			CreatedBy: String,
			ModifiedBy: String,
			CreatedDate: 0001-01-01,
			ModifiedDate: 0001-01-01
		}
	],
	CreatedBy: String,
	ModifiedBy: String
}