GetAllCommentsAndAttachments (GET)

Overview

This GET API allows retrieval of all comments and attachments by Order Number, Revision Number details created in GEP SMART to post them into ERP. 

URL Format: https://<Instance>/SmartInterfaceAPI/api/ Order/GetAllCommentsAndAttachments
 

Request

Order Number is mandatory attribute for this API call. 

https://<Instance>/SmartInterfaceAPI/api/ Order/GetAllCommentsAndAttachments?orderNumber=303400014606&revisionNumber=001
 

Response
{
	"documentNumber": "string",
	"headerComments": [
		{
			"visiblefor": "string",
			"comment": "string",
			"attachments": [
				{
					"attachmentUrl": "string",
					"attachmentType": "string",
					"fileName": "string"
				}
			]
		}
	],
	"lineComments": [
		{
			"lineNumber": 0,
			"lineComments": [
				{
					"visiblefor": "string",
					"comment": "string",
					"attachments": [
						{
							"attachmentUrl": "string",
							"attachmentType": "string",
							"fileName": "string"
						}
					]
				}
			]
		}
	],
	"printPDF": {
		"attachmentType": "string",
		"contentType": "string",
		"extension": "string",
		"attachmentUrl": "string"
	}
}

 

Examples

Success Scenario - Request 

https://<Instance>/SmartInterfaceAPI/api/ Order/GetAllCommentsAndAttachments?orderNumber=303400014606&revisionNumber=001

Success Scenario - Response 

{
	"data": {
		"documentNumber": "303400014606",
		"headerComments": [
			{
				"visiblefor": "Internal Users",
				"comment": "ok",
				"attachments": [
					{
						"attachmentUrl": "https://smartqcmtstorage.blob.core.windows.net/buyersqlconn/70021790/Attachment/wp3703433-iron-man-4k-wallpapers.jpgwp3703433-iron-man-4k-wallpapers.jpgwp3703433-iron-man-4k-wallpapers.jpgwp3703433-iron-man-4k-wallpapers.jpg_3e24258dfc184c04815e56f36e8bab2b.jpg?sv=2018-03-28&sr=b&sig=10ufgsNhJLhS0FNFg9KN1srytYBt9KYS7OyhPBts3W4%3D&st=2020-07-20T18%3A21%3A19Z&se=2020-07-20T19%3A06%3A19Z&sp=r&rscd=attachment%3B%20filename%3D%22wp3703433-iron-man-4k-wallpapers.jpgwp3703433-iron-man-4k-wallpapers.jpgwp3703433-iron-man-4k-wallpapers.jpgwp3703433-iron-man-4k-wallpapers.jpg.jpg%22",
						"attachmentType": ".jpg",
						"fileName": "wp3703433-iron-man-4k-wallpapers.jpgwp3703433-iron-man-4k-wallpapers.jpgwp3703433-iron-man-4k-wallpapers.jpgwp3703433-iron-man-4k-wallpapers.jpg"
					}
				]
			},
			{
				"visiblefor": "Internal Users",
				"comment": "bvkjl;",
				"attachments": [
					{
						"attachmentUrl": "https://smartqcmtstorage.blob.core.windows.net/buyersqlconn/70021790/Attachment/wp4294841-batman-4k-wallpapers_14afb56d17e04af0af6fde8dcf8eb5a0.jpg?sv=2018-03-28&sr=b&sig=sHxkhRQsgGfZuOFLLCpjenQssPYWV%2FeylCwP484LI5A%3D&st=2020-07-20T18%3A21%3A38Z&se=2020-07-20T19%3A06%3A38Z&sp=r&rscd=attachment%3B%20filename%3D%22wp4294841-batman-4k-wallpapers.jpg%22",
						"attachmentType": ".jpg",
						"fileName": "wp4294841-batman-4k-wallpapers"
					},
					{
						"attachmentUrl": "https://smartqcmtstorage.blob.core.windows.net/buyersqlconn/70021790/Attachment/wp4294829-batman-4k-wallpapers_6fec0da64785412993f1fe9a4cdd2ac7.jpg?sv=2018-03-28&sr=b&sig=OFMH4%2BNzCI0%2BuHBL2UD8yi4ePDzWgI%2F6JnG7j2Xaw0o%3D&st=2020-07-20T18%3A21%3A42Z&se=2020-07-20T19%3A06%3A42Z&sp=r&rscd=attachment%3B%20filename%3D%22wp4294829-batman-4k-wallpapers.jpg%22",
						"attachmentType": ".jpg",
						"fileName": "wp4294829-batman-4k-wallpapers"
					}
				]
			}
		],
		"lineComments": [
			{
				"lineNumber": 1,
				"lineComments": [
					{
						"visiblefor": "Internal Users",
						"comment": "oplki",
						"attachments": [
							{
								"attachmentUrl": "https://smartqcmtstorage.blob.core.windows.net/buyersqlconn/70021790/Attachment/wp4294829-batman-4k-wallpapers_4cf297f5abbc4583853e28160a8d5866.jpg?sv=2018-03-28&sr=b&sig=ksp7siAwQ%2BVmEbbTpI3V2Du6nP5jf036VbLHuSN5k%2F8%3D&st=2020-07-20T18%3A21%3A52Z&se=2020-07-20T19%3A06%3A52Z&sp=r&rscd=attachment%3B%20filename%3D%22wp4294829-batman-4k-wallpapers.jpg%22",
								"attachmentType": ".jpg",
								"fileName": "wp4294829-batman-4k-wallpapers"
							}
						]
					},
					{
						"visiblefor": "Internal Users",
						"comment": "tyhgj",
						"attachments": [
							{
								"attachmentUrl": "https://smartqcmtstorage.blob.core.windows.net/buyersqlconn/70021790/Attachment/wp4294841-batman-4k-wallpapers_d125b5a2eeae4476acd61a7f01e8411b.jpg?sv=2018-03-28&sr=b&sig=J76DgRW2Ca8dSDxZmHGpM7y5idRh4Hjjzhzb5nd%2BtaQ%3D&st=2020-07-20T18%3A21%3A59Z&se=2020-07-20T19%3A06%3A59Z&sp=r&rscd=attachment%3B%20filename%3D%22wp4294841-batman-4k-wallpapers.jpg%22",
								"attachmentType": ".jpg",
								"fileName": "wp4294841-batman-4k-wallpapers"
							}
						]
					}
				]
			}
		],
		"printPDF": {
			"attachmentType": "PrintPreviewPDF",
			"contentType": "application/pdf",
			"extension": "pdf",
			"attachmentUrl": "https://static-smartdev.gep.com//buyersqlconn/70021790/Attachment/303400005902_c81949e73f434cc5a8e502c3d3b293df.pdf?sv=2018-03-28&sr=b&sig=NhbPgChi7zheUwmeMj5%2BYmbR%2FOMyhlMgLFR%2F1atxMMs%3D&st=2020-07-31T07%3A47%3A16Z&se=2020-07-31T08%3A32%3A16Z&sp=r&rscd=attachment%3B%20filename%3D%22303400005902.pdf%22"
		}
	},
	"statusCode": "200",
	"errorDetails": [],
	"successDetails": []
}

 

