ROC WSI: ROC Web Service - Field Definitions

1

UserName

A valid user name.

String

Mandatory

Must be a valid string

2

Password

A valid password.

String

Mandatory

3

DialNumberList

A list of dial numbers to be changed.

DialNumberList

Mandatory

It should be in the following format:

<DialNumberList>

<DialNumber>8001234567</DialNumber>

<DialNumber>888-123-4567</DialNumber>

</DialNumberList>

• At least 1 Dial Number is required for the operation.

4

NewRespOrgID

Resp Org identifier of the new Resp Org

String
(5 characters)

Mandatory

5

LOAFile

The binary content of the actual LOA file.

The content should be Base64 encoded.

Refer to:  

  http://msdn.microsoft.com/en-us/library/dhx0d524.aspx

LOAFile

It should be in the following format:

<LOAFile>

<FileName>LOAFile1.pdf</FileName>

<EncodedContent>ddfF==</EncodedContent>

<MimeType>text/pdf</MimeType>

</LOAFile>

• FileName field can contain A-Z, a-z, 0-9, underscore (_), hyphen (-), space only.
• The file contents need to be Base64 encoded and sent as a string in the EncodedContent field.
• FileName Maxlength is 100 characters.

6

Notes

Notes related to the operation.

String

Optional

Allow all alphanumeric and special characters except < and >

Max length is 1,000 characters.

7

EmergencyROC

ROC Request with current date.

Number

Conditional

Possible Values: 0, 1 and 2

• 0 for Future Dated ROC
• 1 for Emergency ROC
• 2 for Expedite ROC

8

EffectiveDate

Current or Future Submission Date.

DateTime

Mandatory

Must be in the format: (YYYY-MM-DDTHH:MM:SS)

Example: 2015-05-01T00:00:00

• If EmergencyROC is 1 or 2 then Effective Date is selected as current date and if EmergencyROC is 0 (zero) then allowed date selection is up to 30 days in the future.

1

UserName

A valid user name.

String

Mandatory

Must be a valid string

2

Password

A valid password.

String

Mandatory

3

FilterType

Specifies Incoming or Outgoing requests.

Number

Mandatory

Possible Values: 0 or 1

• 0 for Incoming
• 1 for Outgoing

4

FilterStatus

Signifies that only requests with the specified status are returned.

Number

Optional

Possible Values: 0 to 9

• Refer to Appendix A for a list of possible status values and their description. If this field is not supplied, requests with all possible status values will be returned.

5

FilterSubmittedDateTimeStart

Start Date for the search date range.

DateTime

Mandatory

Must be in the format: (YYYY-MM-DDTHH:MM:SS)

Example: 2016-12-01T00:00:00

6

FilterSubmittedDateTimeEnd

End Date for the search date range.

DateTime

Mandatory

Must be in the format:(YYYY-MM-DDTHH:MM:SS)

Example: 2016-12-01T00:00:00

7

FilterDialNumber

Dial number associated to the requests to be searched.

String

Conditional

Example: 800111222,

Or 800-111-222

8

EntityOrRespOrgIdentifier

A valid Entity or Resp Org.

String

Mandatory

Must be a valid string of 2 or 5 characters.

9

Progress

A valid state.

String

Optional

Possible Values: 0, 1 and 2

• 0 for Open
• 1 for Closed
• 2 for both Open and Closed

10

RejectReasonCode

A valid reject code.

String

Optional

Please refer to Appendix B for a list of Reject codes and their descriptions.

11

IsRequestCheckedOut

A valid status

String

Optional

Possible Values: 0 or 1

• 0 for Not Checked Out
• 1 for Checked Out

1

UserName

A valid user name.

String

Mandatory

Must be a valid string

2

Password

A valid password.

String

Mandatory

3

TxnID

Transaction ID of the ROC request to be retrieved.

String

Mandatory

1

UserName

A valid user name.

String

Mandatory

Must be a valid string

2

Password

A valid password.

String

Mandatory

3

TxnID

