Function
The Customer Main Get API is used to get customer information using a customer's number or name.
URL
{Root URL}/API/Customer/Get/{API Key} |
Parameter
| Parameter | Description | Required | Comment | |
| 1 | CustNumOrName | Customer number or customer name | Y | Use either the customer number or the customer name to get customer information. |
Example Strings
Get Customer Information
URL
?CustNumOrName=Customer |
JSON
{ "CustNumOrName":"Customer" } |
A successful request should result in:
{ "$id": "1", "Code": "200", "Message": "Customer details:", "SessionId": "null", "IsValidUser": "true", -"ResponseObject": { "$id": "2", "LinkAddList": "null", "CUSTNO": "0000000010", "CUSTNAME": "Customer ", "PHONE": " ", "FAX": " ", "BLINKADD": " ", "SLINKADD": " ", "TERRITORY": "NEW ENGLAND ", "TERMS": " ", "CREDLIMIT": "0", "PROFILE": "", "CUSTNOTE": "", "ACCTSTATUS": " ", "DIVISION": " ", "SREPS": " ", "CREDITOK": " ", "RESL_NO": " ", "AR_CALDATE": "null", "AR_CALTIME": " ", "AR_CALBY": " ", "AR_CALNOTE": "", "AR_HIGHBAL": "0", "CREDITNOTE": "", "ACCT_DATE": "2014-11-19T13:28:00", "SAVEINIT": " ", "OUT_MARGIN": "0", "TL_MARGIN": "0", "MAT_MARGIN": "0", "LAB_MARGIN": "0", "MIN_ORDAMT": "0", "SCRAP_FACT": "0", "COMMITEM": "0", "CUSTSPEC": "0", "LABOR": "false", "MATERIAL": "false", "SPLIT1": "0", "SPLIT2": "0", "SPLITAMT": "0", "SPLITPERC": "0", "TOOLING": "false", "SIC_CODE": " ", "SIC_DESC": " ", "DELIVTIME": " ", "STATUS": "Active ", "SERIFLAG": "false", "OVERHEAD": "0", "IS_EDITED": " ", "SALEDSCTID": " ", "CUSTPFX": " ", "ACTTAXABLE": "false", "INACTDT": "null", "INACTINIT": " ", "modifiedDate": "2014-11-19T13:27:49.25", "UserId": "null" } } |
Common Errors
Incorrect URL
If there is a problem with the URL or the parameter entered, the system will return an HTTP error message:
{ "$id": "1", "Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/Customer/Get/123456789?CustName=CustomerName'.", "MessageDetail": "No action was found on the controller 'Customer' that matches the request." } |
Non-Existent Customer
If the entered customer does not exist, the system will return a message describing it:
{ "$id": "1", "Code": "403", "Message": "Customer does not exist.", "SessionId": "null", "IsValidUser": "true", "ResponseObject": "null" } |