POST api/Service
Retrieve list of services for the user
Request Information
URI Parameters
None.
Body Parameters
ServiceParmName | Description | Type | Additional information |
---|---|---|---|
auth | string |
None. |
|
BaseDateTime | date |
None. |
|
OrigCountryID | string |
None. |
|
OrigCityName | string |
None. |
|
OrigStateProvID | string |
None. |
|
OrigPostalCode | string |
None. |
|
OrigAirportID | string |
None. |
|
DestCountryID | string |
None. |
|
DestCityName | string |
None. |
|
DestStateProvID | string |
None. |
|
DestPostalCode | string |
None. |
|
DestAirportID | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "BaseDateTime": "2025-04-03T22:11:34.93-07:00", "DestAirportID": "sample string 11", "DestCityName": "sample string 8", "DestCountryID": "sample string 7", "DestPostalCode": "sample string 10", "DestStateProvID": "sample string 9", "OrigAirportID": "sample string 6", "OrigCityName": "sample string 3", "OrigCountryID": "sample string 2", "OrigPostalCode": "sample string 5", "OrigStateProvID": "sample string 4", "auth": "sample string 1" }
application/xml, text/xml
Sample:
<ServiceParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Shipper.Models"> <BaseDateTime>2025-04-03T22:11:34.9304944-07:00</BaseDateTime> <DestAirportID>sample string 11</DestAirportID> <DestCityName>sample string 8</DestCityName> <DestCountryID>sample string 7</DestCountryID> <DestPostalCode>sample string 10</DestPostalCode> <DestStateProvID>sample string 9</DestStateProvID> <OrigAirportID>sample string 6</OrigAirportID> <OrigCityName>sample string 3</OrigCityName> <OrigCountryID>sample string 2</OrigCountryID> <OrigPostalCode>sample string 5</OrigPostalCode> <OrigStateProvID>sample string 4</OrigStateProvID> <auth>sample string 1</auth> </ServiceParm>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ServiceRespName | 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. |
Services |
Listing of services available to user |
Collection of ServiceItem |
None. |
Response Formats
application/json, text/json
Sample:
{ "ErrorMessage": "sample string 2", "IsSuccessful": true, "Services": [ { "Deadline": "2025-04-03T22:11:34.934-07:00", "DeadlineCode": "sample string 8", "Description": "sample string 4", "Name": "sample string 3", "ServiceCode": "sample string 2", "ServiceGUID": "sample string 1", "ServiceGUIDAndDeadlineCode": "sample string 10", "ServiceID": 1, "ServiceNameAndUser": "sample string 7", "ServiceNameWithDeadline": "sample string 9", "UserGUID": "sample string 5", "UserName": "sample string 6" }, { "Deadline": "2025-04-03T22:11:34.934-07:00", "DeadlineCode": "sample string 8", "Description": "sample string 4", "Name": "sample string 3", "ServiceCode": "sample string 2", "ServiceGUID": "sample string 1", "ServiceGUIDAndDeadlineCode": "sample string 10", "ServiceID": 1, "ServiceNameAndUser": "sample string 7", "ServiceNameWithDeadline": "sample string 9", "UserGUID": "sample string 5", "UserName": "sample string 6" } ] }
application/xml, text/xml
Sample:
<ServiceResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Shipper.Models"> <ErrorMessage>sample string 2</ErrorMessage> <IsSuccessful>true</IsSuccessful> <Services> <ServiceItem> <Deadline>2025-04-03T22:11:34.9344794-07:00</Deadline> <DeadlineCode>sample string 8</DeadlineCode> <Description>sample string 4</Description> <Name>sample string 3</Name> <ServiceCode>sample string 2</ServiceCode> <ServiceGUID>sample string 1</ServiceGUID> <ServiceGUIDAndDeadlineCode>sample string 10</ServiceGUIDAndDeadlineCode> <ServiceID>1</ServiceID> <ServiceNameAndUser>sample string 7</ServiceNameAndUser> <ServiceNameWithDeadline>sample string 9</ServiceNameWithDeadline> <UserGUID>sample string 5</UserGUID> <UserName>sample string 6</UserName> </ServiceItem> <ServiceItem> <Deadline>2025-04-03T22:11:34.9344794-07:00</Deadline> <DeadlineCode>sample string 8</DeadlineCode> <Description>sample string 4</Description> <Name>sample string 3</Name> <ServiceCode>sample string 2</ServiceCode> <ServiceGUID>sample string 1</ServiceGUID> <ServiceGUIDAndDeadlineCode>sample string 10</ServiceGUIDAndDeadlineCode> <ServiceID>1</ServiceID> <ServiceNameAndUser>sample string 7</ServiceNameAndUser> <ServiceNameWithDeadline>sample string 9</ServiceNameWithDeadline> <UserGUID>sample string 5</UserGUID> <UserName>sample string 6</UserName> </ServiceItem> </Services> </ServiceResp>