Transaction ID of the ROC request to be retrieved.

String

Mandatory

4

DialNumberList

A list of Dial numbers for which the Action applies to.

DialNumberList

Mandatory

It should be in the following format:

<DialNumberList>

<DialNumber>8001234567</DialNumber>

<DialNumber>888-123-4567</DialNumber>

</DialNumberList>

• At least 1 Dial number is required for the operation.

5

ActionList

These actions to be taken for the numbers listed in DialNumberList field.

ActionList

Mandatory

Possible Values:

• 00 (Zero Zero) for Approve
• D0 for Due Date Approval
• D1 for Due Date Cancel

Any other values would mean a Reject.

Please refer to Appendix B for a list of Reject codes and their descriptions.

Reject code cannot be combined with 00,D0,D1

6

RejectNote

A valid String.

String

Optional

A maximum length of 2,000 characters is allowed including alphanumeric  and special characters except < and >

1

UserName

A valid user name.

String

Mandatory

Must be a valid string

2

Password

A valid password.

String

Mandatory

3

LOAID

The LOAID associated to the LOA file. This value is usually retrieved from the LOAID field in the GetRespOrgChangeRequest operation results.

Number

Mandatory

1

UserName

A valid user name.

String

Mandatory

Must be a valid string

2

Password

A valid password.

String

Mandatory

3

DocumentID

The DocumentID associated to the document. This value is usually received after a call to the AddDocument method or in the response of the GetRespOrgChangeRequest method.

Number

Mandatory

1

UserName

A valid user name.

String

Mandatory

Must be a valid string

2

Password

A valid password.

String

Mandatory

3

TxnID

Transaction ID of the ROC req.

String

Mandatory

4

DocumentFile

The binary content of the file.

The content should be Base64 encoded.Refer to: http://msdn.microsoft.com/en-us/library/dhx0d524.aspx

DocumentFile

It should be in the following format:

<DocumentFile>

<FileTitle>file1.pdf</FileTitle>

<EncodedContent>abc==</EncodedContent>

<FileNotes>Commentsfile</FileNotes>

</DocumentFile>

• FileTitle: This can contain A-Z, a-z, 0-9, underscore (_), hyphen (-), space only. Maxlength is 100 characters.
• The file contents need to be Base64 encoded and sent as a string in the EncodedContent field.
• FileNotes: A maximum length of 1,000 characters is allowed including alphanumeric and special characters except < and >

1

UserName

A valid user name.

String

Mandatory

Must be a valid string

2

Password

A valid password.

String

Mandatory

3

TxnID

Transaction ID of the ROC request to be retrieved.

String

Mandatory

4

DialNumberList

A list of Dial numbers to be changed.

DialNumberList

Mandatory

It should be in the following format:

<DialNumberList>

<DialNumber>8001234567</DialNumber>

<DialNumber>888-123-4567</DialNumber>

</DialNumberList>

• At least 1 Dial Number is required for the operation.

1

UserName

A valid user name.

String

Mandatory

Must be a valid string

2

Password

A valid password.

String

Mandatory

3

TxnID

Transaction ID of the ROC request to be retrieved.

String

Mandatory

1

UserName

A valid user name.

String

Mandatory

Must be a valid string

2

Password

A valid password.

String

Mandatory

3

StartDate

Start Date for the search date range.

DateTime

Mandatory

Must be in the format:(YYYY-MM-DDTHH:MM:SS)

Example: 2016-12-01T00:00:00

4

EndDate

End Date for the search date range.

DateTime

Mandatory

Must be in the format:(YYYY-MM-DDTHH:MM:SS)

Example: 2016-12-01T00:00:00

1

UserName

A valid user name.

String

Mandatory

Must be a valid string

2

Password

A valid password.

String

Mandatory

Must be a valid string

3

DialNumberList

A list of Dial numbers.

DialNumberList

Mandatory

It should be in the following format:

<DialNumberList>

<DialNumber>8001234567</DialNumber>

<DialNumber>888-123-4567</DialNumber>

