JiwaAPI

CarrierGETRequest

The following routes are available for this service:
GET	/Carriers/{CarrierID}	Retrieves a carrier.

**CarrierGETRequest** Parameters:
Name	Parameter	Data Type	Required	Description
CarrierID	path	string	No

**Carrier** Parameters:
Name	Parameter	Data Type	Required
CarrierID	form	string	No
CarrierName	form	string	No
AccountNo	form	string	No
Enabled	form	bool?	No
Notes	form	string	No
LastSavedDateTime	form	DateTime?	No
Services	form	List<CarrierService>	No
FreightDescriptions	form	List<CarrierFreightDescription>	No

**CarrierService** Parameters:
Name	Parameter	Data Type	Required
ServiceID	form	string	No
ServiceName	form	string	No
DefaultItem	form	bool?	No
LastSavedDateTime	form	DateTime?	No
Enabled	form	bool?	No

**CarrierFreightDescription** Parameters:
Name	Parameter	Data Type	Required
FreightDescriptionID	form	string	No
Description	form	string	No
DefaultItem	form	bool?	No
LastSavedDateTime	form	DateTime?	No
Enabled	form	bool?	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /Carriers/{CarrierID} HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<Carrier xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Carriers">
  <_x003C_AccountNo_x003E_k__BackingField>String</_x003C_AccountNo_x003E_k__BackingField>
  <_x003C_CarrierID_x003E_k__BackingField>String</_x003C_CarrierID_x003E_k__BackingField>
  <_x003C_CarrierName_x003E_k__BackingField>String</_x003C_CarrierName_x003E_k__BackingField>
  <_x003C_Enabled_x003E_k__BackingField>false</_x003C_Enabled_x003E_k__BackingField>
  <_x003C_FreightDescriptions_x003E_k__BackingField>
    <CarrierFreightDescription>
      <_x003C_DefaultItem_x003E_k__BackingField>false</_x003C_DefaultItem_x003E_k__BackingField>
      <_x003C_Description_x003E_k__BackingField>String</_x003C_Description_x003E_k__BackingField>
      <_x003C_Enabled_x003E_k__BackingField>false</_x003C_Enabled_x003E_k__BackingField>
      <_x003C_FreightDescriptionID_x003E_k__BackingField>String</_x003C_FreightDescriptionID_x003E_k__BackingField>
      <_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_LastSavedDateTime_x003E_k__BackingField>
    </CarrierFreightDescription>
  </_x003C_FreightDescriptions_x003E_k__BackingField>
  <_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_LastSavedDateTime_x003E_k__BackingField>
  <_x003C_Notes_x003E_k__BackingField>String</_x003C_Notes_x003E_k__BackingField>
  <_x003C_Services_x003E_k__BackingField>
    <CarrierService>
      <_x003C_DefaultItem_x003E_k__BackingField>false</_x003C_DefaultItem_x003E_k__BackingField>
      <_x003C_Enabled_x003E_k__BackingField>false</_x003C_Enabled_x003E_k__BackingField>
      <_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_LastSavedDateTime_x003E_k__BackingField>
      <_x003C_ServiceID_x003E_k__BackingField>String</_x003C_ServiceID_x003E_k__BackingField>
      <_x003C_ServiceName_x003E_k__BackingField>String</_x003C_ServiceName_x003E_k__BackingField>
    </CarrierService>
  </_x003C_Services_x003E_k__BackingField>
</Carrier>