GET api/ServiceAttribute/{auth}/{ServiceID}
Returns a list of attributes available to service
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
auth |
Auhthenication token |
string |
Required |
ServiceID |
Service identifier |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
ServiceAttributeRespName | Description | Type | Additional information |
---|---|---|---|
IsSuccessful |
Used to determine if method call was successful (true) or failure (false) |
boolean |
None. |
ErrorMessage |
The error message if method call was not successful |
string |
None. |
Attributes |
List of attributes available to the service |
Collection of ServiceAttributeItem |
None. |
Response Formats
application/json, text/json
Sample:
{ "Attributes": [ { "AttributeTypeCode": "sample string 4", "AttributeTypeID": 3, "AttributeTypeName": "sample string 5", "CustomerClassID": 1, "ServiceAttributeID": 1, "ServiceID": 2 }, { "AttributeTypeCode": "sample string 4", "AttributeTypeID": 3, "AttributeTypeName": "sample string 5", "CustomerClassID": 1, "ServiceAttributeID": 1, "ServiceID": 2 } ], "ErrorMessage": "sample string 2", "IsSuccessful": true }
application/xml, text/xml
Sample:
<ServiceAttributeResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Shipper.Models"> <Attributes> <ServiceAttributeItem> <AttributeTypeCode>sample string 4</AttributeTypeCode> <AttributeTypeID>3</AttributeTypeID> <AttributeTypeName>sample string 5</AttributeTypeName> <CustomerClassID>1</CustomerClassID> <ServiceAttributeID>1</ServiceAttributeID> <ServiceID>2</ServiceID> </ServiceAttributeItem> <ServiceAttributeItem> <AttributeTypeCode>sample string 4</AttributeTypeCode> <AttributeTypeID>3</AttributeTypeID> <AttributeTypeName>sample string 5</AttributeTypeName> <CustomerClassID>1</CustomerClassID> <ServiceAttributeID>1</ServiceAttributeID> <ServiceID>2</ServiceID> </ServiceAttributeItem> </Attributes> <ErrorMessage>sample string 2</ErrorMessage> <IsSuccessful>true</IsSuccessful> </ServiceAttributeResp>