</DialNumberList>

• At least 1 Dial Number is required for the operation.

4

CompanyAddress1

A valid company address.

String

Mandatory

Must be a valid string

5

CustomerName

A valid String.

String

Mandatory

Must be a valid string

6

CompanyAddress2

A valid company address.

String

Must be a valid string

7

City

A valid city.

String

Mandatory

Must be a valid string

8

State

A valid state.

String

Mandatory

Must be a valid string

9

ZipCode

A valid zipcode.

String

Mandatory

Must be a valid string

10

AuthorizedCustomerContact

A valid contact name.

String

Mandatory

Must be a valid string

11

ContactTitle

A valid contact title.

String

Mandatory

Must be a valid string

12

AuthorizedCustomerPhone

A valid customer phone number.

String

Mandatory

Must be a valid string

13

AuthorizedCustomerExtension

A valid customer extension.

String

Must be a valid string

14

AuthorizedCustomerFax

A valid customer fax.

String

Must be a valid string

1

UserName

A valid user name.

String

Mandatory

Must be a valid string

2

Password

A valid password.

String

Mandatory

Must be a valid string

3

TxnID

Transaction ID of the ROC request.

String

Mandatory

4

DialNumberList

A list of Dial numbers.

DialNumberList

Mandatory

It should be in the following format:

<DialNumberList>

<DialNumber>8001234567</DialNumber>

<DialNumber>888-123-4567</DialNumber>

</DialNumberList>

• At least 1 Dial Number is required for the operation.

5

LOAVerification

LOA Verification value

Number

Mandatory

• Value must be between: 1 to 4
• Refer to Appendix D for possible values and their description for this field.

6

LOAVerificationComments

Comments associated to the LOA.

String

Conditional

