GET v1/portActivities/{companyCode}/templates?apiToken={apiToken}
Returns a list of all port activity templates associated with a specific company
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
companyCode |
The company code you are retreiving information for |
string |
Required |
apiToken |
Your API Token |
string |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of ObjectNone.
Response Formats
application/json, text/json
Sample:
[ { "functionName": "sample string 1", "functionCode": "A", "portActivityIDs": [ 1, 2 ] }, { "functionName": "sample string 1", "functionCode": "A", "portActivityIDs": [ 1, 2 ] } ]
application/xml, text/xml
Sample:
<PortActivityTemplates xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <PortActivityTemplate> <FunctionName>sample string 1</FunctionName> <FunctionCode>65</FunctionCode> <PortActivityIDs> <ID>1</ID> <ID>2</ID> </PortActivityIDs> </PortActivityTemplate> <PortActivityTemplate> <FunctionName>sample string 1</FunctionName> <FunctionCode>65</FunctionCode> <PortActivityIDs> <ID>1</ID> <ID>2</ID> </PortActivityIDs> </PortActivityTemplate> </PortActivityTemplates>