Data Elements

GetAllCommentsAndAttachments

Property

Required?

Data type

Description

Validations/Exceptions

Data

 

GetAllCommentsAndAttachments object

   

StatusCode

 

String

   

ErrorDetails

 

List of ErrorModel object

   

SuccessDetails

 

List of SuccessModel object

   

 

Data

Property

Required?

Data type

Description

Validations/Exceptions

DocumentNumber

 

String

   

HeaderComments

 

List of DocumentHeaderComment

   

LineComments

 

List of LineCommentAndAttachment

   

PrintPDF

 

PrintPDF object

   

 

HeaderComments

Property

Required?

Data type

Description

Validations/Exceptions

Visiblefor

 

String

   

Comment

 

String

   

Attachments

 

List of Attachment

   

 

Attachments

Property

Required?

Data type

Description

Validations/Exceptions

AttachmentUrl

 

String

   

AttachmentType

 

String

   

FileName

 

String

   

 

LineComments

Property

Required?

Data type

Description

Validations/Exceptions

LineNumber

 

Long

   

LineComments

 

List of DocumentLineComment

   

 

LineComments

Property

Required?

Data type

Description

Validations/Exceptions

Visiblefor

 

String

   

Comment

 

String

   

Attachments

 

List of Attachment

   

 

Attachments

Property

Required?

Data type

Description

Validations/Exceptions

AttachmentUrl

 

String

   

AttachmentType

 

String

   

FileName

 

String

   

 

PrintPDF

Property

Required?

Data type

Description

Validations/Exceptions

AttachmentType

 

String

   

ContentType

 

String

   

Extension

 

String

   

AttachmentUrl

 

String

   

 

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

   

ErrorDescription

 

String

   

 

SuccessDetails

Property

Required?

Data type

Description

Validations/Exceptions

Key

 

String