• Value is required if 3 is specified in LOAVerification field (ref#6).
• A maximum length of 150 characters is allowed including alphanumeric and special characters except < and >

7

LOAFile

The binary content of the actual LOA file.

The content should be Base64 encoded.

Refer to:     http://msdn.microsoft.com/en-us/library/dhx0d524.aspx

A valid String.

 Optional

It should be in the following format:

<LOAFile>

<FileName>LOAFile1.pdf</FileName>

<EncodedContent>ddfF==</EncodedContent>

<MimeType>text/pdf</MimeType>

</LOAFile>

• FileName: can contain A-Z, a-z, 0-9, underscore (_), hyphen (-), space only.
• The file contents need to be Base64 encoded and sent as a string in the EncodedContent field.
• FileName max length is 100 characters.

8

EmergencyROC

Request with current date.

Number

Conditional

Possible Values: 0 or 1

• 0 for Future Dated ROC
• 1 for Emergency ROC

9

EffectiveDate

Current or Future Submission Date.

DateTime

Mandatory

Must be in the format: (YYYY-MM-DDTHH:MM:SS)

Example: 2018-01-01T00:00:00

• If EmergencyROC is 1 then Effective Date is selected as current date and if EmergencyROC is 0 (zero) then allowed date selection is up to 30 days in the future.

10

Aware99RespOrg

If ROC Request have XXX99 losing RO

Number

Conditional

Possible Values: 0 or 1

• 0 for Not Aware
• 1 for Aware

1

UserName

A valid user name.

String

Mandatory

Must be a valid string

2

Password

A valid password.

String

Mandatory

3

DialNumberList

A list of Dial numbers

DialNumberList

Mandatory

It should be in the following format:

<DialNumberList>

<DialNumber>8001234567</DialNumber>

<DialNumber>888-123-4567</DialNumber>

</DialNumberList>

• At least 1 DialNumber is required for the operation.

4

NewRespOrgID

Resp Org identifier of the new Resp Org

String
(5 characters)

Mandatory

5

OldRespOrgID

Resp Org identifier of the old Resp Org

String
(5 characters)

Mandatory

6

LOAVerification

LOA Verification value

Number

Mandatory

Value must be between: 1 to 4

Refer to Appendix D for possible values and their description for this field.

7

LOAVerificationComments

Comments associated to the LOA.

String

Conditional

• Value is required if 3 is specified in LOAVerification field (ref#6).
• A maximum length of 150 characters is allowed including alphanumeric  and special characters except < and >

8

LOAFile

The binary content of the actual LOA file.

The content should be Base64 encoded.

Refer to:  

  http://msdn.microsoft.com/en-us/library/dhx0d524.aspx

LOAFile

It should be in the following format:

<LOAFile><FileName>LOAFile1.pdf</FileName>

<EncodedContent>ddfF==</EncodedContent>

<MimeType>text/pdf</MimeType></LOAFile>

• FileName: This can contain A-Z, a-z, 0-9, underscore (_), hyphen (-), space only.
• The file contents need to be Base64 encoded and sent as a string in the EncodedContent field.
• FileName: Max length 100.

9

Notes

Notes related to the operation.

String

Optional

Allow all alphanumeric and special characters except &, ", ", < and >

Max length is 1,000 characters.

10

EmergencyROC

Request with current date.

Number

Conditional

Possible Values: 0 or 1

• 0 for Future Dated ROC
• 1 for Emergency ROC

11

EffectiveDate

Current or Future Submission Date.

DateTime

Mandatory

Must be in the format: (YYYY-MM-DDTHH:MM:SS)

Example: 2015-05-01T00:00:00

• If EmergencyROC is 1  then Effective Date is selected as current date and if EmergencyROC is 0 (zero) then allowed date selection is up to 30 days in the future.

12

Aware99RespOrg

If ROC Request have XXX99 losing RO

Number

Conditional

Possible Values: 0 or 1

• 0 for Not Aware
• 1 for Aware

1

UserName

A valid user name.

String

Mandatory

Must be a valid string

2

Password

A valid password.

String

Mandatory

3

TxnID

Transaction ID of the HDI request.

String

Mandatory

4

DialNumberList

A list of Dial numbers.

DialNumberList

Mandatory

It should be in the following format:

<DialNumberList>

<DialNumber>8001234567</DialNumber>

<DialNumber>888-123-4567</DialNumber>

</DialNumberList>

• At least 1 Dial number is required for the operation.

5

NewRespOrgID

Resp Org identifier of the new Resp Org

String
(5 characters)

Mandatory

6

OldRespOrgID

Resp Org identifier of the old Resp Org

String
(5 characters)

Mandatory

7

LOAVerification

LOA Verification value

Number

Mandatory

Value must be between: 1 to 4

Refer to Appendix D for possible values and their description for this field.

8

LOAVerificationComments

Comments associated to the LOA.

String

Conditional

• Value is required if 3 is specified in LOAVerification field (ref#7).
• A maximum length of 150 characters is allowed including alphanumeric  and special characters except < and >

9

LOAFile

The binary content of the actual LOA file.

The content should be Base64 encoded.

Refer to:  

  http://msdn.microsoft.com/en-us/library/dhx0d524.aspx

LOAFile

It should be in the following format:

<LOAFile>

<FileName>LOAFile1.pdf</FileName>

<EncodedContent>ddfF==</EncodedContent>

<MimeType>text/pdf</MimeType>

</LOAFile>

• FileName: This can contain A-Z, a-z, 0-9, underscore (_), hyphen (-), space only. Max length is 100 characters.
• The file contents need to be Base64 encoded and sent as a string in the EncodedContent field.

10

Notes

Notes related to the operation.

String

Optional

Allow all alphanumeric and special characters except &, ", ", < and >

Max length is 1,000 characters.

11

EmergencyROC

Request with current date.

Number

Conditional

Possible Values: 0 or 1

• 0 for Future Dated ROC
• 1 for Emergency ROC

12

EffectiveDate

Current or Future Submission Date.

DateTime

Mandatory

Must be in the format: (YYYY-MM-DDTHH:MM:SS)

Example: 2015-05-01T00:00:00

• If EmergencyROC is 1 then Effective Date is selected as current date and if EmergencyROC is 0 (zero) then allowed date selection is up to 30 days in the future.

13

Aware99RespOrg

If HDI Request have XXX99 losing RO

Number

Conditional

Possible Values: 0 or 1

• 0 for Not Aware
• 1 for Aware

1

UserName

A valid user name.

String

Mandatory

Must be a valid string

2

Password

A valid password.

String

Mandatory

3

FilterType

Specifies Type of requests.

Number

Mandatory

Possible Values: 0 to 2

• 0 for HDR
• 1 for HDI
• 2 for All

4

FilterStatus

Signifies that only requests with the specified status are returned.

Number

Optional

Possible Values: 0 to 3

• 0 for Unprocessed
• 1 for Approved
• 2 for Rejected
• 3 for All

5

DialNumberStatusID

Signifies status of dial umbers

Number

Optional

Refer to Appendix A for a list of possible status values and their description. If this field is not supplied, requests with all possible status values will be returned.

6

FilterSubmittedDateTimeStart

Start Date for the search date range.

DateTime

Mandatory

Must be in the format: (YYYY-MM-DDTHH:MM:SS)

Example: 2016-12-01T00:00:00

7

FilterSubmittedDateTimeEnd

End Date for the search date range.

DateTime

Mandatory

Must be in the format:(YYYY-MM-DDTHH:MM:SS)

Example: 2016-12-01T00:00:00

8

FilterDialNumber

Dial number associated to the requests to be searched.

String

Optional

Example: 800111222,

Or 800-111-222

9

RejectReasonCode

A valid reject code.

String

Optional

Please refer to Appendix E for a list of Reject codes and their descriptions.

1

UserName

A valid user name.

String

Mandatory

Must be a valid string

2

Password

A valid password.

String

Mandatory

3

TxnID

Transaction ID of the HDI request to be retrieved.

String

Mandatory

1

UserName

A valid user name.

String

Mandatory

Must be a valid string

2

Password

A valid password.

String

Mandatory

3

LOAID

The LOAID associated to the LOA file. This value is usually retrieved from the LOAID field in the GetHDIRequest operation results.

Number

Mandatory

1

UserName

A valid user name.

String

Mandatory

Must be a valid string

2

Password

A valid password.

String

Mandatory

3

DocumentID

The DocumentID associated to the document. This value is usually received after a call to the AddHDIDocument method or in the response of the GetHDIRequest method.

Number

Mandatory

1

UserName

A valid user name.

String

Mandatory

Must be a valid string

2

Password

A valid password.

String

Mandatory

3

TxnID

Transaction ID of the HDI request.

String

Mandatory

4

DocumentFile

The binary content of the file.

The content should be Base64 encoded.Refer to: http://msdn.microsoft.com/en-us/library/dhx0d524.aspx

DocumentFile

It should be in the following format:

<DocumentFile>

<FileTitle>file1.pdf</FileTitle>

<EncodedContent>abc==</EncodedContent>

</DocumentFile>

• FileTitle: This can contain A-Z, a-z, 0-9, underscore (_), hyphen (-), space only.
• The file contents need to be Base64 encoded and sent as a string in the EncodedContent field.

1

UserName

A valid user name.

String

Mandatory

Must be a valid string

2

Password

A valid password.

String

Mandatory

3

TxnID

Transaction ID of the HDI request to be retrieved.

String

Mandatory

1

UserName

A valid user name.

String

Mandatory

Must be a valid string

2

Password

A valid password.

String

Mandatory

3

FilterType

Specifies Incoming or Outgoing requests.

Number

Mandatory

Possible Values: 0 or 1

• 0 for Incoming
• 1 for Outgoing

4

FilterStatus

Signifies that only requests with the specified status are returned.

Number

Optional

Possible Values: 0 to 9

• Refer to Appendix A for a list of possible status values and their description. If this field is not supplied, requests with all possible status values will be returned.

5

FilterSubmittedDateTimeStart

Start Date for the search date range.

DateTime

Mandatory

Must be in the format: (YYYY-MM-DDTHH:MM:SS)

Example: 2016-12-01T00:00:00

6

FilterSubmittedDateTimeEnd

End Date for the search date range.

DateTime

Mandatory

Must be in the format:(YYYY-MM-DDTHH:MM:SS)

Example: 2016-12-01T00:00:00

7

FilterDialNumber

Dial number associated to the requests to be searched.

String

Conditional

Example: 800111222,

Or 800-111-222

8

EntityOrRespOrgIdentifier

A valid Entity or Resp Org.

String

Mandatory

Must be a valid string of 2 or 5 characters.

9

Progress

A valid state.

String

Optional

Possible Values: 0, 1 and 2

• 0 for Open
• 1 for Closed
• 2 for both Open and Closed

10

RejectReasonCode

A valid reject code.

String

Optional

Please refer to Appendix B for a list of Reject codes and their descriptions.

11

IsRequestCheckedOut

A valid status

String

Optional

Possible Values: 0 or 1

• 0 for Not Checked Out
• 1 for Checked Out

1

UserName

A valid user name.

String

Mandatory

Must be a valid string

2

Password

A valid password.

String

Mandatory

3

TxnID

Transaction ID of the ROC request to be retrieved.

String

Mandatory

1

UserName

A valid user name.

String

Mandatory

Must be a valid string

2

Password

A valid password.

String

Mandatory

3

TxnID

Transaction ID of the ROC request to be retrieved.

String

Mandatory

1

UserName

A valid user name.

String

Mandatory

Must be a valid string

2

Password

A valid password.

String

Mandatory

Must be a valid string

3

DialNumberList

A list of Dial numbers.

DialNumberList

Mandatory

It should be in the following format:

<DialNumberList>

<DialNumber>8001234567</DialNumber>

<DialNumber>888-123-4567</DialNumber>

</DialNumberList>

• At least 1 Dial Number is required for the operation.

4

SubscriberAddress1

A valid Subscriber  address.

String

Mandatory

Must be a valid string

5

TollFreeSubscriber

A valid Subscriber name.

String

Mandatory

Must be a valid string

6

SubscriberAddress2

A valid Subscriber address.

String

Must be a valid string

7

City

A valid city.

String

Mandatory

Must be a valid string

8

State

A valid state.

String

Mandatory

Must be a valid string

9

ZipCode

A valid zipcode.

String

Mandatory

Must be a valid string

10

AuthorizedContact

A valid authorized contact name.

String

Mandatory

Must be a valid string

11

ContactTitle

A valid contact title.

String

Mandatory

Must be a valid string

12

ContactTel

A valid customer phone number.

String

Mandatory

Must be a valid string

13

Ext

A valid customer extension.

String

Must be a valid string

14

EmailAddress

A valid customer Email.

String

Must be a valid string

15

EndUserInformation

A valid End user Information.

String

Must be a valid string up to 700 characters

16

RespOrgInstructions

A valid RespOrg Instruction.

String

Must be a valid string up to 300 characters.

1

UserName

A valid user name.

String

Mandatory

Must be a valid string

2

Password

A valid password.

String

Mandatory

3

DialNumberList

A list of dial numbers to be changed.

DialNumberList

Mandatory

It should be in the following format:

<DialNumberList>

<DialNumber>8001234567</DialNumber>

<DialNumber>888-123-4567</DialNumber>

</DialNumberList>

• At least 1 Dial Number is required for the operation.

4

NewRespOrgID

Resp Org identifier of the new Resp Org

String
(5 characters)

Mandatory

5

LOAFile

The binary content of the actual LOA file.

The content should be Base64 encoded.

Refer to:  

  http://msdn.microsoft.com/en-us/library/dhx0d524.aspx

LOAFile

It should be in the following format:

<LOAFile>

<FileName>LOAFile1.pdf</FileName>

<EncodedContent>ddfF==</EncodedContent>

<MimeType>text/pdf</MimeType>

</LOAFile>

• FileName field can contain A-Z, a-z, 0-9, underscore (_), hyphen (-), space only.
• The file contents need to be Base64 encoded and sent as a string in the EncodedContent field.
• FileName Maxlength is 100 characters.

6

Doc1

The binary content of the actual Doc1.

The content should be Base64 encoded.

Refer to:  

  http://msdn.microsoft.com/en-us/library/dhx0d524.aspx

Doc1

It should be in the following format:

<Doc1>

<FileName>DocFile1.pdf</FileName>

<EncodedContent>ddfF==</EncodedContent>

<FileNotes>test file </FileNotes>

</Doc1>

• FileName field can contain A-Z, a-z, 0-9, underscore (_), hyphen (-), space only.
• The file contents need to be Base64 encoded and sent as a string in the EncodedContent field.
• FileName Maxlength is 100 characters.
• FileNotes: A maximum length of 1,000 characters is allowed including alphanumeric and special characters except < and >

7

Doc2

The binary content of the actual Doc2 file.

The content should be Base64 encoded.

Refer to:  

  http://msdn.microsoft.com/en-us/library/dhx0d524.aspx

Doc2

It should be in the following format:

<Doc2>

<FileName>DocFile1.pdf</FileName>

<EncodedContent>ddfF==</EncodedContent>

<FileNotes>test file</FileNotes>

</Doc2>

• FileName field can contain A-Z, a-z, 0-9, underscore (_), hyphen (-), space only.
• The file contents need to be Base64 encoded and sent as a string in the EncodedContent field.
• FileName Maxlength is 100 characters.
• FileNotes: A maximum length of 1,000 characters is allowed including alphanumeric and special characters except < and >

8

Doc3

The binary content of the actual Doc3 file.

The content should be Base64 encoded.

Refer to:  

  http://msdn.microsoft.com/en-us/library/dhx0d524.aspx

Doc3

It should be in the following format:

<Doc3>

<FileName>Doc3File1.pdf</FileName>

<EncodedContent>ddfF==</EncodedContent>

<FileNotes>test</FileNotes>

</Doc3>

• FileName field can contain A-Z, a-z, 0-9, underscore (_), hyphen (-), space only.
• The file contents need to be Base64 encoded and sent as a string in the EncodedContent field.
• FileName Maxlength is 100 characters.
• FileNotes: A maximum length of 1,000 characters is allowed including alphanumeric and special characters except < and >

9

Doc4

The binary content of the actual Doc4 file.

The content should be Base64 encoded.

Refer to:  

  http://msdn.microsoft.com/en-us/library/dhx0d524.aspx

Doc3

It should be in the following format:

<Doc4>

<FileName>Doc3File1.pdf</FileName>

<EncodedContent>ddfF==</EncodedContent>

<FileNotes>test</FileNotes>

</Doc4>

• FileName field can contain A-Z, a-z, 0-9, underscore (_), hyphen (-), space only.
• The file contents need to be Base64 encoded and sent as a string in the EncodedContent field.
• FileName Maxlength is 100 characters.
• FileNotes: A maximum length of 1,000 characters is allowed including alphanumeric and special characters except < and >

10

Notes

Notes related to the operation.

String

Optional

Allow all alphanumeric and special characters except < and >

Max length is 1,000 characters.

11

EmergencyROC

ROC Request with current date.

Number

Conditional

Possible Values: 0, 1 and 2

• 0 for Future Dated ROC
• 1 for Emergency ROC
• 2 for Expedite ROC

12

EffectiveDate

Current or Future Submission Date.

DateTime

Mandatory

Must be in the format: (YYYY-MM-DDTHH:MM:SS)

Example: 2015-05-01T00:00:00

• If EmergencyROC is 1 or 2 then Effective Date is selected as current date and if EmergencyROC is 0 (zero) then allowed date selection is up to 30 days in the future.

1

UserName

A valid user name.

String

Mandatory

Must be a valid string

2

Password

A valid password.

String

Mandatory

3

TxnID

Transaction ID of the ROC request to be retrieved.

String

Mandatory