AllAttachmentByContractNumber (GET) | GEP TECH DOCUMENTATION

Overview

This GET API allows retrieval of contracts attachments saved in GEP SMART to post them into ERP.

URL Format: https://<Instance>/SmartInterfaceAPI/api/Contract/AllAttachmentByContractNumber?contractNumber=ABC123

Request

Query Parameter:
contractNumber=ABC123 [ex: `contractNumber=ABC123]

Response

{
  "data": [{
  "name": Doc1.docx,
  "classification": ”CONTRACT LANGUAGE”,
  "type": ”File”,
  "data": ”Test Doc1 file”,
  "accesstoSupplier": Yes,
  "addedOn": ”2017-05-04 16:10:34.277”,
  "addedBy": “Admin”,
  "fileId": 143
}],
  "statusCode": null,
  "errorDetails": {
  "key": null,
  "errors": [{
  "errorCode": null,
  "errorDescription": null
}]
},
  "successDetails": {
  "errorCode": null,
  "errorDescription": null
}
}

Examples

Success Scenario - Request

?ContractNumber=ABC123

Success Scenario – Response

{
  "data": [{
    "name": “Doc1.docx”,
  "classification": ”CONTRACT LANGUAGE”,
  "type": ”File”,
  "data": “Test Doc1 file”,
  "accesstoSupplier": Yes,
  "addedOn": ”2017-05-04 16:10:34.277”,
  "addedBy": “Admin”,
  "fileId": 143
}],
  "statusCode": 200,
  "errorDetails":[],
  "successDetails": []
}

Data Elements

Get Contract Model
Property	Required?	Data type	Description	Validations/Exceptions
Data		List of InterfaceContractModel object
Status Code		String(100)
ErrorDetails		List of Error details
SuccessDetails		List of Success details

Data
Property	Required?	Data type	Description	Validations/Exceptions
ContractAttachment		List of ContractAttachment object	This will contain attachment name and file URL

ContractAttachment
Property	Required?	Data type	Description	Validations/Exceptions
Name		String	Name of an attachment.
Classification		String
Type		String	Type will contain any one from Notes, File, and External Link.
Data		String	Data will contain attachment URL.
AccesstoSupplier		String	It defines whether the attachment will be accessible to supplier or not.
AddedOn		String	Date on which the attachment is added.
AddedBy		String	Name of the person who has added the attachment.

ErrorDetails
Property	Required?	Data type	Description	Validations/Exceptions
Key		String
Errors		List of Error object

Errors
Property	Required?	Data type	Description	Validations/Exceptions
ErrorCode	String	String
ErrorDescription	String	String

SuccessDetails
Property	Required?	Data type	Description	Validations/Exceptions
Key	String	String